Skip to main content

Guide for local installation

Spin up a temporary local instance of OpenCloud using Docker Compose.

Prerequisites​

Download​

  • Clone the OpenCloud repository
git clone https://github.com/opencloud-eu/opencloud-compose.git

Start​

cd into the Docker Compose configuration folder​

cd opencloud-compose

Create environment file​

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.

Configure deployment options​

  • You can deploy using explicit -f flags
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
COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml
  • Set you initial admin password in the .env
INITIAL_ADMIN_PASSWORD=YOUR.SECRET.PASSWORD

This is mandatory for security reasons. Otherwise the OpenCloud container will not start​

  • Start the deployment with Docker Compose
docker compose up -d
Admin general
  • This starts all necessary containers in the background

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 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.

Accept self signed certificate

Login​

Admin general

Conclusion​

  • Your OpenCloud server is now running and ready to use

Troubleshooting​

If you encounter any issues or errors, try finding a solution here: