OpenCloud

https://docs.opencloud.eu/docs/admin/
Admin
OpenCloud is a self-hosted file sharing platform that provides secure, simple, and reliable document...
Tokens:27,552
Snippets:484
Trust Score:7.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Docker

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Install Docker using the official convenience script.

```bash
curl -fsSL test.docker.com -o get-docker.sh && sh get-docker.sh  
```

--------------------------------

### Initialize environment configuration

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Create the .env file from the provided example.

```bash
cp .env.example .env  
```

--------------------------------

### Start Server

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Launches the OpenCloud server process.

```bash
./bin/opencloud server
```

--------------------------------

### Configuration Diff Output Example

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Example output showing a configuration difference and the generated patch file location.

```text
diff -u /etc/opencloud/opencloud.yaml /etc/opencloud/opencloud.yaml.tmp

--- /etc/opencloud/opencloud.yaml

+++ /etc/opencloud/opencloud.yaml.tmp

@@ -90,6 +90,9 @@

 sharing:

   events:

     tls_insecure: false

+service_account:

+  service_account_id: 00000000-0000-0000-0000-000000000000

+  service_account_secret: example-service-account-secret

 storage_users:

   events:

     tls_insecure: false

 

diff written to /etc/opencloud/opencloud.config.patch
```

```text
/etc/opencloud/opencloud.config.patch
```

--------------------------------

### Install Git

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Installs the Git version control system.

```bash
sudo apt install git
```

--------------------------------

### Start OpenCloud

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Launch the services using Docker Compose.

```bash
docker compose up  
```

--------------------------------

### Example Diff Output

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Sample output showing the differences between the existing and new configuration files.

```text
opencloud init --diff

Do you want to configure OpenCloud with certificate checking disabled?

 This is not recommended for public instances! [yes | no = default] yes

running in diff mode

diff -u /etc/opencloud/opencloud.yaml /etc/opencloud/opencloud.yaml.tmp

--- /etc/opencloud/opencloud.yaml

+++ /etc/opencloud/opencloud.yaml.tmp

@@ -3,6 +3,7 @@

 machine_auth_api_key: k55Y7i3Djeeu4aPPNzM67Q39rf3ZHz^9

 system_user_api_key: GeTXN@Mj7-4n8Yhuwb&#oq8Gb1hF7Q%^

 transfer_secret: ANy#T5.IvknED9-Ud39+YmlXzN^TdaKi

+url_signing_secret: zB#FtAYid24Z^DkuBoTllnId=igo!tCO

 system_user_id: 8cc36d34-cd87-4434-b9e2-726e5553609c

 admin_user_id: 34a73600-a02c-4064-8aec-341cd1865a71

 graph:

  

diff written to /etc/opencloud/opencloud.config.patch
```

--------------------------------

### Enable and Start Docker Service

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Configure the Docker daemon to start automatically on boot and initiate the service immediately.

```bash
systemctl enable docker && systemctl start docker
```

--------------------------------

### Initialize OpenCloud

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker

Perform the first-time setup by running the initialization command with the required volume mounts and environment variables.

```bash
docker run --rm -it \
    -v $HOME/opencloud/opencloud-config:/etc/opencloud \
    -v $HOME/opencloud/opencloud-data:/var/lib/opencloud \
    -e IDM_ADMIN_PASSWORD=admin \
    opencloudeu/opencloud-rolling:latest init  
```

--------------------------------

### Install NPM

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Installs the Node Package Manager on the system.

```bash
sudo apt install npm -y
```

--------------------------------

### Example rclone Configuration

Source: https://docs.opencloud.eu/docs/admin/maintenance/migrate

Sample configuration entries for various WebDAV-based cloud storage providers.

