mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-26 06:28:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

groupware: add Mermaid diagrams to describe the two setup options

Browse Source
This commit is contained in:
Pascal Bleser
2025-10-09 17:23:38 +02:00
parent f5ac62859a
commit 96fcf961b8
1 changed files with 37 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
services/groupware/DEVELOPER.md
View File

@@ -90,6 +90,25 @@ In either case, the Docker Compose configuration in `$OCDIR/opencloud/devtools/d
<a name="prod-setup"></a>
```mermaid
---
title: Production Setup
---
flowchart LR
oc["`opencloud`"]
c["client"]
kc["`keycloak`"]
ol["`ldap-server`"]
st["`stalwart`"]
c -- http --> oc
oc -- jmap --> st
oc --> ol
st --> ol
kc --> ol
c --> kc
```
Edit `$OCDIR/opencloud/devtools/deployments/opencloud_full/.env`, making the following changes (make sure to check out [the shell command-line that automates all of that, below](#automate-env-setup-prod)):
* change the container image to `opencloudeu/opencloud:dev`:
@@ -178,6 +197,21 @@ perl -pi -e '
<a name="homelab-setup"></a>
```mermaid
---
title: Homelab Setup
---
flowchart LR
oc["`opencloud`"]
c["client"]
st["`stalwart`"]
c -- http --> oc
oc -- jmap --> st
st -- ldap --> oc
```
Edit `$OCDIR/opencloud/devtools/deployments/opencloud_full/.env`, making the following changes (make sure to check out [the shell command-line that automates all of that, below](#automate-env-setup-homelab)):
* change the container image to `opencloudeu/opencloud:dev`:
@@ -299,7 +333,7 @@ cd "$OCDIR/opencloud/devtools/deployments/opencloud_full/"
docker compose up -d
```
### From IDE in Production Setup
### Running in an IDE in Production Setup
If you plan to make changes to the backend code base, it might be more convenient to do so from within VSCode, in which case you should run all the services from the Docker Compose setup as above, but stop the `opencloud` service container (as that one will be running from within your IDE instead):
@@ -310,13 +344,12 @@ docker compose stop opencloud
and then use the Launcher `OpenCloud server with external services` in VSCode.
### From IDE in Homelab Setup
### Running in an IDE in Homelab Setup
Or if you want to do so but using the [&ldquo;homelab&rdquo; setup](#homelab-setup), then the `opencloud` container needs to be kept running, as it also provides LDAP and OIDC services.
Or if you want to do so but using the [&ldquo;homelab&rdquo; setup](#homelab-setup), then the `opencloud` container needs to be kept running, as it also provides LDAP and OIDC services, as the `stalwart` container cannot access those services on the `opencloud` process that is running on the host (in the IDE.)
In VSCode, use the Launcher `OpenCloud server` instead.
## Checking Services
To check whether the various services are running correctly: