From 344ac1c0f0f08fc110e2ef51a6cd6912c6ba484e Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Fri, 4 Jul 2025 14:03:15 +0200 Subject: [PATCH 1/5] Refining docker compose tutorial --- .../container/docker-compose/_category_.json | 4 + ...cker-compose.md => docker-compose-base.md} | 107 +++--------------- .../container/docker-compose/keycloak.md | 86 ++++++++++++++ 3 files changed, 106 insertions(+), 91 deletions(-) create mode 100644 docs/admin/getting-started/container/docker-compose/_category_.json rename docs/admin/getting-started/container/docker-compose/{docker-compose.md => docker-compose-base.md} (67%) create mode 100644 docs/admin/getting-started/container/docker-compose/keycloak.md diff --git a/docs/admin/getting-started/container/docker-compose/_category_.json b/docs/admin/getting-started/container/docker-compose/_category_.json new file mode 100644 index 00000000..0f0aa612 --- /dev/null +++ b/docs/admin/getting-started/container/docker-compose/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Docker-Compose", + "position": 1 +} diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md similarity index 67% rename from docs/admin/getting-started/container/docker-compose/docker-compose.md rename to docs/admin/getting-started/container/docker-compose/docker-compose-base.md index 0c5d4817..9d8940f9 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -56,7 +56,7 @@ systemctl enable docker && systemctl start docker Download the necessary configuration files: ```bash -git clone https://github.com/opencloud-eu/opencloud.git +git clone https://github.com/opencloud-eu/opencloud-compose.git ``` ## 4. Configure the .env File for Staging Certificates @@ -66,9 +66,17 @@ Before requesting real SSL certificates, test the setup with Let's Encrypt’s s Navigate to the OpenCloud configuration folder: ```bash -cd opencloud/deployments/examples/opencloud_full +cd opencloud-compose ``` +Create environment file: + +```bash +cp .env.example .env +``` +> **Note:** The repository includes .env.example as a template with default settings and documentation. Your actual .env file is excluded from version control (via .gitignore) to prevent accidentally committing sensitive information like passwords and domain-specific settings. +
+ Edit the `.env` file with the editor of your choice: In our example we use nano @@ -112,6 +120,12 @@ TRAEFIK_ACME_MAIL=your@email.com TRAEFIK_ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory ``` +### βœ… Set your deployment options: +For Example without Collabora: +```bash +COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml +``` + Save and exit. ### 🚨 Production Setup Consideration @@ -250,92 +264,3 @@ Login with: ## Troubleshooting If you encounter any issues, check the [Common Issues & Help](./../../../resources/common-issues.md) - ---- - -## Enable Keycloak Integration (optional) - -
- -### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file - -```env -LDAP=:ldap.yml -LDAP_MANAGER_DOMAIN=ldap.your.domain -LDAP_ADMIN_PASSWORD="your.save.password" -KEYCLOAK=:keycloak.yml -KEYCLOAK_DOMAIN=keycloak.your.domain -KEYCLOAK_ADMIN_USER="your.username" -KEYCLOAK_ADMIN_PASSWORD="your.save.password" -``` - -This will include the LDAP and Keycloak service definitions in the Docker Compose setup. - -### After starting OpenCloud, Keycloak will be available at - -```bash -https://keycloak.your.domain -``` - -## πŸ‘€ Initial User Setup in Keycloak - -### Once Keycloak is running - -#### 1. Open your browser and go to - -```bash -https://keycloak.your.domain -``` - -Keyclosk dashboard -

- -#### 2. Log in with the admin credentials (default is admin / admin) - -Keycloak login -

- -#### 3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm - -Top left dropdown menue -

- -#### 4. Navigate to the "Users" section and click "Add user" - -User section -
- -- Fill in a username -- Optionally add email, first/last name -- Click "Create" - Fill in userdata -

- -#### 5. Go to the "Credentials" tab - -- Click "Set password" - Credentials -
-- Set a temporary password -- Enable "Temporary" to force password change on first login (optional) -- Click "Save" - Set password -