```ini
[opencloud-admin]
type = webdav
url = https://opencloud_url/remote.php/webdav
vendor = opencloud
owncloud_exclude_shares = true
user = admin
pass = sQOM4mn2DdR9ihRGkyAMcd50W6mniaSqSfx2qVOdBJs
description = opencloud-admin

[opencloud-alan]
type = webdav
url = https://opencloud_url/remote.php/webdav
vendor = opencloud
owncloud_exclude_shares = true
user = alan
pass = sQOM4mn2DdR9ihRGkyAMcd50W6mniaSqSfx2qVOdBJs
description = opencloud-alan

[ocis-admin]
type = webdav
url = https://ocis_url/remote.php/webdav
vendor = ocis
owncloud_exclude_shares = true
user = admin
pass = Sav5354nRTgBHyItQeCZp9tCBidX2BxbuMx_dDLwxqs
description = ocis-admin

[ocis-einstein]
type = webdav
url = https://ocis_url/remote.php/webdav
vendor = ocis-einstein
owncloud_exclude_shares = true
user = einstein
pass = dcYsf3PNvBxaIi7MMq-bqg74KMWWWS8p3uFT-WD17SA
description = ocis-einstein

[nc-admin]
type = webdav
url = http://nc_url/remote.php/webdav
vendor = nc
owncloud_exclude_shares = true
user = admin
pass = IBSkhC1wCDdS2Gt9iBV-C9IqlGek
description = nc-admin

[nc-bob]
type = webdav
url = http://localhost:8080/remote.php/webdav
vendor = nc-bob
owncloud_exclude_shares = true
user = bob
pass = ufOK3zPDjR4meEwwy3cWUVA18Lf8TpubBRyPL5m9KC508PkMiEVAXTxg6olu
description = nc-bob
```

--------------------------------

### Install OpenCloud via Shell

Source: https://docs.opencloud.eu/docs/admin

Executes the automated installation script for OpenCloud. Requires root or sudo privileges on the target system.

```bash
curl -L https://opencloud.eu/install | /bin/bash
```

--------------------------------

### Set compose file configuration

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Uncomment the line to activate the minimal OpenCloud setup.

```text
COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml  
```

--------------------------------

### Install Corepack

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Installs corepack globally to manage package managers.

```bash
sudo npm install -g corepack
```

--------------------------------

### Open Temporary Container for Configuration

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Start a temporary container to inspect or modify configuration files.

```bash
docker run --rm -it --entrypoint /bin/sh -v "<opencloud-config-volume>:/etc/opencloud" opencloudeu/opencloud (or opencloud-rolling):"version-tag"
```

```bash
docker run --rm -it --entrypoint /bin/sh -v "<path-to-your-config-directory>:/etc/opencloud" opencloudeu/opencloud (or opencloud-rolling):"version-tag"
```

--------------------------------

### Deploy Radicale via command line

Source: https://docs.opencloud.eu/docs/admin/configuration/radicale-integration

Alternative method to start the Radicale container using the docker compose command.

```bash
docker compose -f docker-compose.yml -f traefik/opencloud.yml -f radicale/radicale.yml up
```

--------------------------------

### Install Microsoft Core Fonts

Source: https://docs.opencloud.eu/docs/admin/configuration/collabora/collabora-fonts

Install the ttf-mscorefonts-installer package to add common fonts like Arial.

```bash
apt install ttf-mscorefonts-installer  
```

--------------------------------

### Run OpenCloud with Docker

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Starts an OpenCloud container with specific volume mounts and environment variables.

```bash
docker run \
--name opencloud \
--rm \
-it \
-p 9200:9200 \
-v $HOME/opencloud/opencloud-config:/etc/opencloud \
-v $HOME/opencloud/opencloud-data:/var/lib/opencloud \
-e OC_INSECURE=true \
-e PROXY_HTTP_ADDR=0.0.0.0:9200 \
-e OC_URL=https://localhost:9200 \
opencloudeu/opencloud-rolling:{tag}
```

--------------------------------

### Example subordinate ID output

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-volume-permissions

Sample output showing the mapping range for a user.

```text
youruser:100000:65536  

youruser:100000:65536  
```

--------------------------------

### Start Services with Decomposeds3 Configuration

Source: https://docs.opencloud.eu/docs/admin/configuration/storage/storage-decomposeds3

Include the decomposeds3.yml file in the Docker Compose startup command to apply the storage configuration.

```bash
docker compose -f docker-compose.yml -f storage/decomposeds3.yml up  
```

--------------------------------

### Open temporary container for migration

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-7.x.x

Starts a temporary container to access the configuration directory for migration tasks.

```bash
docker run --rm -it --entrypoint /bin/sh -v "<opencloud-config-volume>:/etc/opencloud" opencloudeu/opencloud:7.x.x  

```

```bash
docker run --rm -it --entrypoint /bin/sh -v "<path-to-your-config-directory>:/etc/opencloud" opencloudeu/opencloud:7.x.x  

```

--------------------------------

### Identify Permission Denied Errors

Source: https://docs.opencloud.eu/docs/admin/resources/common-issues

Example log output indicating a failure to create storage directories due to insufficient permissions.

```text
opencloud-1 | {"level":"fatal","service":"nats","time":"2025-04-08T09:59:59Z","line":"github.com/opencloud-eu/opencloud/services/nats/pkg/logging/nats.go:33","message":"Can't start JetStream: could not create storage directory - mkdir /var/lib/opencloud/nats: permission denied"}  
```

