mirror of
https://github.com/opencloud-eu/opencloud-compose.git
synced 2026-08-07 12:28:43 +08:00
feat: move collaboration into the opencloud process
This commit is contained in:
26
README.md
26
README.md
@@ -109,11 +109,11 @@ This setup includes:
|
||||
### With Collabora Online
|
||||
|
||||
> [!NOTE]
|
||||
> Collabora Online and [Euro Office](#with-euro-office) are mutually exclusive web office backends — both use the same `collaboration` (WOPI) service. Enable only one of them at a time.
|
||||
> Collabora Online and [Euro Office](#with-euro-office) are mutually exclusive web office backends — both use the same `collaboration` (WOPI) service, which runs inside the main OpenCloud process. Enable only one of them at a time.
|
||||
|
||||
Include Collabora for document editing using either method:
|
||||
|
||||
> **DNS Requirements**: This setup requires DNS entries for the main OpenCloud domain, Collabora subdomain, and WOPI server subdomain. Configure DNS A/AAAA records for your domains (e.g., `cloud.example.com`, `collabora.example.com`, `wopiserver.example.com`) or use a wildcard DNS entry (`*.example.com`).
|
||||
> **DNS Requirements**: This setup requires DNS entries for the main OpenCloud domain and the Collabora subdomain. The WOPI server is served by OpenCloud on the main domain, so it does not need its own subdomain. Configure DNS A/AAAA records for your domains (e.g., `cloud.example.com`, `collabora.example.com`) or use a wildcard DNS entry (`*.example.com`).
|
||||
|
||||
Using `-f` flags:
|
||||
```bash
|
||||
@@ -128,17 +128,22 @@ COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:tr
|
||||
> **For local development only**: Add to `/etc/hosts`:
|
||||
> ```
|
||||
> 127.0.0.1 collabora.opencloud.test
|
||||
> 127.0.0.1 wopiserver.opencloud.test
|
||||
> ```
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Upgrading from a previous setup**: The `collaboration` (WOPI) service no longer runs as a separate container or on its own `wopiserver.*` domain — it now runs inside the main OpenCloud process and is served by the OpenCloud proxy on the main domain under the `/wopi` and `/collaboration` paths. When upgrading:
|
||||
> - Pull the latest compose files and recreate the stack (`docker compose up -d`). The old `collaboration` container is removed automatically.
|
||||
> - You can retire the `wopiserver.*` DNS entry (and its `/etc/hosts` line), its reverse-proxy/Traefik route, and the `WOPISERVER_DOMAIN` variable in `.env` — all are now unused.
|
||||
> - If you run behind an external proxy, make sure it forwards `/wopi` and `/collaboration` on the OpenCloud domain to OpenCloud (port 9200). Forwarding the whole OpenCloud domain, as already configured, covers this.
|
||||
|
||||
### With Euro Office
|
||||
|
||||
> [!NOTE]
|
||||
> Euro Office and [Collabora Online](#with-collabora-online) are mutually exclusive web office backends — both use the same `collaboration` (WOPI) service. Enable only one of them at a time.
|
||||
> Euro Office and [Collabora Online](#with-collabora-online) are mutually exclusive web office backends — both use the same `collaboration` (WOPI) service, which runs inside the main OpenCloud process. Enable only one of them at a time.
|
||||
|
||||
Include Euro Office for document editing using either method:
|
||||
|
||||
> **DNS Requirements**: This setup requires DNS entries for the main OpenCloud domain, Euro Office subdomain, and WOPI server subdomain. Configure DNS A/AAAA records for your domains (e.g., `cloud.example.com`, `euro-office.example.com`, `wopiserver.example.com`) or use a wildcard DNS entry (`*.example.com`).
|
||||
> **DNS Requirements**: This setup requires DNS entries for the main OpenCloud domain and the Euro Office subdomain. The WOPI server is served by OpenCloud on the main domain, so it does not need its own subdomain. Configure DNS A/AAAA records for your domains (e.g., `cloud.example.com`, `euro-office.example.com`) or use a wildcard DNS entry (`*.example.com`).
|
||||
|
||||
Using `-f` flags:
|
||||
```bash
|
||||
@@ -153,12 +158,14 @@ COMPOSE_FILE=docker-compose.yml:weboffice/euroffice.yml:traefik/opencloud.yml:tr
|
||||
> **For local development only**: Add to `/etc/hosts`:
|
||||
> ```
|
||||
> 127.0.0.1 euro-office.opencloud.test
|
||||
> 127.0.0.1 wopiserver.opencloud.test
|
||||
> ```
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Set a strong `EURO_OFFICE_JWT_SECRET` in your `.env` file for production. The default value (`changeme`) is intended for local development only.
|
||||
|
||||
> [!NOTE]
|
||||
> Upgrading from a previous setup? See [Upgrading from a previous setup](#with-collabora-online) under Collabora Online — the WOPI server changes (no more separate container or `wopiserver.*` domain) apply to Euro Office as well.
|
||||
|
||||
### With Full Text Search
|
||||
|
||||
Enable full text search capabilities with Apache Tika using either method:
|
||||
@@ -258,7 +265,8 @@ COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:external-proxy/opencloud
|
||||
This exposes the necessary ports:
|
||||
- OpenCloud: 9200
|
||||
- Collabora: 9980
|
||||
- WOPI server: 9300
|
||||
|
||||
The WOPI server runs inside the OpenCloud process and is served on the OpenCloud port (9200) under the `/wopi` and `/collaboration` paths, so no separate port needs to be exposed for it.
|
||||
|
||||
To use Euro Office instead of Collabora behind an external proxy, swap the web office compose files:
|
||||
|
||||
@@ -274,7 +282,8 @@ COMPOSE_FILE=docker-compose.yml:weboffice/euroffice.yml:external-proxy/opencloud
|
||||
This exposes the necessary ports:
|
||||
- OpenCloud: 9200
|
||||
- Euro Office: 9900
|
||||
- WOPI server: 9300
|
||||
|
||||
As with Collabora, the WOPI server is served on the OpenCloud port (9200) under the `/wopi` and `/collaboration` paths and needs no separate port.
|
||||
|
||||
> [!WARNING]
|
||||
> `external-proxy/euroffice.yml` binds the exposed ports to `127.0.0.1` only. If your external proxy runs on a different host, use `external-proxy/euroffice-exposed.yml`, which binds to all interfaces (`0.0.0.0`). Only expose these ports when you know what you are doing.
|
||||
@@ -392,7 +401,6 @@ Key variables:
|
||||
| `OC_DATA_DIR` | Data directory path | (Docker volume) |
|
||||
| `INSECURE` | Skip certificate validation | true |
|
||||
| `COLLABORA_DOMAIN` | Collabora domain | collabora.opencloud.test |
|
||||
| `WOPISERVER_DOMAIN` | WOPI server domain | wopiserver.opencloud.test |
|
||||
| `EURO_OFFICE_DOMAIN` | Euro Office document server domain | euro-office.opencloud.test |
|
||||
| `EURO_OFFICE_JWT_SECRET` | JWT secret for Euro Office (change for production!) | changeme |
|
||||
| `EURO_OFFICE_DOCKER_IMAGE` | Euro Office Docker image | ghcr.io/euro-office/documentserver |
|
||||
|
||||
Reference in New Issue
Block a user