Skip to content

Latest commit

 

History

12 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenCloud-Radicale

Build Status Last Commit

A simple CalDAV (calendar) and CardDAV (contact) server.

Port 5232
Registry ghcr.io/daemonless/opencloud-radicale
Source https://github.com/daemonless/opencloud-radicale
Website https://radicale.org/

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-radicale:
    image: "ghcr.io/daemonless/opencloud-radicale:latest"
    container_name: opencloud-radicale
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/path/to/containers/opencloud-radicale:/config"
    ports:
      - "5232:5232"
    # 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-radicale
PUID=1000
PGID=1000
TZ=UTC

appjail-director.yml:

# appjail-director.yml

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

Makejail:

# Makejail

ARG tag=latest

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

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

Note: 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 IPv4 address assigned by the virtual network.

Podman CLI

podman run -d --name opencloud-radicale \
  -p 5232:5232 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/opencloud-radicale:/config \
  ghcr.io/daemonless/opencloud-radicale:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="5232:5232 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -o fstab="/path/to/containers/opencloud-radicale /config <pseudofs>" \
  ghcr.io/daemonless/opencloud-radicale:latest opencloud-radicale

Save as run.sh, then run sh run.sh.

Note: 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 IPv4 address assigned by the virtual network.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah, shares the host network stack (inherit), and persists image-declared volumes under --data-path.

services:
  opencloud-radicale:
    image: "ghcr.io/daemonless/opencloud-radicale:latest"
    container_name: opencloud-radicale
    network_mode: host  # jail shares host networking
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC

Save as podman-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --data-path /path/to/containers/opencloud-radicale \
  opencloud-radicale ghcr.io/daemonless/opencloud-radicale:latest inherit

Ansible

- name: Deploy opencloud-radicale
  containers.podman.podman_container:
    name: opencloud-radicale
    image: "ghcr.io/daemonless/opencloud-radicale:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "5232:5232"
    volumes:
      - "/path/to/containers/opencloud-radicale:/config"

Save as opencloud-radicale-deploy.yaml, then run ansible-playbook opencloud-radicale-deploy.yaml.

Access at: http://localhost:5232

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

Volumes

Path Description
/config Configuration and data directory

Ports

Port Protocol Description
5232 TCP Web UI

!!! WARNING "Work in Progress"

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

Intended for use with OpenCloud stack

This image can be used with OpenCloud to provide personal address books and calendars for each OpenCloud user.
The image relies on OpenCloud acting as an authenticating reverse proxy for radicale. Using it as a standalone radicale server is probably not a good idea.

Integrate with OpenCloud

To intergrate the radicale service with OpenCloud, you need to add a proxy configuration to OpenCloud. Create the file /path/to/container/opencloud/config/proxy.yaml with this content (or add the content below to your existing proxy.yaml configuration file):

additional_policies:
  - name: default
    routes:
      - endpoint: /caldav/
        backend: http://radicale:5232
        remote_user_header: X-Remote-User
        skip_x_access_token: true
        additional_headers:
          - X-Script-Name: /caldav
      - endpoint: /.well-known/caldav
        backend: http://radicale:5232
        remote_user_header: X-Remote-User
        skip_x_access_token: true
        additional_headers:
          - X-Script-Name: /caldav
      - endpoint: /carddav/
        backend: http://radicale:5232
        remote_user_header: X-Remote-User
        skip_x_access_token: true
        additional_headers:
          - X-Script-Name: /carddav
      - endpoint: /.well-known/carddav
        backend: http://radicale:5232
        remote_user_header: X-Remote-User
        skip_x_access_token: true
        additional_headers:
          - X-Script-Name: /carddav

Add the radicale service to your existing compose file for the OpenCloud stack by merging this:

services:
  opencloud:
    depends_on:
      - radicale
  radicale:
    image: ghcr.io/daemonless/opencloud-radicale:latest
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - /path/to/containers/opencloud-radicale:/config
    restart: unless-stopped

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