--------------------------------

### LDAP Directory Structure Example

Source: https://docs.opencloud.eu/docs/admin/configuration/authentication-and-user-management/keycloak

A visual representation of the required LDAP organizational units for users and groups.

```text

dc=example,dc=org              # Base DN  

├── ou=users                   # User organizational unit  

│   ├── uid=user1              # User entries  

│   └── uid=user2  

└── ou=groups                  # Group organizational unit  

    ├── cn=admins              # Group entries  

    ├── cn=users  

    └── ou=custom (optional)   # Optional custom groups tree, writable by OpenCloud  

        ├── cn=teamA           # Custom Group entries  

        └── cn=teamB  


```

--------------------------------

### Start OpenCloud Container

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker

Launch the OpenCloud container in detached mode with port mapping and necessary environment configurations.

```bash
docker run \
    --name opencloud \
    --rm \
    -d \
    -p 9200:9200 \
    -v $HOME/opencloud/opencloud-config:/etc/opencloud \
    -v $HOME/opencloud/opencloud-data:/var/lib/opencloud \
    -e OC_INSECURE=true \
    -e PROXY_HTTP_ADDR=0.0.0.0:9200 \
    -e OC_URL=https://localhost:9200 \
    opencloudeu/opencloud-rolling:latest  
```

--------------------------------

### Start Docker Compose with specific project name

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Ensures network and volume compatibility by specifying the original project name during startup.

```bash
docker compose -p opencloud_full up -d
```

--------------------------------

### Start Containers in Background

Source: https://docs.opencloud.eu/docs/admin/configuration/storage/storage-decomposeds3

Run the Docker Compose services in detached mode.

```bash
docker compose up -d  
```

--------------------------------

### Update system packages

Source: https://docs.opencloud.eu/docs/admin/configuration/collabora/collabora-fonts

Ensure system package lists are current before installing new software.

```bash
apt update  
```

--------------------------------

### Enable Impersonation via Environment Variable

Source: https://docs.opencloud.eu/docs/admin/maintenance/migrate

Set this environment variable before starting the server to allow user token generation.

```bash
AUTH_APP_ENABLE_IMPERSONATION=true
```

--------------------------------

### Define role_quotas in proxy.yaml

Source: https://docs.opencloud.eu/docs/admin/configuration/default-user-quota

Example configuration for assigning a 1 GiB quota to a specific user role.

```yaml
role_quotas:  

  'd7beeea8-8ff4-406b-8fb6-ab2dd81e6b11': 1073741824
```

--------------------------------

### Configure COMPOSE_FILE for Proxy Setup

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Select the appropriate COMPOSE_FILE configuration based on whether the reverse proxy is local or remote.

```bash
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:external-proxy/opencloud.yml:external-proxy/collabora.yml
```

```bash
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:external-proxy/opencloud-exposed.yml:external-proxy/collabora-exposed.yml
```

--------------------------------

### Generate SSL Certificate for Euro Office

Source: https://docs.opencloud.eu/docs/admin/configuration/euro-office

Use Certbot to include the Euro Office domain in your existing SSL certificate setup.

```bash
sudo certbot certonly --webroot \  

  -w /var/www/certbot \  

  -d euro-office.YOUR.DOMAIN \  

  --email your@email.com \  

  --agree-tos \  

  --no-eff-email  


```

--------------------------------

### Restart Collabora service

Source: https://docs.opencloud.eu/docs/admin/configuration/collabora/collabora-fonts

Restart the docker-compose setup to make newly installed fonts available in Collabora.

```bash
docker compose restart  
```

--------------------------------

### Create Environment File

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Initialize the .env file using the provided template.

```bash
cp .env.example .env
```

--------------------------------

### Clone and Initialize OpenCloud Repository

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Prepare the environment by cloning the repository and creating the .env file.

```bash
git clone https://github.com/opencloud-eu/opencloud-compose.git
cd opencloud-compose
cp .env.example .env
nano .env
```

--------------------------------

### Create mount point and set permissions

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Prepare the directory and set ownership for the OpenCloud user.

```bash
sudo mkdir -p /mnt/data  

sudo chown -R 1000:1000 /mnt/data  
```

--------------------------------

### Create Required Directories

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker

Prepare the host machine directories for bind mounts to persist configuration and data.

```bash
mkdir -p $HOME/opencloud/opencloud-config  

mkdir -p $HOME/opencloud/opencloud-data  
```

--------------------------------

### Set recommended host permissions

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-volume-permissions