- -#### 6. Go to the "Role Mapping" tab - -Role mapping -
- -- Click "Assign role" - Assign role -
-- In the dialog, click "Filter by realm roles" - Filter by realm roles -
-- Choose the appropriate role (e.g., user, admin, etc.) -- Click "Assign" - Realm roles -
- -The user can now log in via OpenCloud using the Keycloak credentials. diff --git a/docs/admin/getting-started/container/docker-compose/keycloak.md b/docs/admin/getting-started/container/docker-compose/keycloak.md new file mode 100644 index 00000000..933f42b4 --- /dev/null +++ b/docs/admin/getting-started/container/docker-compose/keycloak.md @@ -0,0 +1,86 @@ +--- +sidebar_position: 4 +id: keycloak +title: Keycloak +description: "OpenCloud with Keycloak." +draft: true +--- + + + +## Enable Keycloak Integration (optional) +
+ +#### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file: + +```env +LDAP=:ldap.yml +LDAP_MANAGER_DOMAIN=ldap.your.domain +LDAP_ADMIN_PASSWORD="your.save.password" +KEYCLOAK=:keycloak.yml +KEYCLOAK_DOMAIN=keycloak.your.domain +KEYCLOAK_ADMIN_USER="your.username" +KEYCLOAK_ADMIN_PASSWORD="your.save.password" +``` + +This will include the LDAP and Keycloak service definitions in the Docker Compose setup. + +#### After starting OpenCloud, Keycloak will be available at: + +```bash +https://keycloak.your.domain +``` + + +## πŸ‘€ Initial User Setup in Keycloak +### Once Keycloak is running: + +**1. Open your browser and go to** +```bash +https://keycloak.your.domain +``` +Keyclosk dashboard +

+ +**2. Log in with the admin credentials (default is admin / admin).** +Keycloak login +

+ +**3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm.** +Top left dropdown menue +

+ +**4. Navigate to the "Users" section and click "Add user":** +User section +
+- Fill in a username +- Optionally add email, first/last name +- Click "Create" +Fill in userdata +

+ +**5. Go to the "Credentials" tab:** +- Click "Set password" +Credentials +
+- Set a temporary password +- Enable "Temporary" to force password change on first login (optional) +- Click "Save" +Set password +

+ +**6. Go to the "Role Mapping" tab:** +Role mapping +
+- Click "Assign role" +Assign role +
+- In the dialog, click "Filter by realm roles" +Filter by realm roles +
+- Choose the appropriate role (e.g., user, admin, etc.) +- Click "Assign" +Realm roles +
+ +**The user can now log in via OpenCloud using the Keycloak credentials.** \ No newline at end of file From 0e66e8408a851ba0bb24382a20fef13dc8e6f701 Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Tue, 15 Jul 2025 11:14:23 +0200 Subject: [PATCH 2/5] Refining docker compose tutorial --- .../docker-compose/docker-compose-base.md | 5 ++++- .../container/docker-compose/keycloak.md | 18 ++++++++++++------ 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md index 9d8940f9..65c76e4e 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -74,6 +74,7 @@ Create environment file: ```bash cp .env.example .env ``` + > **Note:** The repository includes .env.example as a template with default settings and documentation. Your actual .env file is excluded from version control (via .gitignore) to prevent accidentally committing sensitive information like passwords and domain-specific settings.
@@ -120,8 +121,10 @@ TRAEFIK_ACME_MAIL=your@email.com TRAEFIK_ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory ``` -### βœ… Set your deployment options: +### βœ… Set your deployment options + For Example without Collabora: + ```bash COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml ``` diff --git a/docs/admin/getting-started/container/docker-compose/keycloak.md b/docs/admin/getting-started/container/docker-compose/keycloak.md index 933f42b4..5ed59aee 100644 --- a/docs/admin/getting-started/container/docker-compose/keycloak.md +++ b/docs/admin/getting-started/container/docker-compose/keycloak.md @@ -9,9 +9,10 @@ draft: true ## Enable Keycloak Integration (optional) +
-#### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file: +### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file ```env LDAP=:ldap.yml @@ -25,20 +26,22 @@ KEYCLOAK_ADMIN_PASSWORD="your.save.password" This will include the LDAP and Keycloak service definitions in the Docker Compose setup. -#### After starting OpenCloud, Keycloak will be available at: +### After starting OpenCloud, Keycloak will be available at ```bash https://keycloak.your.domain ``` - ## πŸ‘€ Initial User Setup in Keycloak -### Once Keycloak is running: -**1. Open your browser and go to** +### Once Keycloak is running + +- 1. Open your browser and go to + ```bash https://keycloak.your.domain ``` + Keyclosk dashboard

@@ -53,6 +56,7 @@ https://keycloak.your.domain **4. Navigate to the "Users" section and click "Add user":** User section
+ - Fill in a username - Optionally add email, first/last name - Click "Create" @@ -60,6 +64,7 @@ https://keycloak.your.domain

