OpenCloud

OpenCloud is a modern file-sync and share platform.

Version Tags

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

services:
  opencloud:
    image: "ghcr.io/daemonless/opencloud:latest"
    container_name: opencloud
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - OC_URL=https://hostname:9200  # URL where OpenCloud can be accessed
    volumes:
      - "/containers/opencloud:/config"
    ports:
      - "9200:9200"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

1
2
3
4
5
6
7

# .env

DIRECTOR_PROJECT=opencloud
PUID=1000
PGID=1000
TZ=UTC
OC_URL=https://hostname:9200

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  opencloud:
    name: opencloud
    options:
      - container: 'args:--pull'
      - expose: '9200:9200 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - OC_URL: !ENV '${OC_URL}'
    volumes:
      - OPENCLOUD_CONFIG_PATH: /config
volumes:
  OPENCLOUD_CONFIG_PATH:
    device: '/containers/opencloud'

1
2
3
4
5
6
7

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/opencloud:${tag}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

services:
  opencloud:
    name: opencloud
    image: "ghcr.io/daemonless/opencloud:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - OC_URL=https://hostname:9200
    volumes:
      - "/containers/opencloud:/config"

Access at: http://localhost:9200

Interactive Configuration

Parameters

Environment Variables

Volumes

Ports

This image is functional but may change significantly in a future release.

Breaking changes

untagged -> 0.1.0

• config and data directories moved from /config/.opencloud to /config
  Existing data will be moved automatically during container initialization.

Upgrade from 6.2.0 to 7.0.0

The upgrade requires a change to the configuration of the "sharing" service. Please follow the steps outlined in the Upgrade Guide to achieve that.

First run

OpenCloud generates a default config with insecure settings (no TLS validation) on first start or if the file /config/config/opencloud.yaml does not exist.

You can define the inital password for the admin user by setting the environment variable IDM_ADMIN_PASSWORD like this:

1
2
3
4

services:
  opencloud:
    environment:
      - IDM_ADMIN_PASSWORD=<your_admin_password>

If you do not set the password with the variable above, OpenCloud generates a random password for the admin user and you can find it in the logs or in the file /config/config/opencloud.yaml.

Remarks

So far I have only tested this image with bridge networking.
You may need to add an extra_host to your compose file to allow opencloud to connect to it's internal IDP. That is at least what I had to do.

1
2
3
4

services:
  opencloud:
    extra_hosts:
      - "host-hostname:127.0.0.1"

Additional environment variables

To configure OpenCloud further, you can check out the list of environment variables.

Need help? Join our Discord community.