Create directories and assign ownership to UID/GID 1000 on the host.

```bash
sudo mkdir -p /your/local/path/opencloud/{config,data}  

sudo chown -R 1000:1000 /your/local/path/opencloud  

sudo chmod -R 0700 /your/local/path/opencloud  
```

--------------------------------

### Backup Configuration and Data via Bind Mounts

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Create a backup of host directories used for configuration and data storage.

```bash
cp -a /mnt/opencloud/config /mnt/opencloud/config-backup

cp -a /mnt/opencloud/data /mnt/opencloud/data-backup
```

--------------------------------

### Open the .env file

Source: https://docs.opencloud.eu/docs/admin/configuration/frontend-check-updates

Access the environment configuration file using the nano text editor.

```bash
nano opencloud-compose/.env
```

--------------------------------

### Create Backup Directory

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Prepare a local directory to store container backups.

```bash
mkdir -p ~/opencloud-backups  
```

--------------------------------

### Add Local DNS Entry for Testing

Source: https://docs.opencloud.eu/docs/admin/configuration/euro-office

Map the Euro Office domain to localhost in your /etc/hosts file for local development.

```bash
127.0.0.1 euro-office.opencloud.test  


```

--------------------------------

### Navigate to Configuration Folder

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Change the working directory to the cloned repository folder.

```bash
cd opencloud-compose
```

--------------------------------

### Initialize OpenCloud

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Initializes the server with insecure mode enabled and sets the admin password.

```bash
./bin/opencloud init --insecure true --admin-password admin
```

--------------------------------

### Update System Packages

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Updates the local package index and upgrades installed packages to the latest versions.

```bash
sudo apt update && apt upgrade
```

--------------------------------

### Enable notifications service

Source: https://docs.opencloud.eu/docs/admin/configuration/mail-notifications

Add the notifications service to the startup configuration in the .env file.

```text
START_ADDITIONAL_SERVICES="notifications"
```

--------------------------------

### Create Certbot Webroot Directory

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Prepare the directory structure required for the Certbot webroot challenge.

```bash
sudo mkdir -p /var/www/certbot  

sudo chown -R www-data:www-data /var/www/certbot  
```

--------------------------------

### Create Nginx Challenge Configuration

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Open the configuration file for the HTTP challenge.

```bash
sudo nano /etc/nginx/sites-available/certbot-challenge  
```

--------------------------------

### Enable Nginx Configuration

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Link the configuration file and reload Nginx to apply changes.

```bash
sudo ln -s /etc/nginx/sites-available/certbot-challenge /etc/nginx/sites-enabled/certbot-challenge  

sudo nginx -t && sudo systemctl reload nginx  
```

--------------------------------

### Configure directory permissions

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-production-considerations

Create the required directories and set ownership to UID/GID 1000 to ensure the container can access the host volumes.

```bash
sudo mkdir -p /your/local/path/opencloud/{config,data}

sudo chown -R 1000:1000 /your/local/path/opencloud

sudo chmod -R 0700 /your/local/path/opencloud
```

--------------------------------

### Generate Configuration Diff

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Run the initialization command to check for configuration updates.

```bash
opencloud init --diff
```

--------------------------------

### Log output for LDAP Result Code 49

Source: https://docs.opencloud.eu/docs/admin/resources/common-issues

Example log entries indicating a bind failure due to credential mismatch between the IDM service and the directory backend.

```json
opencloud-1 | {"level":"error","service":"idm","bind_dn":"uid=idp,ou=sysusers,o=libregraph-idm","op":"bind","message":"not found"}  

opencloud-1 | {"level":"error","service":"idp","error":"ldap identifier backend logon connect error: LDAP Result Code 49 \"Invalid Credentials\": ","message":"identifier failed to logon with backend"}  
```

--------------------------------

### Set Deployment Components

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Configure the COMPOSE_FILE variable to select which components to deploy.

```bash
COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml
```

```bash
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml:radicale/radicale.yml
```

--------------------------------

### Navigate to Directory

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Changes the current working directory to the OpenCloud project folder.

```bash
cd opencloud
```

--------------------------------

### Enable and reload Nginx

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Creates a symbolic link to enable the site configuration, tests the configuration syntax, and reloads the Nginx service.

```bash
sudo ln -s /etc/nginx/sites-available/opencloud /etc/nginx/sites-enabled/opencloud  

sudo nginx -t && sudo systemctl reload nginx
```

--------------------------------

### Navigate to deployment directory

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-keycloak-deployment

Commands to access the OpenCloud compose directory and edit the environment file.

