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..3da171fd 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,18 @@ 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 +121,14 @@ 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 @@ -204,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.) @@ -250,92 +267,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..fe3276e2 --- /dev/null +++ b/docs/admin/getting-started/container/docker-compose/keycloak.md @@ -0,0 +1,90 @@ +--- +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. 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