mirror of
https://github.com/opencloud-eu/opencloud-compose.git
synced 2026-06-08 12:10:05 +08:00
Merge pull request #27 from opencloud-eu/restructure
style: restructure files
This commit is contained in:
10
.env.example
10
.env.example
@@ -15,13 +15,13 @@ INSECURE=true
|
||||
# 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
|
||||
# This needs DNS entries for the domain names used in the .env file.
|
||||
#COMPOSE_FILE=docker-compose.yml:docker-compose.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.
|
||||
# DNS entries and certificates need to be managed by the external environment.
|
||||
# The domain names need to be entered into the .env file.
|
||||
#COMPOSE_FILE=docker-compose.yml:docker-compose.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
|
||||
#COMPOSE_FILE=docker-compose.yml:docker-compose.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
|
||||
|
||||
## Traefik Settings ##
|
||||
# Note: Traefik is always enabled and can't be disabled.
|
||||
@@ -85,8 +85,8 @@ LOG_LEVEL=
|
||||
# S3 Storage configuration - optional
|
||||
# OpenCloud supports S3 storage as primary storage.
|
||||
# Per default, S3 storage is disabled and the decomposed storage driver is used.
|
||||
# To enable S3 storage, add `docker-compose.decomposeds3.yml` to the COMPOSE_FILE variable or to
|
||||
# your startup command (`docker compose -f docker-compose.yml -f docker-compose.decomposeds3.yml up`).
|
||||
# To enable S3 storage, add `storage/decomposeds3.yml` to the COMPOSE_FILE variable or to
|
||||
# your startup command (`docker compose -f docker-compose.yml -f storage/decomposeds3.yml up`).
|
||||
#
|
||||
# Configure the S3 storage endpoint. Defaults to "http://minio:9000" for testing purposes.
|
||||
DECOMPOSEDS3_ENDPOINT=
|
||||
|
||||
19
README.md
19
README.md
@@ -73,7 +73,7 @@ OpenCloud Compose offers a modular approach to deploying OpenCloud with several
|
||||
|
||||
2. **Configure deployment options** in `.env`:
|
||||
```
|
||||
COMPOSE_FILE=docker-compose.yml:docker-compose.collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
```
|
||||
|
||||
3. **Start OpenCloud**:
|
||||
@@ -113,12 +113,12 @@ Include Collabora for document editing using either method:
|
||||
|
||||
Using `-f` flags:
|
||||
```bash
|
||||
docker compose -f docker-compose.yml -f docker-compose.collabora.yml -f traefik/opencloud.yml -f traefik/collabora.yml up -d
|
||||
docker compose -f docker-compose.yml -f weboffice/collabora.yml -f traefik/opencloud.yml -f traefik/collabora.yml up -d
|
||||
```
|
||||
|
||||
Or by setting in `.env`:
|
||||
```
|
||||
COMPOSE_FILE=docker-compose.yml:docker-compose.collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
```
|
||||
|
||||
Add to `/etc/hosts` for local development:
|
||||
@@ -133,12 +133,12 @@ If you already have a reverse proxy (Nginx, Caddy, etc.), use either method:
|
||||
|
||||
Using `-f` flags:
|
||||
```bash
|
||||
docker compose -f docker-compose.yml -f docker-compose.collabora.yml -f external-proxy/opencloud.yml -f external-proxy/collabora.yml up -d
|
||||
docker compose -f docker-compose.yml -f weboffice/collabora.yml -f external-proxy/opencloud.yml -f external-proxy/collabora.yml up -d
|
||||
```
|
||||
|
||||
Or by setting in `.env`:
|
||||
```
|
||||
COMPOSE_FILE=docker-compose.yml:docker-compose.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
|
||||
```
|
||||
|
||||
This exposes the necessary ports:
|
||||
@@ -204,7 +204,8 @@ chown -R 1000:1000 /path/to/opencloud
|
||||
This repository uses a modular approach with multiple compose files:
|
||||
|
||||
- `docker-compose.yml` - Core OpenCloud service
|
||||
- `docker-compose.collabora.yml` - Collabora Online integration
|
||||
- `weboffice/` - Web office integrations (Collabora Online)
|
||||
- `storage/` - Storage backend configurations (decomposeds3)
|
||||
- `idm/` - Identity management configurations (Keycloak & LDAP)
|
||||
- `traefik/` - Traefik reverse proxy configurations
|
||||
- `external-proxy/` - Configuration for external reverse proxies
|
||||
@@ -225,7 +226,7 @@ Example configurations:
|
||||
|
||||
Production with Collabora:
|
||||
```
|
||||
COMPOSE_FILE=docker-compose.yml:docker-compose.collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
```
|
||||
|
||||
Production with Keycloak and LDAP:
|
||||
@@ -235,7 +236,7 @@ COMPOSE_FILE=docker-compose.yml:idm/ldap-keycloak.yml:traefik/opencloud.yml:trae
|
||||
|
||||
Production with both Collabora and Keycloak/LDAP:
|
||||
```
|
||||
COMPOSE_FILE=docker-compose.yml:docker-compose.collabora.yml:idm/ldap-keycloak.yml:traefik/opencloud.yml:traefik/collabora.yml:traefik/ldap-keycloak.yml
|
||||
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:idm/ldap-keycloak.yml:traefik/opencloud.yml:traefik/collabora.yml:traefik/ldap-keycloak.yml
|
||||
```
|
||||
|
||||
### Automation and GitOps
|
||||
@@ -243,7 +244,7 @@ COMPOSE_FILE=docker-compose.yml:docker-compose.collabora.yml:idm/ldap-keycloak.y
|
||||
For automated deployments, using the `COMPOSE_FILE` variable in `.env` is recommended:
|
||||
|
||||
```
|
||||
COMPOSE_FILE=docker-compose.yml:docker-compose.collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
|
||||
```
|
||||
|
||||
This allows tools like Ansible or CI/CD pipelines to deploy the stack without modifying the compose files.
|
||||
|
||||
Reference in New Issue
Block a user