Skip to content
daemonlessPublic

Latest commit

 

History

34 Commits

Folders and files

Repository files navigation

OpenCloud

Build Status Last Commit OCI Pulls

OpenCloud is a modern file-sync and share platform.

Port 9200
Registry ghcr.io/daemonless/opencloud
Source https://github.com/daemonless/opencloud
Website https://opencloud.eu/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

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

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

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

appjail-director.yml:

# 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
volumes:
  opencloud:
    device: '/containers/opencloud'

Makejail:

# Makejail

ARG tag=latest

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

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

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"

Save as bastille-compose.yml, then run bastille up.

Access at: http://localhost:9200

Parameters

Environment Variables

Variable Default Description
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

Path Description
/config Configuration directory

Ports

Port Protocol Description
9200 TCP Web UI

!!! warning "Work in Progress"
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:

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.

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.

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15


Need help? Join our Discord community.

Releases

Packages

Contributors

Languages