mirror of
https://github.com/opencloud-eu/opencloud-compose.git
synced 2026-10-07 11:28:15 +08:00
Compare commits
1 Commits
d0dfc33f41
...
31b38bc884
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
31b38bc884 |
30
.env.example
30
.env.example
@@ -10,24 +10,24 @@ INSECURE=true
|
|||||||
## Features ##
|
## Features ##
|
||||||
# The following variable is a convenience variable to enable or disable features of this compose project.
|
# The following variable is a convenience variable to enable or disable features of this compose project.
|
||||||
# Example: if you want to use traefik and letsencrypt, you can set the variable to
|
# Example: if you want to use traefik and letsencrypt, you can set the variable to
|
||||||
#COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:traefik/opencloud.yml
|
#COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml
|
||||||
# This enables you to just run `docker compose up -d` and the compose files will be added to the stack.
|
# This enables you to just run `docker compose up -d` and the compose files will be added to the stack.
|
||||||
# As alternative approach you can run `docker compose -f docker-compose.yml -f docker-compose.traefik.yml up -d`
|
# As alternative approach you can run `docker compose -f docker-compose.yml -f docker-compose.traefik.yml up -d`
|
||||||
# Default: OpenCloud and Collabora with traefik and letsencypt
|
# Default: OpenCloud and Collabora with traefik and letsencypt
|
||||||
# This needs DNS entries for the domain names used in the .env file.
|
# This needs DNS entries for the domain names used in the .env file.
|
||||||
#COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
#COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||||
# If you want to use the external proxy, you can use the following combination.
|
# If you want to use the external proxy, you can use the following combination.
|
||||||
# DNS entries and certificates need to be managed by the external environment.
|
# DNS entries and certificates need to be managed by the external environment.
|
||||||
# The domain names need to be entered into the .env file.
|
# The domain names need to be entered into the .env file.
|
||||||
#COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:weboffice/collabora.yml:external-proxy/opencloud.yml:external-proxy/collabora.yml
|
#COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:external-proxy/opencloud.yml:external-proxy/collabora.yml
|
||||||
# Keycloak Shared User Directory
|
# Keycloak Shared User Directory
|
||||||
#COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml:idm/ldap-keycloak.yml:traefik/ldap-keycloak.yml
|
#COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml:idm/ldap-keycloak.yml:traefik/ldap-keycloak.yml
|
||||||
# External IDP
|
# External IDP
|
||||||
#COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml:idm/external-idp.yml
|
#COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml:idm/external-idp.yml
|
||||||
# Euro Office with traefik and letsencrypt
|
# Euro Office with traefik and letsencrypt
|
||||||
#COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:weboffice/euro-office.yml:traefik/opencloud.yml:traefik/euro-office.yml
|
#COMPOSE_FILE=docker-compose.yml:weboffice/euro-office.yml:traefik/opencloud.yml:traefik/euro-office.yml
|
||||||
# Euro Office with external proxy (Nginx, Caddy, etc.)
|
# Euro Office with external proxy (Nginx, Caddy, etc.)
|
||||||
#COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:weboffice/euro-office.yml:external-proxy/opencloud.yml:external-proxy/euro-office.yml
|
#COMPOSE_FILE=docker-compose.yml:weboffice/euro-office.yml:external-proxy/opencloud.yml:external-proxy/euro-office.yml
|
||||||
|
|
||||||
## Traefik Settings ##
|
## Traefik Settings ##
|
||||||
# Note: Traefik is always enabled and can't be disabled.
|
# Note: Traefik is always enabled and can't be disabled.
|
||||||
@@ -383,23 +383,9 @@ KC_DB_PASSWORD=
|
|||||||
# - ./config/ldap/ldif/30_demo_users.ldif:/ldifs/30_demo_users.ldif
|
# - ./config/ldap/ldif/30_demo_users.ldif:/ldifs/30_demo_users.ldif
|
||||||
# - ./config/ldap/ldif/40_demo_groups.ldif:/ldifs/40_demo_groups.ldif
|
# - ./config/ldap/ldif/40_demo_groups.ldif:/ldifs/40_demo_groups.ldif
|
||||||
#
|
#
|
||||||
# Then add it to: COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml:idm/ldap-keycloak.yml:traefik/ldap-keycloak.yml:custom/ldap-keycloak-demo-users.yml
|
# Then add it to: COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml:idm/ldap-keycloak.yml:traefik/ldap-keycloak.yml:custom/ldap-keycloak-demo-users.yml
|
||||||
# WARNING: Do not use in production.
|
# WARNING: Do not use in production.
|
||||||
|
|
||||||
### Yjs Settings ###
|
|
||||||
# The yjs server relays updates between users editing the same file.
|
|
||||||
# It is enabled by default via yjs/yjs.yml in the COMPOSE_FILE variable.
|
|
||||||
# The browser reaches it under https://{OC_DOMAIN}/yjs, the OpenCloud proxy forwards it.
|
|
||||||
# Docker image to use for the yjs container.
|
|
||||||
#YJS_DOCKER_IMAGE=opencloudeu/yjs
|
|
||||||
# Docker tag to pull for the yjs container.
|
|
||||||
#YJS_DOCKER_TAG=1.0.0
|
|
||||||
# URL the yjs server uses to reach OpenCloud. Defaults to "http://opencloud:9200".
|
|
||||||
#YJS_OPENCLOUD_URL=
|
|
||||||
# Grace period in milliseconds for a graceful shutdown. Defaults to "15000".
|
|
||||||
# Keep it below the stop_grace_period set in yjs/yjs.yml.
|
|
||||||
#YJS_SHUTDOWN_GRACE_PERIOD_MS=
|
|
||||||
|
|
||||||
### Radicale Setting ###
|
### Radicale Setting ###
|
||||||
# Radicale is a small open-source CalDAV (calendars, to-do lists) and CardDAV (contacts) server.
|
# Radicale is a small open-source CalDAV (calendars, to-do lists) and CardDAV (contacts) server.
|
||||||
# When enabled OpenCloud is configured as a reverse proxy for Radicale, providing all authenticated
|
# When enabled OpenCloud is configured as a reverse proxy for Radicale, providing all authenticated
|
||||||
|
|||||||
17
README.md
17
README.md
@@ -195,22 +195,6 @@ By default, OpenCloud Compose uses `apache/tika:latest` which provides:
|
|||||||
|
|
||||||
The base variant is recommended for most use cases. If you need advanced features like specialized OCR processing or specific image format support, you can override the image by setting `TIKA_IMAGE=apache/tika:latest-full` in your `.env` file.
|
The base variant is recommended for most use cases. If you need advanced features like specialized OCR processing or specific image format support, you can override the image by setting `TIKA_IMAGE=apache/tika:latest-full` in your `.env` file.
|
||||||
|
|
||||||
### With the Yjs Server
|
|
||||||
|
|
||||||
The yjs server enables collaborative editing of files. The browser connects to `wss://{OC_DOMAIN}/yjs`. The OpenCloud proxy forwards this route to the yjs container, so no extra DNS entry or port is needed.
|
|
||||||
|
|
||||||
Using `-f` flags:
|
|
||||||
```bash
|
|
||||||
docker compose -f docker-compose.yml -f yjs/yjs.yml -f traefik/opencloud.yml up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
Or by setting in `.env`:
|
|
||||||
```
|
|
||||||
COMPOSE_FILE=docker-compose.yml:yjs/yjs.yml:traefik/opencloud.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
The service keeps documents in memory only. All users of one file must reach the same instance, so run a single instance.
|
|
||||||
|
|
||||||
### With Radicale
|
### With Radicale
|
||||||
|
|
||||||
Enable CalDAV (calendars, to-do lists) and CardDAV (contacts) server.
|
Enable CalDAV (calendars, to-do lists) and CardDAV (contacts) server.
|
||||||
@@ -482,7 +466,6 @@ This repository uses a modular approach with multiple compose files:
|
|||||||
- `traefik/` - Traefik reverse proxy configurations
|
- `traefik/` - Traefik reverse proxy configurations
|
||||||
- `external-proxy/` - Configuration for external reverse proxies
|
- `external-proxy/` - Configuration for external reverse proxies
|
||||||
- `radicale/` - Radicale configuration
|
- `radicale/` - Radicale configuration
|
||||||
- `yjs/` - Yjs server configuration (collaborative editing)
|
|
||||||
- `config/` - Configuration files for OpenCloud, Keycloak, and LDAP
|
- `config/` - Configuration files for OpenCloud, Keycloak, and LDAP
|
||||||
|
|
||||||
## Advanced Usage
|
## Advanced Usage
|
||||||
|
|||||||
@@ -1,13 +1,9 @@
|
|||||||
# This adds additional routes to the proxy. Forwarding
|
# This adds four additional routes to the proxy. Forwarding
|
||||||
# request on '/carddav/', '/caldav/' and the respective '/.well-knwown'
|
# request on '/carddav/', '/caldav/' and the respective '/.well-knwown'
|
||||||
# endpoints to the radicale container and setting the required headers.
|
# endpoints to the radicale container and setting the required headers.
|
||||||
# '/yjs' is forwarded to the yjs container.
|
|
||||||
additional_policies:
|
additional_policies:
|
||||||
- name: default
|
- name: default
|
||||||
routes:
|
routes:
|
||||||
- endpoint: /yjs
|
|
||||||
backend: http://yjs:1234
|
|
||||||
unprotected: true
|
|
||||||
- endpoint: /caldav/
|
- endpoint: /caldav/
|
||||||
backend: http://radicale:5232
|
backend: http://radicale:5232
|
||||||
remote_user_header: X-Remote-User
|
remote_user_header: X-Remote-User
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
services:
|
services:
|
||||||
opencloud:
|
opencloud:
|
||||||
# renovate: depName=opencloudeu/opencloud-rolling
|
# renovate: depName=opencloudeu/opencloud-rolling
|
||||||
image: ${OC_DOCKER_IMAGE:-opencloudeu/opencloud-rolling}:${OC_DOCKER_TAG:-8.0.0}
|
image: ${OC_DOCKER_IMAGE:-opencloudeu/opencloud-rolling}:${OC_DOCKER_TAG:-7.5.0}
|
||||||
# changelog: https://github.com/opencloud-eu/opencloud/tree/main/changelog
|
# changelog: https://github.com/opencloud-eu/opencloud/tree/main/changelog
|
||||||
# release notes: https://docs.opencloud.eu/opencloud_release_notes.html
|
# release notes: https://docs.opencloud.eu/opencloud_release_notes.html
|
||||||
user: ${OC_CONTAINER_UID_GID:-1000:1000}
|
user: ${OC_CONTAINER_UID_GID:-1000:1000}
|
||||||
|
|||||||
22
yjs/yjs.yml
22
yjs/yjs.yml
@@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
services:
|
|
||||||
opencloud:
|
|
||||||
environment:
|
|
||||||
WEB_OPTION_YJS_SERVER_URL: wss://${OC_DOMAIN:-cloud.opencloud.test}${TRAEFIK_PORT_HTTPS:+:}${TRAEFIK_PORT_HTTPS:-}/yjs
|
|
||||||
volumes:
|
|
||||||
# the /yjs route is configured in the proxy
|
|
||||||
- ./config/opencloud/proxy.yaml:/etc/opencloud/proxy.yaml
|
|
||||||
yjs:
|
|
||||||
image: ${YJS_DOCKER_IMAGE:-opencloudeu/yjs}:${YJS_DOCKER_TAG:-1.0.0}
|
|
||||||
user: ${OC_CONTAINER_UID_GID:-1000:1000}
|
|
||||||
networks:
|
|
||||||
opencloud-net:
|
|
||||||
environment:
|
|
||||||
PORT: '1234'
|
|
||||||
# internal address, no TLS between the containers
|
|
||||||
OPENCLOUD_URL: ${YJS_OPENCLOUD_URL:-http://opencloud:9200}
|
|
||||||
SHUTDOWN_GRACE_PERIOD_MS: '${YJS_SHUTDOWN_GRACE_PERIOD_MS:-15000}'
|
|
||||||
logging:
|
|
||||||
driver: ${LOG_DRIVER:-local}
|
|
||||||
restart: always
|
|
||||||
stop_grace_period: 20s
|
|
||||||
Reference in New Issue
Block a user