Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 2
id: docker-compose
sidebar_position: 1
id: docker-compose-base
title: Docker Compose
description: "🌟 Full-blown featureset including web office."
---
Expand Down Expand Up @@ -171,13 +171,13 @@ Same should appear with the other domains you are using.

Example with Chrome browser:

<img src={require("./../img/docker-compose/certificate-details.png").default} alt="Certificate Details" width="500"/>
<img src={require("./../../img/docker-compose/certificate-details.png").default} alt="Certificate Details" width="500"/>


✅ Check the certificate details to confirm it’s from Let's Encrypt Staging.

<img src={require("./../img/docker-compose/certificate-viewer.png").default} alt="Certificate Details" width="500"/>
<img src={require("./../img/docker-compose/subordinate-ca's.png").default} alt="Certificate Details" width="500"/>
<img src={require("./../../img/docker-compose/certificate-viewer.png").default} alt="Certificate Details" width="500"/>
<img src={require("./../../img/docker-compose/subordinate-ca's.png").default} alt="Certificate Details" width="500"/>

## 7. Apply a Real SSL Certificate
Once the staging certificate works, switch to a production certificate.
Expand Down Expand Up @@ -212,7 +212,7 @@ docker compose up -d

✅ Now, visiting `https://cloud.YOUR.DOMAIN` should show a secure connection with a valid SSL certificate.

<img src={require("./../img/docker-compose/status-secure.png").default} alt="Certificate Details" width="1920"/>
<img src={require("./../../img/docker-compose/status-secure.png").default} alt="Certificate Details" width="1920"/>

## 8. Log into OpenCloud
Open a browser and visit:
Expand All @@ -227,10 +227,10 @@ Login with:

**Password:** (your password)

<img src={require("./../img/docker-compose/login.png").default} alt="Admin general" width="1920"/>
<img src={require("./../../img/docker-compose/login.png").default} alt="Admin general" width="1920"/>

## Troubleshooting
If you encounter any issues, check the [Common Issues & Help](./../../resources/common-issues.md)
If you encounter any issues, check the [Common Issues & Help](./../../../resources/common-issues.md)

---

Expand Down Expand Up @@ -265,48 +265,48 @@ https://keycloak.your.domain
```bash
https://keycloak.your.domain
```
<img src={require("./../img/docker-compose/keycloak-dashboard.png").default} alt="Keyclosk dashboard" width="1920"/>
<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"/>
<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"/>
<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"/>
<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"/>
<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"/>
<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"/>
<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"/>
<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"/>
<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"/>
<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"/>
<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.**
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
id: external-proxy
title: Behind external Proxy
description: "OpenCloud behind external Proxy."
draft: true
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 3
id: external-idm
title: With external IDM
description: "OpenCloud with external IDM."
draft: true
---
2 changes: 1 addition & 1 deletion docs/admin/maintenance/upgrade/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.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.md)

### 1. Stop OpenCloud

Expand Down