opencloud/services/groupware/DEVELOPER.md

Introduction

The Groupware component of OpenCloud

• is implemented as yet another microservice within the OpenCloud framework (see ./services/groupware/)
• is essentially providing a REST API to the OpenCloud UI clients (web, mobile) that is high-level and adapted to the needs of the UIs
• the implementation of that REST API turns those high-level APIs into lower-level JMAP API calls to Stalwart, the JMAP mail server, using our own JMAP client library in ./pkg/jmap/

Repository

The code lives in the same tree as the other OpenCloud backend services, albeit in the groupware branch, that gets rebased on main on a regular basis (at least once per week.)

Use the groupware branch

cd ~/src/opencloud/
git clone --branch groupware git@github.com:opencloud-eu/opencloud.git

Also, you might want to check out these helper scripts in opencloud-tools somewhere and put that directory into your PATH, as it contains scripts to test and build the OpenCloud Groupware:

cd ~/src/opencloud/
git clone git@github.com:pbleser-oc/opencloud-tools.git ./bin
echo 'export PATH="$PATH:$HOME/src/opencloud/bin"' >> ~/.bashrc

Those scripts have the following prerequisites:

• the jq JSON query command-line tool to extract access tokens,
• either the httpie (pip install httpie) or xh (cargo install xh --locked) command-line HTTP clients, just out of convenience as their output is much nicer than curl's

Running

Since we require having a Stalwart container running at the very least, the preferred way of running OpenCloud and its adjacent services for developing the Groupware component is by using the opencloud_full Docker Compose setup.

Configuration

Hosts

Make sure to have the following entries in your /etc/hosts:

127.0.0.1       cloud.opencloud.test
127.0.0.1       keycloak.opencloud.test
127.0.0.1       collabora.opencloud.test
127.0.0.1       wopiserver.opencloud.test
127.0.0.1       mail.opencloud.test
127.0.0.1       collabora.opencloud.test
127.0.0.1       stalwart.opencloud.test
127.0.0.1       traefik.opencloud.test

Compose

It first needs to be tuned a little, and for that, edit deployments/examples/opencloud_full/.env, making the following changes:

• change the container image to opencloudeu/opencloud:dev:

-OC_DOCKER_IMAGE=opencloudeu/opencloud-rolling
+OC_DOCKER_IMAGE=opencloudeu/opencloud
-OC_DOCKER_TAG=
+OC_DOCKER_TAG=dev

• add the groupware service to START_ADDITIONAL_SERVICES:

-START_ADDITIONAL_SERVICES="notifications"
+START_ADDITIONAL_SERVICES="notifications,groupware"

• enable the OpenLDAP container:

-#LDAP=:ldap.yml
+LDAP=:ldap.yml

• enable the Keycloak container:

-#KEYCLOAK=:keycloak.yml
+KEYCLOAK=:keycloak.yml

• enable the Stalwart container:

-#STALWART=:stalwart.yml
+STALWART=:stalwart.yml

• optionally disable the Collabora container

-COLLABORA=:collabora.yml
+#COLLABORA=:collabora.yml

• optionally disable UI containers

-UNZIP=:web_extensions/unzip.yml
-DRAWIO=:web_extensions/drawio.yml
-JSONVIEWER=:web_extensions/jsonviewer.yml
-PROGRESSBARS=:web_extensions/progressbars.yml
-EXTERNALSITES=:web_extensions/externalsites.yml
+#UNZIP=:web_extensions/unzip.yml
+#DRAWIO=:web_extensions/drawio.yml
+#JSONVIEWER=:web_extensions/jsonviewer.yml
+#PROGRESSBARS=:web_extensions/progressbars.yml
+#EXTERNALSITES=:web_extensions/externalsites.yml

Running

Build the opencloudeu/opencloud:dev image first:

cd ~/src/opencloud/opencloud
make -C opencloud/ clean build dev-docker

If you see obscure JavaScript related errors, do this and then try the make command above again:

make -C opencloud/services/idp/ generate

