Docker compose refinement #370
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Docker-Compose", | ||
| "position": 1 | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| --- | ||
| sidebar_position: 4 | ||
| id: keycloak | ||
| title: Keycloak | ||
| description: 'OpenCloud with Keycloak.' | ||
| draft: true | ||
| --- | ||
|
|
||
| ## Enable Keycloak Integration (optional) | ||
|
|
||
| <br/> | ||
|
|
||
| ### 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 | ||
|
Member
There was a problem hiding this comment. LDAP_MANAGER should not be deployed. Only a testing tool.
Contributor
Author
There was a problem hiding this comment. The keycloak part was before in the docker compose and was only copied here and we will rewrite it in a separate branch |
||
| 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 | ||
| ``` | ||
|
|
||
| <img src={require("./../../img/docker-compose/keycloak-dashboard.png").default} alt="Keyclosk dashboard" width="1920"/> | ||
| <br/><br/> | ||
|
|
||
| - 2. Log in with the admin credentials (default is admin / admin). | ||
| <img src={require("./../../img/docker-compose/keycloak-login.png").default} alt="Keycloak login" width="1920"/> | ||
| <br/><br/> | ||
|
|
||
| - 3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm. | ||
| <img src={require("./../../img/docker-compose/top-left-dropdown.png").default} alt="Top left dropdown menue" width="400"/> | ||
| <br/><br/> | ||
|
|
||
| - 4. Navigate to the "Users" section and click "Add user": | ||
| <img src={require("./../../img/docker-compose/users-section.png").default} alt="User section" width="1920"/> | ||
| <br/> | ||
|
|
||
| - Fill in a username | ||
| - Optionally add email, first/last name | ||
| - Click "Create" | ||
| <img src={require("./../../img/docker-compose/fill-in-userdata.png").default} alt="Fill in userdata" width="1920"/> | ||
| <br/><br/> | ||
|
|
||
| - 5. Go to the "Credentials" tab: | ||
|
|
||
| - Click "Set password" | ||
| <img src={require("./../../img/docker-compose/credentials.png").default} alt="Credentials" width="1920"/> | ||
| <br/> | ||
| - Set a temporary password | ||
| - Enable "Temporary" to force password change on first login (optional) | ||
| - Click "Save" | ||
| <img src={require("./../../img/docker-compose/set-password.png").default} alt="Set password" width="400"/> | ||
| <br/><br/> | ||
|
|
||
| - 6. Go to the "Role Mapping" tab: | ||
| <img src={require("./../../img/docker-compose/role-mapping.png").default} alt="Role mapping" width="1920"/> | ||
| <br/> | ||
|
|
||
| - Click "Assign role" | ||
| <img src={require("./../../img/docker-compose/assign-role.png").default} alt="Assign role" width="1920"/> | ||
| <br/> | ||
| - In the dialog, click "Filter by realm roles" | ||
| <img src={require("./../../img/docker-compose/filter-by-realm-roles.png").default} alt="Filter by realm roles" width="1920"/> | ||
| <br/> | ||
| - Choose the appropriate role (e.g., user, admin, etc.) | ||
| - Click "Assign" | ||
| <img src={require("./../../img/docker-compose/realm-roles.png").default} alt="Realm roles" width="1920"/> | ||
| <br/> | ||
|
|
||
| - The user can now log in via OpenCloud using the Keycloak credentials. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is from the opencloud full example. Please adapt to use COMPOSE_FILE=
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The keycloak part was before in the docker compose and was only copied here and we will rewrite it in a separate branch