```bash
cd opencloud-compose  

nano .env  
```

--------------------------------

### Create new proxy configuration file

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Opens a new Nginx configuration file for editing.

```bash
sudo nano /etc/nginx/sites-available/opencloud
```

--------------------------------

### Configure Domain Names

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Set the domain names for Traefik, OpenCloud, and Collabora services.

```bash
TRAEFIK_DOMAIN=traefik.YOUR.DOMAIN

OC_DOMAIN=cloud.YOUR.DOMAIN

COLLABORA_DOMAIN=collabora.YOUR.DOMAINƒ
```

--------------------------------

### Apply Configuration Patch

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Commands to navigate to the configuration directory, verify the patch file, and apply it.

```bash
cd /etc/opencloud
```

```bash
ls
```

```text
banned-password-list.txt

csp.yaml

opencloud.config.patch

opencloud.yaml

opencloud.yaml.2026-05-19-15-45-44.backup
```

```bash
patch --dry-run opencloud.yaml < opencloud.config.patch
```

```text
checking file opencloud.yaml
```

```bash
patch opencloud.yaml < opencloud.config.patch
```

```text
patching file opencloud.yaml
```

--------------------------------

### Open .env file with nano

Source: https://docs.opencloud.eu/docs/admin/configuration/mail-notifications

Use the nano text editor to modify the OpenCloud configuration file.

```bash
nano .env
```

--------------------------------

### Update deployment

Source: https://docs.opencloud.eu/docs/admin/configuration/radicale-integration

Apply the configuration changes to launch the Radicale container.

```bash
docker compose up -d
```

--------------------------------

### Navigate to IDM Directory

Source: https://docs.opencloud.eu/docs/admin/resources/common-issues

Change the working directory to the IDM configuration folder.

```bash
cd .opencloud/idm
```

--------------------------------

### Configure app-registry.yaml for MS-Office formats

Source: https://docs.opencloud.eu/docs/admin/configuration/collabora/collabora-ms-office-formats

Define the mime types and creation permissions for Office documents in the app-registry.yaml file.

```yaml
app_registry:
  mimetypes:
    - mime_type: application/pdf
      extension: pdf
      name: PDF
      description: PDF document
      icon: ''
      default_app: ''
      allow_creation: false
    - mime_type: application/vnd.oasis.opendocument.text
      extension: odt
      name: Document
      description: OpenDocument text document
      icon: ''
      default_app: Collabora
      allow_creation: true
    - mime_type: application/vnd.oasis.opendocument.spreadsheet
      extension: ods
      name: Spreadsheet
      description: OpenDocument spreadsheet document
      icon: ''
      default_app: Collabora
      allow_creation: true
    - mime_type: application/vnd.oasis.opendocument.presentation
      extension: odp
      name: Presentation
      description: OpenDocument presentation document
      icon: ''
      default_app: Collabora
      allow_creation: true
    - mime_type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
      extension: docx
      name: Microsoft Word
      description: Microsoft Word document
      icon: ''
      default_app: Collabora
      allow_creation: true
    - mime_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
      extension: xlsx
      name: Microsoft Excel
      description: Microsoft Excel document
      icon: ''
      default_app: Collabora
      allow_creation: true
    - mime_type: application/vnd.openxmlformats-officedocument.presentationml.presentation
      extension: pptx
      name: Microsoft PowerPoint
      description: Microsoft PowerPoint document
      icon: ''
      default_app: Collabora
      allow_creation: true
```

--------------------------------

### Build OpenCloud

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Cleans previous builds, generates necessary files, and compiles the project.

```bash
make clean generate

make -C opencloud build
```

--------------------------------

### Configure Keycloak and OpenCloud Environment Variables

Source: https://docs.opencloud.eu/docs/admin/configuration/authentication-and-user-management/keycloak

Set these environment variables to configure Keycloak, OIDC, and LDAP integration for autoprovisioning mode.