**5. Go to the "Credentials" tab:** + - Click "Set password" Credentials
@@ -72,6 +77,7 @@ https://keycloak.your.domain **6. Go to the "Role Mapping" tab:** Role mapping
+ - Click "Assign role" Assign role
@@ -83,4 +89,4 @@ https://keycloak.your.domain Realm roles
-**The user can now log in via OpenCloud using the Keycloak credentials.** \ No newline at end of file +**The user can now log in via OpenCloud using the Keycloak credentials.** From 2198e08991f8b06f006715152f06e33463f37e6a Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Tue, 15 Jul 2025 11:26:57 +0200 Subject: [PATCH 3/5] Refining docker compose tutorial --- .../container/docker-compose/docker-compose-base.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md index 65c76e4e..2bd0889e 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -221,7 +221,7 @@ docker compose down #### 2️⃣ Remove old staging certificates ```bash -docker volume rm opencloud_full_certs +rm -r certs ``` (If you changed volume names, adjust accordingly.) From fb5bd77500a9d65a9e96c87a8266b25e1b1653f9 Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Tue, 15 Jul 2025 11:46:14 +0200 Subject: [PATCH 4/5] Refining docker compose tutorial --- .../docker-compose/docker-compose-base.md | 2 +- .../container/docker-compose/keycloak.md | 56 +++++++++---------- 2 files changed, 28 insertions(+), 30 deletions(-) diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md index 2bd0889e..3da171fd 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -76,7 +76,7 @@ cp .env.example .env ``` > **Note:** The repository includes .env.example as a template with default settings and documentation. Your actual .env file is excluded from version control (via .gitignore) to prevent accidentally committing sensitive information like passwords and domain-specific settings. -
+>
Edit the `.env` file with the editor of your choice: diff --git a/docs/admin/getting-started/container/docker-compose/keycloak.md b/docs/admin/getting-started/container/docker-compose/keycloak.md index 5ed59aee..fe3276e2 100644 --- a/docs/admin/getting-started/container/docker-compose/keycloak.md +++ b/docs/admin/getting-started/container/docker-compose/keycloak.md @@ -2,12 +2,10 @@ sidebar_position: 4 id: keycloak title: Keycloak -description: "OpenCloud with Keycloak." +description: 'OpenCloud with Keycloak.' draft: true --- - - ## Enable Keycloak Integration (optional)
@@ -45,48 +43,48 @@ https://keycloak.your.domain Keyclosk dashboard

-**2. Log in with the admin credentials (default is admin / admin).** -Keycloak login -

+- 2. Log in with the admin credentials (default is admin / admin). + Keycloak login +

-**3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm.** -Top left dropdown menue -

+- 3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm. + Top left dropdown menue +

-**4. Navigate to the "Users" section and click "Add user":** -User section -
+- 4. Navigate to the "Users" section and click "Add user": + User section +
- Fill in a username - Optionally add email, first/last name - Click "Create" -Fill in userdata -

+ Fill in userdata +

-**5. Go to the "Credentials" tab:** +- 5. Go to the "Credentials" tab: - Click "Set password" -Credentials -
+ Credentials +
- Set a temporary password - Enable "Temporary" to force password change on first login (optional) - Click "Save" -Set password -

+ Set password +

-**6. Go to the "Role Mapping" tab:** -Role mapping -
+- 6. Go to the "Role Mapping" tab: + Role mapping +
- Click "Assign role" -Assign role -
+ Assign role +
- In the dialog, click "Filter by realm roles" -Filter by realm roles -
+ Filter by realm roles +
- Choose the appropriate role (e.g., user, admin, etc.) - Click "Assign" -Realm roles -
+ Realm roles +
-**The user can now log in via OpenCloud using the Keycloak credentials.** +- The user can now log in via OpenCloud using the Keycloak credentials. From 08ac1fde8f8523c1636074e4dee209ce71a83643 Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Tue, 15 Jul 2025 12:06:01 +0200 Subject: [PATCH 5/5] Refining docker compose tutorial --- docs/admin/maintenance/upgrade/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/maintenance/upgrade/upgrade.md b/docs/admin/maintenance/upgrade/upgrade.md index 19fe0ec9..5f37b0f5 100644 --- a/docs/admin/maintenance/upgrade/upgrade.md +++ b/docs/admin/maintenance/upgrade/upgrade.md @@ -8,7 +8,7 @@ description: 'πŸ”„ Keep your setup up to date with the latest features!' import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/getting-started/container/docker.md) and [docker compose](docs/admin/getting-started/container/docker-compose/docker-compose.md) +This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/getting-started/container/docker.md) and [docker compose](docs/admin/getting-started/container/docker-compose/docker-compose-base.md) ### 1. Stop OpenCloud