And then either run everything from the Docker Compose opencloud_full setup:

cd ./deployments/examples/opencloud_full/
docker compose up -d

or 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):

docker stop opencloud_full-opencloud-1

and then use the Launcher OpenCloud server with external services in VSCode.

Keycloak Configuration

Now that Keycloak is running, we also need to add a new groupware client to the Keycloak OpenCloud realm in order to be able to use our command-line scripts and other test components.

To do so, use your preferred web browser and

• head over to https://keycloak.opencloud.test/
• authenticate as admin with password admin (those credentials are defined in the .env file mentioned above, see KEYCLOAK_ADMIN_USER and KEYCLOAK_ADMIN_PASSWORD)
• select the OpenCloud realm in the drop-down list in the top left corner (the realm is defined in the .env file, see KEYCLOAK_REALM)
• then select the "Clients" menu item on the left
• in the "Clients list" tab, push the "Create client" button:
  • Client type: OpenID Connect
  • Client ID: groupware
• click the "Next" button:
  • Client authentication: Off
  • Authorization: Off
  • Authentication flow: make sure "Direct access grants" is checked
• click the "Next" button and leave the fields there empty to stick to the defaults
• click "Save"

To check whether it works correctly:

curl -ks -D- -X POST "https://keycloak.opencloud.test/realms/openCloud/protocol/openid-connect/token" -d username=alan -d password=demo -d grant_type=password -d client_id=groupware -d scope=openid

should provide you with a JSON response that contains an access_token.

If it is not set up correctly, it should give you this instead:

{"error":"invalid_client","error_description":"Invalid client or Invalid client credentials"}

Feeding an Inbox

Once a Stalwart container is running (using the Docker Compose setup as explained above), use imap-filler to populate the inbox folder via IMAP APPEND:

cd ~/src/opencloud/
git clone git@github.com:opencloud-eu/imap-filler.git
cd ./imap-filler
EMPTY=true \
USERNAME=alan PASSWORD=demo \
URL=localhost:993 FOLDER=Inbox \
SENDERS=3 COUNT=20 \
go run .

Building

If you run the opencloud service as a container, use the following script to update the container image and restart it:

oc-full-update

If you run it from your IDE, there is obviously no need to do that.

API Docs

The REST API documentation is extracted from the source code structure and documentation using go-swagger, which needs to be installed locally as a prerequisite:

go install github.com/go-swagger/go-swagger/cmd/swagger@latest

The build chain is integrated within the Makefile in services/groupware/:

cd services/groupware/
make apidoc-static

That creates a static documentation HTML file using redocly named api.html

firefox ./api.html

Note that redocly-cli does not need to be installed, it will be pulled locally by the Makefile, provided that you have pnpm installed as a pre-requisite, which is already necessary for other OpenCloud components.

Testing

This section assumes that you are using the helper scripts in opencloud-tools as instructed above.

If you are running OpenCloud from within VSCode, then make sure to set the following environment variable first, in the shell from which you will use the scripts, as the OpenCloud process is listening to that address as opposed to https://cloud.opencloud.test and going through Traefik as is the case when running it from the Docker Compose opencloud_full setup:

export baseurl=https://localhost:9200

The scripts default to using the user alan (with the password demo), which can be changed by setting the following environment variables:

• username
• password

Your main swiss army knife tool will be oc-gw (mnemonic for "OpenCloud Groupware"), which

• always retrieves an access token from Keycloak, using the credentials defined in username and password (defaulting to adam/demo), using the "Direct Access Grant" OIDC or "Resource Owner Password Credentials Grant" OAuth2 flow
• and then use that JWT for Bearer authentication against the OpenCloud Groupware REST API

It will also save you some typing as whenever you use // for the URL, it will replace that by the Groupware REST API base URL, e.g.

oc-gw //accounts

will be translated into

http https://cloud.opencloud.test/groupware/accounts

The first thing you might want to test is to query the index, which will ensure everything is working properly, including the authentication and the communication between the Groupware and Stalwart:

oc-gw //