Docker compose public availability

docs/admin/20-getting-started/20-docker-compose.md

@@ -5,84 +5,187 @@ title: Docker Compose
 description: "🌟 Full-blown featureset including web office and full-text search."
 ---
 
-# Docker Compose
+# OpenCloud with Docker Compose
 
+Install a internet facing OpenCloud with SSL certification with Docker Compose.
 
-Spin up a temporary local instance of OpenCloud using **Docker Compose**.
+This installation documentation is for **Ubuntu and Debian** systems. The software can also be installed on other Linux distributions, but the commands and package managers may differ.
 
+## **Prerequisites**
 
-## **Prerequisites:**
-- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)
-- [**Git**](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-- [**Docker Compose**](https://docs.docker.com/compose/install/)
+- **Four domains** pointing to your server:
+  - `cloud.YOUR.DOMAIN` → OpenCloud frontend
+  - `collabora.YOUR.DOMAIN` → Collabora Online Server
+  - `wopiserver.YOUR.DOMAIN` → WOPI server for document editing
+  - `traefik.YOUR.DOMAIN` → Traefik dashboard
+
+  Alternatively, you can use a wildcard domain (`*.YOUR.DOMAIN`)
+- A **hosted server** (e.g., Hetzner, AWS, or your own VPS) with Linux and SSH access
 
 ---
 
-##  1. Download
+## 1. Connect to Your Server
+Log into your server via SSH:
 
-Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration):
+```bash
+ssh root@YOUR.SERVER.IP
+```
 
-```Shell
-git clone https://github.com/opencloud-eu/opencloud.git
+## 2. Install Docker
+Update your system and install Docker.
+
+
+First, perform an update and upgrade:
+
+```bash
+apt update && apt upgrade -y
 ```
+Install Docker following the [official Docker guide](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
 
----
+Once Docker is installed, enable and start the service:
+
+```bash
+systemctl enable docker && systemctl start docker
+```
 
-## 2. Start
+## 3. Clone the OpenCloud Repository
+Download the necessary configuration files:
+
+```bash
+git clone https://github.com/opencloud-eu/opencloud.git
+```
 
-cd into the Docker Compose configuration folder:
+## 4. Configure the .env File for Staging Certificates
+Before requesting real SSL certificates, test the setup with Let's Encrypt’s staging environment.
 
-```Shell
+Navigate to the OpenCloud configuration folder:
+
+```bash
 cd opencloud/deployments/examples/opencloud_full
 ```
 
-Start the deployment with Docker Compose:
+Edit the `.env` file with the editor of your choice:
+
+In our example we use nano
+
+```bash
+nano .env
+```
+
+Modify these settings:
+
+### ✅ Disable insecure mode
+```bash
+# INSECURE=true
+```
+
+### ✅ Set your domain names
+```bash
+TRAEFIK_DOMAIN=traefik.YOUR.DOMAIN
+OC_DOMAIN=cloud.YOUR.DOMAIN
+COLLABORA_DOMAIN=collabora.YOUR.DOMAIN
+WOPISERVER_DOMAIN=wopiserver.YOUR.DOMAIN
+```
+
+### ✅ Set your admin password
+```bash
+ADMIN_PASSWORD=YourSecurePassword
+```
+
+### ✅ Set your email for SSL certification
+```bash
+TRAEFIK_ACME_MAIL=your@email.com
+```
+
+### ✅ Use Let's Encrypt staging certificates (for testing)
+```bash
+TRAEFIK_ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory
+```
+
+Save and exit.
+
+## 5. Start OpenCloud
+Launch OpenCloud using Docker Compose:
 
-```Shell
+```bash
 docker compose up -d
 ```
 
-<img src={require("./img/quick-guide/quick-docker-compose-up.png").default} alt="Admin general" width="1920"/>
+This will start all required services in the background.
 
-This starts all necessary containers in the background.
+## 6. Verify SSL Certification
 
----
+In your web browser, visit:
+
+```bash
+https://cloud.YOUR.DOMAIN
+```
+
+You should see a security warning because the staging certificate is not fully trusted.
+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"/>
 
-## 3. Add local domains to /etc/hosts 
 
-Edit the /etc/hosts file and add the following entries for local access:
+✅ 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"/>
+
+## 7. Apply a Real SSL Certificate
+Once the staging certificate works, switch to a production certificate.
+
+### Steps:
+#### 1️⃣ Stop Docker Compose
+```bash
+docker compose down
 ```
-127.0.0.1       cloud.opencloud.test
-127.0.0.1       collabora.opencloud.test
-127.0.0.1       wopiserver.opencloud.test
+
+#### 2️⃣ Remove old staging certificates
+```bash
+docker volume rm opencloud_full_certs
 ```
 
-Open [https://collabora.opencloud.test](https://collabora.opencloud.test) and accept the self-signed certificate. This step is needed as you can not accept the self-signed certificate if you try to open a .odt document from within the OpenCloud Web UI as Collabora is embedded via an iframe.
+(If you changed volume names, adjust accordingly.)
 
-<img src={require("./img/quick-guide/collabora-accept-self-signed-cert.png").default} alt="Accept self signed certificate" width="1920"/>
+#### 3️⃣ Disable staging mode in `.env`
+```bash
+nano .env
+```
 
+Comment the staging server:
+```bash
+# TRAEFIK_ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory
+```
 
----
+#### 4️⃣ Restart OpenCloud with a real SSL certificate
+```bash
+docker compose up -d
+```
 
-## 4. Login
+✅ Now, visiting `https://cloud.YOUR.DOMAIN` should show a secure connection with a valid SSL certificate.
 
-Login with your browser:
-- [https://cloud.opencloud.test](https://cloud.opencloud.test)
-- user: **admin**
-- password: **admin**
+<img src={require("./img/docker-compose/status-secure.png").default} alt="Certificate Details" width="1920"/>
 
-<img src={require("./img/quick-guide/quick-login.png").default} alt="Admin general" width="1920"/>
+## 8. Log into OpenCloud
+Open a browser and visit:
 
+```bash
+https://cloud.YOUR.DOMAIN
+```
 
-## 5. Conclusion
+Login with:
 
-Your OpenCloud server is now running and ready to use 🚀
+**Username:** `admin`
 
---- 
+**Password:** (your password)
+
+<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 Guide](./../50-resources/30-common-issues.md)
 
-If you encounter any issues or errors, try finding a solution here: 
+---
 
-- [Common Issues & Help](./../50-resources/30-common-issues.md)

docs/admin/20-getting-started/25-docker-compose-local.md

@@ -0,0 +1,85 @@
+---
+sidebar_position: 3
+id: docker-compose-local
+title: Docker Compose local
+description: "🌟 Full-blown featureset including web office and full-text search."
+---
+
+## Guide for local installation
+Spin up a temporary local instance of OpenCloud using **Docker Compose**.
+
+## **Prerequisites:**
+- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)
+- [**Git**](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- [**Docker Compose**](https://docs.docker.com/compose/install/)
+
+---
+
+###  1. Download
+
+Clone the OpenCloud repository:
+
+```Shell
+git clone https://github.com/opencloud-eu/opencloud.git
+```
+
+---
+
+### 2. Start
+
+cd into the Docker Compose configuration folder:
+
+```Shell
+cd opencloud/deployments/examples/opencloud_full
+```
+
+Start the deployment with Docker Compose:
+
+```Shell
+docker compose up -d
+```
+
+<img src={require("./img/quick-guide/quick-docker-compose-up.png").default} alt="Admin general" width="1920"/>
+
+This starts all necessary containers in the background.
+
+---
+
+### 3. Add local domains to /etc/hosts 
+
+Edit the /etc/hosts file and add the following entries for local access:
+
+```
+127.0.0.1       cloud.opencloud.test
+127.0.0.1       collabora.opencloud.test
+127.0.0.1       wopiserver.opencloud.test
+```
+
+Open [https://collabora.opencloud.test](https://collabora.opencloud.test) and accept the self-signed certificate. This step is needed as you can not accept the self-signed certificate if you try to open a .odt document from within the OpenCloud Web UI as Collabora is embedded via an iframe.
+
+<img src={require("./img/quick-guide/collabora-accept-self-signed-cert.png").default} alt="Accept self signed certificate" width="1920"/>
+
+
+---
+
+### 4. Login
+
+Login with your browser:
+- [https://cloud.opencloud.test](https://cloud.opencloud.test)
+- user: **admin**
+- password: **admin**
+
+<img src={require("./img/quick-guide/quick-login.png").default} alt="Admin general" width="1920"/>
+
+
+### 5. Conclusion
+
+Your OpenCloud server is now running and ready to use 🚀
+
+--- 
+
+### Troubleshooting
+
+If you encounter any issues or errors, try finding a solution here: 
+
+- [Common Issues & Help](./../50-resources/30-common-issues.md)

docs/admin/20-getting-started/30-docker.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 id: docker
 title: Docker
 description: "Classic docker setup."

docs/admin/20-getting-started/40-bare-metal.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 id: bare-metal
 title: Bare-Metal
 description: "Manual, minimalist setup with essential features."

docs/admin/20-getting-started/50-raspberry-pi.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 6
 id: raspberry-pi
 title: Raspberry Pi
 ---