diff --git a/docs/admin/getting-started/container/docker-compose.md b/docs/admin/getting-started/container/docker-compose.md index 0ef3b03e..def242f7 100644 --- a/docs/admin/getting-started/container/docker-compose.md +++ b/docs/admin/getting-started/container/docker-compose.md @@ -234,3 +234,79 @@ If you encounter any issues, check the [Common Issues & Help](./../../resources/ --- +## 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 diff --git a/docs/admin/getting-started/img/docker-compose/assign-role.png b/docs/admin/getting-started/img/docker-compose/assign-role.png new file mode 100644 index 00000000..958157da Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/assign-role.png differ diff --git a/docs/admin/getting-started/img/docker-compose/credentials.png b/docs/admin/getting-started/img/docker-compose/credentials.png new file mode 100644 index 00000000..bacb58de Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/credentials.png differ diff --git a/docs/admin/getting-started/img/docker-compose/fill-in-userdata.png b/docs/admin/getting-started/img/docker-compose/fill-in-userdata.png new file mode 100644 index 00000000..84ca4263 Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/fill-in-userdata.png differ diff --git a/docs/admin/getting-started/img/docker-compose/filter-by-realm-roles.png b/docs/admin/getting-started/img/docker-compose/filter-by-realm-roles.png new file mode 100644 index 00000000..38545036 Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/filter-by-realm-roles.png differ diff --git a/docs/admin/getting-started/img/docker-compose/keycloak-dashboard.png b/docs/admin/getting-started/img/docker-compose/keycloak-dashboard.png new file mode 100644 index 00000000..e57acb11 Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/keycloak-dashboard.png differ diff --git a/docs/admin/getting-started/img/docker-compose/keycloak-login.png b/docs/admin/getting-started/img/docker-compose/keycloak-login.png new file mode 100644 index 00000000..fa4c020f Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/keycloak-login.png differ diff --git a/docs/admin/getting-started/img/docker-compose/realm-roles.png b/docs/admin/getting-started/img/docker-compose/realm-roles.png new file mode 100644 index 00000000..f6e867be Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/realm-roles.png differ diff --git a/docs/admin/getting-started/img/docker-compose/role-mapping.png b/docs/admin/getting-started/img/docker-compose/role-mapping.png new file mode 100644 index 00000000..018e08d0 Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/role-mapping.png differ diff --git a/docs/admin/getting-started/img/docker-compose/set-password.png b/docs/admin/getting-started/img/docker-compose/set-password.png new file mode 100644 index 00000000..382249f5 Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/set-password.png differ diff --git a/docs/admin/getting-started/img/docker-compose/top-left-dropdown.png b/docs/admin/getting-started/img/docker-compose/top-left-dropdown.png new file mode 100644 index 00000000..d8cdbd9a Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/top-left-dropdown.png differ diff --git a/docs/admin/getting-started/img/docker-compose/users-section.png b/docs/admin/getting-started/img/docker-compose/users-section.png new file mode 100644 index 00000000..7ee11163 Binary files /dev/null and b/docs/admin/getting-started/img/docker-compose/users-section.png differ