diff --git a/docs/admin/getting-started/container/docker-compose-local.md b/docs/admin/getting-started/container/docker-compose-local.md index 34bf22fd..33d644a5 100644 --- a/docs/admin/getting-started/container/docker-compose-local.md +++ b/docs/admin/getting-started/container/docker-compose-local.md @@ -2,32 +2,29 @@ sidebar_position: 3 id: docker-compose-local title: Docker Compose local -description: '🌟 Full-blown featureset including web office and full-text search.' +description: Full-blown featureset including web office and full-text search. +draft: false --- -## Guide for local installation +# Guide for local installation -Spin up a temporary local instance of OpenCloud using **Docker Compose**. +Spin up a temporary local instance of OpenCloud using Docker Compose. -## **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/) +- 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 +## Download -Clone the OpenCloud repository: +- Clone the OpenCloud repository ```bash git clone https://github.com/opencloud-eu/opencloud-compose.git ``` ---- - -## 2. Start +## Start ### cd into the Docker Compose configuration folder @@ -41,31 +38,33 @@ cd opencloud-compose 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. +:::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. +::: ### Configure deployment options -You can deploy using explicit -f flags: +- You can deploy using explicit -f flags ```bash docker compose -f docker-compose.yml -f weboffice/collabora.yml -f traefik/opencloud.yml -f traefik/collabora.yml up -d ``` -Or by uncomment or adding the COMPOSE_FILE variable in .env: +- or by uncomment or adding the COMPOSE_FILE variable in .env ```bash COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml ``` -Set you initial admin password in the .env +- Set you initial admin password in the .env ```bash INITIAL_ADMIN_PASSWORD=YOUR.SECRET.PASSWORD ``` -This is mandatory for security reasons. Otherwise the OpenCloud container will not start. +### This is mandatory for security reasons. Otherwise the OpenCloud container will not start -Start the deployment with Docker Compose: +- Start the deployment with Docker Compose ```bash docker compose up -d @@ -73,13 +72,11 @@ docker compose up -d Admin general -This starts all necessary containers in the background. - ---- +- This starts all necessary containers in the background -## 3. Add local domains to /etc/hosts +## Add local domains to /etc/hosts -Edit the /etc/hosts file and add the following entries for local access: +### Edit the /etc/hosts file and add the following entries for local access ```bash 127.0.0.1 cloud.opencloud.test @@ -91,23 +88,19 @@ Open [https://collabora.opencloud.test](https://collabora.opencloud.test) and ac Accept self signed certificate ---- - -## 4. Login +## Login -Login with your browser: +- Login with your browser - [https://cloud.opencloud.test](https://cloud.opencloud.test) -- user: **admin** +- user: admin - password: YOUR.SECRET.PASSWORD Admin general -## 5. Conclusion +## Conclusion -Your OpenCloud server is now running and ready to use πŸš€ - ---- +- Your OpenCloud server is now running and ready to use ## Troubleshooting diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md index 3da171fd..9d2afb8b 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -2,18 +2,19 @@ sidebar_position: 1 id: docker-compose-base title: Docker Compose -description: '🌟 Full-blown featureset including web office.' +description: Full-blown featureset including web office. +draft: false --- # OpenCloud with Docker Compose Install a internet facing OpenCloud with SSL certification with 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. +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 -- **Four domains** pointing to your server: +- 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 @@ -21,11 +22,9 @@ This installation documentation is for **Ubuntu and Debian** systems. The softwa 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 +- A hosted server (e.g., Hetzner, AWS, or your own VPS) with Linux and SSH access ---- - -## 1. Connect to Your Server +## Connect to Your Server Log into your server via SSH: @@ -33,7 +32,7 @@ Log into your server via SSH: ssh root@YOUR.SERVER.IP ``` -## 2. Install Docker +## Install Docker Update your system and install Docker. @@ -51,7 +50,7 @@ Once Docker is installed, enable and start the service: systemctl enable docker && systemctl start docker ``` -## 3. Clone the OpenCloud Repository +## Clone the OpenCloud Repository Download the necessary configuration files: @@ -59,42 +58,43 @@ Download the necessary configuration files: git clone https://github.com/opencloud-eu/opencloud-compose.git ``` -## 4. Configure the .env File for Staging Certificates +## Configure the .env File for Staging Certificates Before requesting real SSL certificates, test the setup with Let's Encrypt’s staging environment. -Navigate to the OpenCloud configuration folder: +### Navigate to the OpenCloud configuration folder ```bash cd opencloud-compose ``` -Create environment file: +### 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. ->
+:::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 +### In our example we use nano ```bash nano .env ``` -Modify these settings: +## Modify these settings -### βœ… Disable insecure mode +### Disable insecure mode ```bash # INSECURE=true ``` -### βœ… Set your domain names +### Set your domain names ```bash TRAEFIK_DOMAIN=traefik.YOUR.DOMAIN @@ -103,25 +103,25 @@ COLLABORA_DOMAIN=collabora.YOUR.DOMAIN WOPISERVER_DOMAIN=wopiserver.YOUR.DOMAIN ``` -### βœ… Set your admin password +### Set your admin password ```bash ADMIN_PASSWORD=YourSecurePassword ``` -### βœ… Set your email for SSL certification +### Set your email for SSL certification ```bash TRAEFIK_ACME_MAIL=your@email.com ``` -### βœ… Use Let's Encrypt staging certificates (for testing) +### Use Let's Encrypt staging certificates (for testing) ```bash TRAEFIK_ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory ``` -### βœ… Set your deployment options +### Set your deployment options For Example without Collabora: @@ -131,16 +131,14 @@ COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml Save and exit. -### 🚨 Production Setup Consideration +### Production Setup Consideration :::caution Production Setup Recommended - By default, OpenCloud stores configuration and data inside internal Docker volumes. -This works fine for local development or quick evaluations β€” **but is not suitable for production environments**. - +This works fine for local development or quick evaluations β€” but is not suitable for production environments. ::: -#### πŸ“¦ Mount Persistent Volumes +#### Mount Persistent Volumes In production, you should mount persistent local directories for configuration and data to ensure: @@ -166,7 +164,7 @@ sudo chown -R 1000:1000 /your/local/path/opencloud ::: -If these variables are left unset, Docker will use internal volumes, which **do not persist** if the containers are removed β€” not recommended for real-world use. +If these variables are left unset, Docker will use internal volumes, which do not persist if the containers are removed β€” not recommended for real-world use. :::caution Security Warning @@ -176,7 +174,7 @@ This can pose a security risk in shared or multi-user environments. Make sure to ::: -## 5. Start OpenCloud +## Start OpenCloud Launch OpenCloud using Docker Compose: @@ -186,7 +184,7 @@ docker compose up -d This will start all required services in the background. -## 6. Verify SSL Certification +## Verify SSL Certification In your web browser, visit: @@ -201,24 +199,22 @@ Example with Chrome browser: Certificate Details -βœ… Check the certificate details to confirm it’s from Let's Encrypt Staging. +- Check the certificate details to confirm it’s from Let's Encrypt Staging. -Certificate Details -Certificate Details + Certificate Details + Certificate Details -## 7. Apply a Real SSL Certificate +## Apply a Real SSL Certificate Once the staging certificate works, switch to a production certificate. -### Steps - -#### 1️⃣ Stop Docker Compose +### Stop Docker Compose ```bash docker compose down ``` -#### 2️⃣ Remove old staging certificates +### Remove old staging certificates ```bash rm -r certs @@ -226,7 +222,7 @@ rm -r certs (If you changed volume names, adjust accordingly.) -#### 3️⃣ Disable staging mode in `.env` +### Disable staging mode in `.env` ```bash nano .env @@ -238,7 +234,7 @@ Comment the staging server: # TRAEFIK_ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory ``` -#### 4️⃣ Restart OpenCloud with a real SSL certificate +### Restart OpenCloud with a real SSL certificate ```bash docker compose up -d @@ -248,7 +244,7 @@ docker compose up -d Certificate Details -## 8. Log into OpenCloud +## Log into OpenCloud Open a browser and visit: @@ -258,9 +254,9 @@ https://cloud.YOUR.DOMAIN Login with: -**Username:** `admin` +Username: `admin` -**Password:** (your password) +Password: (your password) Admin general diff --git a/docs/admin/getting-started/container/docker-compose/docker-external-proxy.md b/docs/admin/getting-started/container/docker-compose/docker-external-proxy.md index 3af5b23f..5b598755 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-external-proxy.md +++ b/docs/admin/getting-started/container/docker-compose/docker-external-proxy.md @@ -2,19 +2,20 @@ sidebar_position: 2 id: external-proxy title: Behind External Proxy -description: 'How to run OpenCloud behind an external Nginx proxy with Certbot (manual setup).' +description: How to run OpenCloud behind an external Nginx proxy with Certbot (manual setup). +draft: false --- -# 🌐 Running OpenCloud Behind an External Proxy (Nginx + Certbot Setup) +# Running OpenCloud Behind an External Proxy (Nginx + Certbot Setup) -This guide walks you through setting up OpenCloud behind an external **Nginx reverse proxy** with **Let's Encrypt certificates** using `certbot certonly --webroot`. +This guide walks you through setting up OpenCloud behind an external Nginx reverse proxy with Let's Encrypt certificates using `certbot certonly --webroot`. --- -## βœ… Requirements +## Requirements -- A **public server** with a static IP -- Proper **DNS records** for your domain: +- A public server with a static IP +- Proper DNS records for your domain: - `cloud.YOUR.DOMAIN` - `collabora.YOUR.DOMAIN` - `wopiserver.YOUR.DOMAIN` @@ -23,9 +24,7 @@ This guide walks you through setting up OpenCloud behind an external **Nginx rev - `nginx` - `certbot` ---- - -## Step 1: Connect to Your Server +## Connect to Your Server Log into your server via SSH: @@ -33,9 +32,7 @@ Log into your server via SSH: ssh root@YOUR.SERVER.IP ``` ---- - -## Step 2: Install Docker +## Install Docker Update your system and install Docker. @@ -53,9 +50,7 @@ Once Docker is installed, enable and start the service: systemctl enable docker && systemctl start docker ``` ---- - -## Step 3: Clone the OpenCloud Repository +## Clone the OpenCloud Repository Download the necessary configuration files: @@ -63,22 +58,18 @@ Download the necessary configuration files: git clone https://github.com/opencloud-eu/opencloud.git ``` ---- - -## Step 4: Install Nginx & Certbot +## Install Nginx & Certbot Now install Nginx & Certbot -## πŸ“ Step 5: Create a Webroot Directory for Certbot +## Create a Webroot Directory for Certbot ```bash sudo mkdir -p /var/www/certbot sudo chown -R www-data:www-data /var/www/certbot ``` ---- - -## πŸ”§ Step 6: Temporary Nginx Config for HTTP Challenge +## Temporary Nginx Config for HTTP Challenge Create a temporary config to allow HTTP validation: @@ -86,7 +77,7 @@ Create a temporary config to allow HTTP validation: sudo nano /etc/nginx/sites-available/certbot-challenge ``` -Paste the following config: +Paste the following config and adjust the URLs: ```nginx server { @@ -109,11 +100,9 @@ sudo ln -s /etc/nginx/sites-available/certbot-challenge /etc/nginx/sites-enabled sudo nginx -t && sudo systemctl reload nginx ``` ---- - -## πŸ” Step 7: Obtain SSL Certificates +## Obtain SSL Certificates -Use `certbot` to get your TLS certificates: +Use `certbot` to get your TLS certificates with adjusted URLs: ```bash sudo certbot certonly --webroot \ @@ -131,9 +120,7 @@ Your certificates will be saved under: - `/etc/letsencrypt/live/cloud.YOUR.DOMAIN/fullchain.pem` - `/etc/letsencrypt/live/cloud.YOUR.DOMAIN/privkey.pem` ---- - -## βš™οΈ Step 8: Configure and start OpenCloud +## Configure and start OpenCloud Clone the OpenCloud Compose repo and set your environment: @@ -168,9 +155,7 @@ Start the docker compose setup docker compose up -d ``` ---- - -## 🧩 Step 9: Set Up the Final Nginx Reverse Proxy +## Set Up the Final Nginx Reverse Proxy ### Remove the temporary certbot config @@ -184,7 +169,7 @@ sudo rm /etc/nginx/sites-enabled/certbot-challenge sudo nano /etc/nginx/sites-available/opencloud ``` -Paste the following configuration: +Paste the following configuration and adjust the URLs: ```nginx # Redirect HTTP to HTTPS @@ -266,14 +251,10 @@ sudo ln -s /etc/nginx/sites-available/opencloud /etc/nginx/sites-enabled/ sudo nginx -t && sudo systemctl reload nginx ``` ---- - -## πŸ” Step 10: Test Certificate Renewal +## Test Certificate Renewal ```bash sudo certbot renew --dry-run ``` ---- - Your OpenCloud instance is now running securely behind a fully configured external Nginx reverse proxy with HTTPS. diff --git a/docs/admin/getting-started/container/docker-compose/external-idm.md b/docs/admin/getting-started/container/docker-compose/external-idm.md index cb3b1690..3fefb817 100644 --- a/docs/admin/getting-started/container/docker-compose/external-idm.md +++ b/docs/admin/getting-started/container/docker-compose/external-idm.md @@ -2,6 +2,6 @@ sidebar_position: 3 id: external-idm title: With external IDM -description: 'OpenCloud with external IDM.' +description: OpenCloud with external IDM. draft: true --- diff --git a/docs/admin/getting-started/container/docker-compose/keycloak.md b/docs/admin/getting-started/container/docker-compose/keycloak.md index a1de72b7..d7c67e95 100644 --- a/docs/admin/getting-started/container/docker-compose/keycloak.md +++ b/docs/admin/getting-started/container/docker-compose/keycloak.md @@ -6,11 +6,11 @@ description: 'OpenCloud with Keycloak.' draft: true --- -## Enable Keycloak Integration (optional) +# Keycloak Integration -
+## Enable Keycloak -### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file +To enable Keycloak for identity and access management, uncomment the following lines in your `.env` file ```env LDAP=:ldap.yml @@ -24,17 +24,19 @@ 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 +## Starting OpenCloud + +After starting OpenCloud, Keycloak will be available at ```bash https://keycloak.your.domain ``` -## πŸ‘€ Initial User Setup in Keycloak +## Initial User Setup in Keycloak -### Once Keycloak is running +Once Keycloak is running -- 1. Open your browser and go to +### Open your browser and go to ```bash https://keycloak.your.domain @@ -42,22 +44,24 @@ https://keycloak.your.domain Keyclosk dashboard -- 2. Log in with the admin credentials (default is admin / admin). - Keycloak login +### Log in with the admin credentials (default is admin / admin) + +Keycloak login + +### In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm -- 3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm. - Top left dropdown menue +Top left dropdown menue -- 4. Navigate to the "Users" section and click "Add user": - User section -
+### 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: +### Go to the "Credentials" tab - Click "Set password" Credentials @@ -67,19 +71,18 @@ https://keycloak.your.domain - Click "Save" Set password -- 6. Go to the "Role Mapping" tab: - Role mapping -
+### 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. +The user can now log in via OpenCloud using the Keycloak credentials. diff --git a/docs/admin/getting-started/container/docker.md b/docs/admin/getting-started/container/docker.md index 5f19ad2a..70b15e40 100644 --- a/docs/admin/getting-started/container/docker.md +++ b/docs/admin/getting-started/container/docker.md @@ -2,40 +2,33 @@ sidebar_position: 1 id: docker title: Docker -description: 'Classic docker setup.' +description: Classic docker setup. +draft: false --- # Docker -## Spin up a temporary local instance of OpenCloud using **Docker** +Spin up a temporary local instance of OpenCloud using Docker ---- - -### **Prerequisites:** +## Prerequisites -- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) -- [**Docker**](https://docs.docker.com/compose/install/) - ---- +- Linux, Mac or Windows Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) +- [Docker](https://docs.docker.com/compose/install/) -### 1. Create Required Directories for Bind Mounts +## Create Required Directories for Bind Mounts ```bash mkdir -p $HOME/opencloud/opencloud-config mkdir -p $HOME/opencloud/opencloud-data ``` ---- - -### 2. Pull OpenCloud Image +## Pull OpenCloud Image ```bash docker pull opencloudeu/opencloud-rolling:latest ``` ---- - -### 3. Initialize OpenCloud (First-time Setup) +## Initialize OpenCloud (First-time Setup) ```bash docker run --rm -it \ @@ -49,9 +42,7 @@ You can set your own password using `IDM_ADMIN_PASSWORD=your_password`. If not s Admin general ---- - -### 4. Start OpenCloud +## Start OpenCloud ```bash docker run \ @@ -67,27 +58,21 @@ docker run \ opencloudeu/opencloud-rolling:latest ``` ---- - -### 5. Login +## Login Login with your browser: - [https://localhost:9200](https://localhost:9200) -- user: **admin** -- password: **admin** +- user: admin +- password: admin Admin general ---- - -### 6. Conclusion +## Conclusion Your OpenCloud server is now running and ready to use πŸš€ ---- - -### Troubleshooting +## Troubleshooting If you encounter any issues or errors, try finding a solution here: diff --git a/docs/admin/getting-started/kubernetes.md b/docs/admin/getting-started/kubernetes.md index 72b67314..523db6d6 100644 --- a/docs/admin/getting-started/kubernetes.md +++ b/docs/admin/getting-started/kubernetes.md @@ -2,5 +2,6 @@ sidebar_position: 8 id: kubernetes title: Kubernetes -draft: true +description: Kubernetes +draft: false --- diff --git a/docs/admin/getting-started/other/bare-metal.md b/docs/admin/getting-started/other/bare-metal.md index 29a25d02..0604a942 100644 --- a/docs/admin/getting-started/other/bare-metal.md +++ b/docs/admin/getting-started/other/bare-metal.md @@ -2,10 +2,13 @@ sidebar_position: 5 id: bare-metal title: Bare-Metal -description: 'Manual, minimalist setup with essential features.' +description: Manual, minimalist setup with essential features. +draft: false --- -## User Guide for Installing OpenCloud +# Bare-Metal + +User Guide for Installing OpenCloud Bare-Metal Follow the steps below to install and configure OpenCloud on your system.
This example is on Linux Ubuntu 24.04 distribution! @@ -14,9 +17,7 @@ This example is on Linux Ubuntu 24.04 distribution! Bare-metal deployments are not officially supported by OpenCloud. They are great for quick evaluation but are undocumented and have a minimalist feature set. If you choose this setup, you are on your own. With great power comes great responsibility. ::: ---- - -### 1. Install Git and clone the repository +## Install Git and clone the repository - Open a terminal. @@ -42,9 +43,7 @@ Bare-metal deployments are not officially supported by OpenCloud. They are great git clone ---- - -### 2. Install the required packages +## Install the required packages - Download and install Go by following the official guide: πŸ”—[**go.dev/doc/install**](https://go.dev/doc/install) @@ -72,9 +71,7 @@ Bare-metal deployments are not officially supported by OpenCloud. They are great corepack enable ---- - -### 3. Build process and OpenCloud initialization +## Build process and OpenCloud initialization - Navigate to the OpenCloud directory: @@ -107,9 +104,7 @@ Bare-metal deployments are not officially supported by OpenCloud. They are great opencloud server ---- - -### 4. Login +## Login Login with your browser: @@ -119,14 +114,12 @@ Login with your browser: login ---- - -### 5. Conclusion +## Conclusion Your OpenCloud server is now running and ready to use πŸš€ ---- +## Troubleshooting -### If you encounter any issues or errors, try finding a solution here +If you encounter any issues or errors, try finding a solution here - [Common Issues & Help](./../../resources/common-issues.md) diff --git a/docs/admin/getting-started/other/raspberry-pi.md b/docs/admin/getting-started/other/raspberry-pi.md index f0405721..daeb2004 100644 --- a/docs/admin/getting-started/other/raspberry-pi.md +++ b/docs/admin/getting-started/other/raspberry-pi.md @@ -2,22 +2,24 @@ sidebar_position: 6 id: raspberry-pi title: Raspberry Pi +description: OpenCLoud on a Raspberry Pi +draft: false --- -# OpenCloud on Raspberry Pi +# OpenCloud on a Raspberry Pi :::note The installation of OpenCloud on a Raspberry Pi is intended for private or non-production use only. It is not recommended for enterprise or critical environments due to the hardware's limited resources and potential performance constraints. ::: -## 1.1 Hardware requirements +## Hardware requirements - Minimum Raspberry Pi 4B with at least 4 GB RAM connected via LAN or WLAN - Micro SD card with at least 32 GB storage space - External hard disk or USB stick (optional) for additional storage space -## 1.2 Install operating system +## Install operating system - Install Raspberry Pi OS A very detailed and understandable guide is available at: @@ -28,7 +30,7 @@ It is not recommended for enterprise or critical environments due to the hardwar - If the Raspberry Pi is to be connected to WLAN, the login data for the WLAN must be entered. -## 1.3 Connecting with SSH +## Connecting with SSH Start the Raspberry Pi with the SD card and connect via SSH. The IP for this can be viewed in your router. @@ -47,7 +49,7 @@ After the first login, you should change the password for security reasons: passwd ``` -## 1.4 Installing Docker and Docker Compose +## Installing Docker and Docker Compose Detailed installation instructions for Docker can be found here: [Install Docker on Raspberry Pi](https://pimylifeup.com/raspberry-pi-docker/) @@ -84,13 +86,13 @@ groups ${USER} sudo shutdown -r now ``` -## 1.5 Clone OpenCloud repository +## Clone OpenCloud repository ```bash git clone https://github.com/opencloud-eu/opencloud-compose.git ``` -## 1.6 Start the Docker Compose setup +## Start the Docker Compose setup ```bash cd opencloud-compose @@ -124,9 +126,9 @@ Now OpenCloud is running locally on your Raspberry Pi, and you can adjust it to We will describe how to mount an external disk or USB stick and make OpenCloud available outside the local network using No-IP. -## 1.7 Mount external hard disk or USB stick +## Mount external hard disk or USB stick -### 1. Find your external drive +### Find your external drive ```bash lsblk @@ -134,7 +136,7 @@ lsblk find the external hd -### 2. Format the drive to ext4 +### Format the drive to ext4 ```bash sudo mkfs.ext4 /dev/sda1 -L DATA @@ -142,7 +144,7 @@ sudo mkfs.ext4 /dev/sda1 -L DATA format drive -### 3. Add fstab entry for auto-mounting +### Add fstab entry for auto-mounting Open `fstab`: @@ -156,14 +158,14 @@ Add this line: LABEL=DATA /mnt/data ext4 auto,defaults 0 0 ``` -### 4. Create the mount point and set permissions +### Create the mount point and set permissions ```bash sudo mkdir -p /mnt/data sudo chown -R 1000:1000 /mnt/data ``` -### 5. Mount the drive +### Mount the drive ```bash sudo mount -a @@ -181,7 +183,7 @@ systemctl daemon-reload And try mounting again. -## 1.8 Mount external storage in Docker +## Mount external storage in Docker Stop Docker: @@ -210,15 +212,15 @@ Restart Docker: docker compose up ``` -## 1.9 Make OpenCloud externally available +## Make OpenCloud externally available -### 1. Create DynDNS hostname +### Create DynDNS hostname Register at [No-IP](https://www.noip.com/) and create a hostname, e.g. `opencloud.webhop.me`. noip hostname input -### 2. Configure DynDNS in your router +### Configure DynDNS in your router Use your router’s web interface to: @@ -230,7 +232,7 @@ Use your router’s web interface to: More help: [No-IP Support](https://www.noip.com/support/knowledgebase/how-to-configure-ddns-in-router) -### 3. Configure port forwarding +### Configure port forwarding 1. Ensure your Raspberry Pi always has the same IP address: - Either via static IP or DHCP assignment in the router @@ -244,7 +246,7 @@ More help: [No-IP Support](https://www.noip.com/support/knowledgebase/how-to-con portforwarding in router -### 4. Update OC_DOMAIN +### Update OC_DOMAIN SSH into your Pi and update the domain: diff --git a/docs/admin/getting-started/requirements.md b/docs/admin/getting-started/requirements.md index 7f874931..23177b06 100644 --- a/docs/admin/getting-started/requirements.md +++ b/docs/admin/getting-started/requirements.md @@ -2,12 +2,13 @@ sidebar_position: 1 id: requirements title: Requirements -description: 'Runs on anything from a Raspberry Pi to a data center.' +description: Runs on anything from a Raspberry Pi to a data center. +draft: false --- -| Category | Details | -| :-------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Server Operating System** | | -| **Database** | | -| **Storage** | | -| **Hardware requirements** | Minimum (Minimal bare-metal Deployment - Up to 10 Users) Medium (Deployment - Up to 1,000 Users) General: | +| Category | Details | +| :---------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Server Operating System | | +| Database | | +| Storage | | +| Hardware requirements | Minimum (Minimal bare-metal Deployment - Up to 10 Users) Medium (Deployment - Up to 1,000 Users) General: |