```bash
# Basic Keycloak configuration  

KEYCLOAK_DOMAIN=keycloak.example.org  

KEYCLOAK_REALM=openCloud  

  

# OpenCloud OIDC configuration  

OC_OIDC_ISSUER=https://${KEYCLOAK_DOMAIN:-keycloak.opencloud.test}/realms/${KEYCLOAK_REALM:-openCloud}  

WEB_OPTION_ACCOUNT_EDIT_LINK_HREF=https://${KEYCLOAK_DOMAIN:-keycloak.opencloud.test}/realms/${KEYCLOAK_REALM:-openCloud}/account  

PROXY_OIDC_REWRITE_WELLKNOWN=true  

PROXY_USER_OIDC_CLAIM=sub  

PROXY_AUTOPROVISION_CLAIM_USERNAME=sub  

PROXY_USER_CS3_CLAIM=username  

# admin and demo accounts must be created in Keycloak  

OC_ADMIN_USER_ID=""  

SETTINGS_SETUP_DEFAULT_ASSIGNMENTS=false  

GRAPH_ASSIGN_DEFAULT_USER_ROLE=false  

GRAPH_USERNAME_MATCH=none  

  

# OpenCloud LDAP configuration  

OC_LDAP_URI=ldaps://ldap-server:1636  

OC_LDAP_SERVER_WRITE_ENABLED=true  

# Disable non writable attributes in the OpenCloud Admin UI  

FRONTEND_READONLY_USER_ATTRIBUTES="user.onPremisesSamAccountName,user.displayName,user.mail,user.passwordProfile,user.memberOf"  

OC_LDAP_INSECURE=true  

OC_LDAP_BIND_DN=cn=admin,dc=opencloud,dc=eu  

OC_LDAP_BIND_PASSWORD=admin-password  

OC_LDAP_USER_BASE_DN=ou=users,dc=opencloud,dc=eu  

OC_LDAP_DISABLE_USER_MECHANISM=none  

OC_LDAP_GROUP_BASE_DN=ou=groups,dc=opencloud,dc=eu  
```

--------------------------------

### Define persistent storage paths

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-production-considerations

Set the environment variables for configuration and data directories in your .env file.

```text
OC_CONFIG_DIR=/your/local/path/opencloud/config

OC_DATA_DIR=/your/local/path/opencloud/data
```

--------------------------------

### Set initial admin password

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Define the admin password in the configuration.

```text
INITIAL_ADMIN_PASSWORD=YourSecurePassword  
```

--------------------------------

### Define Environment Variables

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Set the required domain and password variables in your .env file.

```bash
# INSECURE=true

OC_DOMAIN=cloud.YOUR.DOMAIN

INITIAL_ADMIN_PASSWORD=YOUR.SECRET.PASSWORD

COLLABORA_DOMAIN=collabora.YOUR.DOMAIN
```

--------------------------------

### Configure Let's Encrypt Staging

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Set the ACME server to the Let's Encrypt staging environment for testing purposes.

```bash
TRAEFIK_ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory
```

--------------------------------

### Set Admin Password

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Define the initial administrator password for the deployment.

```bash
INITIAL_ADMIN_PASSWORD=YourSecurePassword
```

--------------------------------

### Backup Container Data and Config

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Copy files from a running container to the local backup directory.

```bash
docker cp opencloud_full-opencloud-1:/var/lib/opencloud ~/opencloud-backups/data-backup  

docker cp opencloud_full-opencloud-1:/etc/opencloud ~/opencloud-backups/config-backup  
```

--------------------------------

### Verify Configuration Changes

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Commands to inspect configuration files inside the container using host directories or named volumes.

```bash
docker run --rm -it --entrypoint /bin/sh -v <your-home-directory>/opencloud/opencloud-config:/etc/opencloud opencloudeu/opencloud:4.0.x
```

```bash
docker run --rm -it --entrypoint /bin/sh \

  -v <your-named-volume>:/etc/opencloud \

  opencloudeu/opencloud:4.0.x
```

--------------------------------

### Configure OpenCloud Services

Source: https://docs.opencloud.eu/docs/admin/maintenance/migrate

Modify the .env file to enable the auth-app service for OpenCloud.

```bash
START_ADDITIONAL_SERVICES="auth-app"
```

```bash
PROXY_ENABLE_APP_AUTH="true"
```

--------------------------------

### Add fstab entry

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Add the mount configuration line to fstab.

```text
LABEL=DATA /mnt/data ext4 auto,defaults 0 0  
```

--------------------------------

### Backup Configuration and Data via Named Volumes

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Copy configuration and data from a running container to a local backup directory.

```bash
mkdir -p ~/opencloud-backups

docker cp opencloud-compose-opencloud-1:/etc/opencloud ~/opencloud-backups/config-backup

docker cp opencloud-compose-opencloud-1:/var/lib/opencloud ~/opencloud-backups/data-backup
```

--------------------------------

### Configure Keycloak environment variables

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-keycloak-deployment

Required environment variables to enable Keycloak and set administrative credentials in the .env file.

