An open API service indexing awesome lists of open source software.

https://github.com/daemonless/opencloud

OpenCloud is a modern file-sync and share platform.
https://github.com/daemonless/opencloud

freebsd oci-image opencloud podman self-hosted

Last synced: 2 days ago
JSON representation

OpenCloud is a modern file-sync and share platform.

Awesome Lists containing this project

README

          

# OpenCloud

[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/opencloud/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/opencloud/actions)
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/opencloud?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/opencloud/commits)

OpenCloud is a modern file-sync and share platform.

| | |
|---|---|
| **Port** | 9200 |
| **Registry** | `ghcr.io/daemonless/opencloud` |
| **Source** | [https://github.com/daemonless/opencloud](https://github.com/daemonless/opencloud) |
| **Website** | [https://opencloud.eu/](https://opencloud.eu/) |

## Version Tags

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` | **Upstream Binary**. Built from official release. | Most users. Matches Linux Docker behavior. |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.

## Deployment

### Podman Compose

```yaml
services:
opencloud:
image: ghcr.io/daemonless/opencloud:latest
container_name: opencloud
environment:
- PUID=1000
- PGID=1000
- TZ=UTC
- OC_URL=https://hostname:9200
volumes:
- "/path/to/containers/opencloud:/config"
ports:
- 9200:9200
restart: unless-stopped
```

### AppJail Director

**.env**:

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

**appjail-director.yml**:

```yaml
options:
- virtualnet: ': default'
- nat:
services:
opencloud:
name: opencloud
options:
- container: 'boot args:--pull'
oci:
user: root
environment:
- PUID: !ENV '${PUID}'
- PGID: !ENV '${PGID}'
- TZ: !ENV '${TZ}'
- OC_URL: !ENV '${OC_URL}'
volumes:
- opencloud: /config
volumes:
opencloud:
device: '/path/to/containers/opencloud'
```

**Makejail**:

```
ARG tag=latest

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

### Podman CLI

```bash
podman run -d --name opencloud \
-p 9200:9200 \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=UTC \
-e OC_URL=https://hostname:9200 \
-v /path/to/containers/opencloud:/config \
ghcr.io/daemonless/opencloud:latest
```

### Ansible

```yaml
- name: Deploy opencloud
containers.podman.podman_container:
name: opencloud
image: ghcr.io/daemonless/opencloud:latest
state: started
restart_policy: always
env:
PUID: "1000"
PGID: "1000"
TZ: "UTC"
OC_URL: "https://hostname:9200"
ports:
- "9200:9200"
volumes:
- "/path/to/containers/opencloud:/config"
```

## 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](https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide#verify-configuration-changes) 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:
```yaml
services:
opencloud:
environment:
- IDM_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.
```yaml
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](https://docs.opencloud.eu/docs/next/dev/server/services/web/environment-variables).

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

---

Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.