ownCloud
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

oCIS as individual services

Overview

  • oCIS running behind Traefik as reverse proxy
  • Traefik generating self-signed certificates for local setup or obtaining valid SSL certificates for a server setup
  • oCIS running as individual services (each extension in its own containers)

Find this example on GitHub

The docker stack consists of at least 24 containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network.

The other containers are oCIS extensions, running each one in a separate container. In this example oCIS uses its internal IDP LibreGraph Connect and the oCIS storage driver. You also can start more than one container of each service by setting OCIS_SCALE to a number greater than 1. Currently this won’t scale all services, but we are working on making all service easily scalable.

Server Deployment

Requirements

  • Linux server with docker and docker-compose installed
  • Two domains set up and pointing to your server
    • ocis.* for serving oCIS
    • traefik.* for serving the Traefik dashboard

See also example server setup

Install oCIS and Traefik

  • Clone oCIS repository

    git clone https://github.com/owncloud/ocis.git

  • Go to the deployment example

    cd ocis/deployment/examples/ocis_traefik

  • Open the .env file in a text editor The file by default looks like this:

    # If you're on a internet facing server please comment out following line.
    # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates.
    INSECURE=true
    
    ### Traefik settings ###
    # Serve Traefik dashboard. Defaults to "false".
    TRAEFIK_DASHBOARD=
    # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test"
    TRAEFIK_DOMAIN=
    # Basic authentication for the dashboard. Defaults to user "admin" and password "admin"
    TRAEFIK_BASIC_AUTH_USERS=
    # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server
    TRAEFIK_ACME_MAIL=
    
    ### oCIS settings ###
    # oCIS version. Defaults to "latest"
    OCIS_DOCKER_TAG=
    # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test"
    OCIS_DOMAIN=
    # IDP LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "idp".
    IDP_LDAP_BIND_PASSWORD=
    # Storage LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "reva".
    STORAGE_LDAP_BIND_PASSWORD=
    # JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4"
    OCIS_JWT_SECRET=
    # JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret"
    STORAGE_TRANSFER_SECRET=
    # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please"
    OCIS_MACHINE_AUTH_API_KEY=
    # Number of services to run for extensions, that currently can be easily scaled. Defaults to 1.
    OCIS_SCALE=
    

    You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove INSECURE=true or set it to false.

    If you want to use the Traefik dashboard, set TRAEFIK_DASHBOARD to true (default is false and therefore not active). If you activate it, you must set a domain for the Traefik dashboard in TRAEFIK_DOMAIN= e.g. TRAEFIK_DOMAIN=traefik.owncloud.test.

    The Traefik dashboard is secured by basic auth. Default credentials are the user admin with the password admin. To set your own credentials, generate a htpasswd (e.g. by using an online tool or a cli tool).

    Traefik will issue certificates with LetsEncrypt and therefore you must set an email address in TRAEFIK_ACME_MAIL=.

    By default ocis will be started in the latest version. If you want to start a specific version of oCIS set the version to OCIS_DOCKER_TAG=. Available versions can be found on Docker Hub.

    Set your domain for the oCIS frontend in OCIS_DOMAIN=, e.g. OCIS_DOMAIN=ocis.owncloud.test.

    You also can run more than one instance of the service by setting OCIS_SCALE to number greater than one.

    Now you have configured everything and can save the file.

  • Start the docker stack

    docker-compose up -d

  • You now can visit oCIS and Traefik dashboard on your configured domains. You may need to wait some minutes until all services are fully ready, so make sure that you try to reload the pages from time to time.

Local setup

For a more simple local ocis setup see Getting started

This docker stack can also be run locally. One downside is that Traefik can not obtain valid SSL certificates and therefore will create self-signed ones. This means that your browser will show scary warnings. Another downside is that you can not point DNS entries to your localhost. So you have to add static host entries to your computer.

On Linux and macOS you can add them to your /etc/hosts file and on Windows to C:\Windows\System32\Drivers\etc\hosts file like this:

127.0.0.1 ocis.owncloud.test
127.0.0.1 traefik.owncloud.test

After that you’re ready to start the application stack:

docker-compose up -d

Open https://ocis.owncloud.test in your browser and accept the invalid certificate warning. You now can login to oCIS with the default users, which also can be found here: Getting started. You may need to wait some minutes until all services are fully ready, so make sure that you try to reload the pages from time to time.