```bash
# Enable Keycloak + LDAP services  

COMPOSE_FILE=docker-compose.yml:idm/ldap-keycloak.yml:traefik/opencloud.yml:traefik/ldap-keycloak.yml  

  

# Keycloak domain (without https://)  

KEYCLOAK_DOMAIN=keycloak.YOUR.DOMAIN  

  

# Keycloak admin credentials  

KEYCLOAK_ADMIN=admin  

KEYCLOAK_ADMIN_PASSWORD=ChangeMeToASecurePassword  
```

--------------------------------

### Connect to Server via SSH

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Establish a remote connection to the server using root access.

```bash
ssh root@YOUR.SERVER.IP
```

--------------------------------

### Set data directory variable

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Configure the storage path in the environment file.

```text
OC_DATA_DIR=/mnt/data  
```

--------------------------------

### Configure OpenCloud OIDC Client Scopes

Source: https://docs.opencloud.eu/docs/admin/configuration/authentication-and-user-management/keycloak

Environment variables to define OIDC scopes for different OpenCloud client types.

```bash
WEBFINGER_WEB_OIDC_CLIENT_SCOPES=openid profile email  

WEBFINGER_ANDROID_OIDC_CLIENT_SCOPES=openid profile email offline_access  

WEBFINGER_IOS_OIDC_CLIENT_SCOPES=openid profile email offline_access  

WEBFINGER_DESKTOP_OIDC_CLIENT_SCOPES=openid profile email offline_access  
```

--------------------------------

### Edit fstab

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Open the fstab file to configure auto-mounting.

```bash
sudo nano /etc/fstab  
```

--------------------------------

### Enable PNPM

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Enables pnpm using the corepack utility.

```bash
corepack enable pnpm
```

--------------------------------

### List Docker Volumes

Source: https://docs.opencloud.eu/docs/admin/resources/common-issues

Identify the correct volume names for data and configuration paths.

```bash
docker volume ls
```

--------------------------------

### Manage upload sessions

Source: https://docs.opencloud.eu/docs/admin/maintenance/maintenance-commands

Commands to list, clean, and resume upload sessions.

```bash
opencloud storage-users uploads sessions
```

```bash
opencloud storage-users uploads sessions --expired=false --processing=false
```

```bash
opencloud storage-users uploads sessions --expired=false --processing=false --json
```

```bash
opencloud storage-users uploads sessions --expired=true
```

```bash
opencloud storage-users uploads sessions --expired=true --clean
```

```bash
opencloud storage-users uploads sessions --processing=false --has-virus=false --resume
```

```bash
opencloud storage-users uploads sessions --processing=false --has-virus=false --restart
```

--------------------------------

### Connect to Server via SSH

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Establish a remote connection to the server using SSH.

```bash
ssh root@YOUR.SERVER.IP  
```

--------------------------------

### Monitor Keycloak logs

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-keycloak-deployment

Command to view logs for the Keycloak container to verify initialization status.

```bash
docker compose logs keycloak  
```

--------------------------------

### Verify Configuration Entries

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Verify that the required configuration entries exist in the file.

```yaml
service_account:

  service_account_id: 00000000-0000-0000-0000-000000000000

  service_account_secret: example-service-account-secret
```

--------------------------------

### Configure Radicale in .env

Source: https://docs.opencloud.eu/docs/admin/configuration/radicale-integration

Add the radicale component to the COMPOSE_FILE variable in your .env file.

```bash
COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml:radicale/radicale.yml
```

--------------------------------

### Format drive

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Format the specified drive to ext4 with a label.

```bash
sudo mkfs.ext4 /dev/sda1 -L DATA  
```

--------------------------------

### Enable PosixFS Collaborative Mode

Source: https://docs.opencloud.eu/docs/admin/configuration/storage/storage-posix

Set this environment variable to enable real-time file system monitoring for local file systems like XFS and ext4.

```bash
STORAGE_USERS_POSIX_WATCH_FS=true
```

--------------------------------

### List block devices

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Identify the external drive path.

```bash
lsblk  
```

--------------------------------

### Mount drives

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Mount all filesystems defined in fstab.

```bash
sudo mount -a  
```

--------------------------------

### Configure OpenCloud OIDC Client IDs

Source: https://docs.opencloud.eu/docs/admin/configuration/authentication-and-user-management/keycloak

Environment variables to define custom OIDC client IDs for different OpenCloud client types.

```bash
WEBFINGER_WEB_OIDC_CLIENT_ID=web  

WEBFINGER_ANDROID_OIDC_CLIENT_ID=OpenCloudAndroid  

WEBFINGER_IOS_OIDC_CLIENT_ID=OpenCloudIOS  

WEBFINGER_DESKTOP_OIDC_CLIENT_ID=OpenCloudDesktop  
```

--------------------------------

### Edit Environment Configuration

Source: https://docs.opencloud.eu/docs/admin/configuration/storage/storage-decomposeds3

Open the .env file to modify the required configuration variables for the storage driver.

```bash
nano .env  
```

--------------------------------

### Configure Docker Compose for Autoprovisioning Mode

Source: https://docs.opencloud.eu/docs/admin/configuration/authentication-and-user-management/keycloak

Update the .env file in the opencloud-compose repository to enable autoprovisioning mode services.

```bash
# Enable services  

COMPOSE_FILE=docker-compose.yml:idm/external-idp.yml:traefik/opencloud.yml  

# Your public keycloak domain without protocol  

IDP_DOMAIN=your-idp-domain.example.com  

# The openCloud users need to be able to edit their account in the external IdP  

IDP_ACCOUNT_URL=https://your-idp-domain.example.com/realms/openCloud/account  
```

--------------------------------

### Configure persistent project name

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Sets the project name in the .env file to avoid manual flags in future commands.

```text
COMPOSE_PROJECT_NAME=opencloud_full
```

--------------------------------

### Configure Docker Compose for Euro Office

Source: https://docs.opencloud.eu/docs/admin/configuration/euro-office

Set these variables in your .env file to define the compose modules and security credentials for your deployment.

```bash
COMPOSE_FILE=docker-compose.yml:weboffice/euroffice.yml:traefik/opencloud.yml:traefik/euroffice.yml  

  

EURO_OFFICE_DOMAIN=euro-office.YOUR.DOMAIN  

EURO_OFFICE_JWT_SECRET=YOUR.SECRET  


```

```bash
COMPOSE_FILE=docker-compose.yml:weboffice/euroffice.yml:external-proxy/opencloud.yml:external-proxy/euroffice.yml  

  

EURO_OFFICE_DOMAIN=euro-office.YOUR.DOMAIN  

EURO_OFFICE_JWT_SECRET=YOUR.SECRET  


```

--------------------------------

### Verify Staging Certificate URL

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Access the domain to verify that the Let's Encrypt staging certificate is being served.

```text
https://cloud.YOUR.DOMAIN
```

--------------------------------

### Clone OpenCloud Compose Repository

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Commands to clone the official repository and navigate into the directory.

```bash
git clone https://github.com/opencloud-eu/opencloud-compose.git

cd opencloud-compose
```

--------------------------------

### Clone Repository

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Downloads the OpenCloud source code from the official GitHub repository.

```bash
git clone https://github.com/opencloud-eu/opencloud.git
```

--------------------------------

### Configure Sharing Service Log Level

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-7.x.x

Environment variables to set the sharing service log level to info for monitoring migration progress.

```bash
OC_LOG_LEVEL=info
```

```bash
SHARING_LOG_LEVEL=info
```

--------------------------------

### Configure WebFinger client discovery variables

Source: https://docs.opencloud.eu/docs/admin/configuration/authentication-and-user-management/external-idp

Define client IDs and scopes for various OpenCloud clients. These variables are used by the WebFinger service for OIDC discovery.

```bash
WEBFINGER_WEB_OIDC_CLIENT_ID=web  

WEBFINGER_WEB_OIDC_CLIENT_SCOPES=openid profile email  

  

WEBFINGER_ANDROID_OIDC_CLIENT_ID=OpenCloudAndroid  

WEBFINGER_ANDROID_OIDC_CLIENT_SCOPES=openid profile email offline_access  

  

WEBFINGER_IOS_OIDC_CLIENT_ID=OpenCloudIOS  

WEBFINGER_IOS_OIDC_CLIENT_SCOPES=openid profile email offline_access  

  

WEBFINGER_DESKTOP_OIDC_CLIENT_ID=OpenCloudDesktop  

WEBFINGER_DESKTOP_OIDC_CLIENT_SCOPES=openid profile email offline_access  
```

--------------------------------

### Restart Docker services

Source: https://docs.opencloud.eu/docs/admin/configuration/default-language

Apply configuration changes by shutting down and restarting the Docker containers.

```bash
docker compose down  

docker compose up -d
```

--------------------------------

### Edit proxy.yaml configuration file

Source: https://docs.opencloud.eu/docs/admin/configuration/default-user-quota

Command to open the proxy configuration file for editing.

```bash
nano opencloud-compose/config/opencloud/proxy.yaml
```

--------------------------------

### Check Docker Compose Logs

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Command to view logs for troubleshooting container issues.

```bash
docker compose logs
```
Tokens:
Raw