Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomsquest/docker-radicale
Docker image for Radicale calendar and contact server :calendar: + security :closed_lock_with_key: + addons :rocket:
https://github.com/tomsquest/docker-radicale
caldav caldav-server carddav docker docker-image radicale
Last synced: about 2 months ago
JSON representation
Docker image for Radicale calendar and contact server :calendar: + security :closed_lock_with_key: + addons :rocket:
- Host: GitHub
- URL: https://github.com/tomsquest/docker-radicale
- Owner: tomsquest
- License: gpl-3.0
- Created: 2016-10-05T15:05:07.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T04:54:48.000Z (2 months ago)
- Last Synced: 2024-10-26T18:20:39.776Z (about 2 months ago)
- Topics: caldav, caldav-server, carddav, docker, docker-image, radicale
- Language: Python
- Homepage:
- Size: 279 KB
- Stars: 581
- Watchers: 9
- Forks: 82
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Docker-Radicale
Enhanced Docker image for Radicale, the CalDAV/CardDAV server.
## Table of contents
- [Features](#features)
- [Changelog](#changelog)
- [Latest version](#latest-version)
- [Running](#running)
- [Option 1: **Basic** instruction](#option-1-basic-instruction)
- [Option 2: **Recommended, Production-grade** instruction (secured, safe...) :rocket:](#option-2-recommended-production-grade-instruction-secured-safe-rocket)
- [Custom configuration](#custom-configuration)
- [Authentication configuration](#authentication-configuration)
- [Volumes versus Bind-Mounts](#volumes-versus-bind-mounts)
- [Running with Docker compose](#running-with-docker-compose)
- [Multi-architecture](#multi-architecture)
- [Unraid](#unraid)
- [Extending the image](#extending-the-image)
- [Versioning with Git](#versioning-with-git)
- [Custom User/Group ID for the data volume](#custom-usergroup-id-for-the-data-volume)
- [Option 0: Do nothing, permission will be fixed by the container itself](#option-0-do-nothing-permission-will-be-fixed-by-the-container-itself)
- [Option 1: Create a user/group with id `2999` on the host](#option-1-create-a-usergroup-with-id-2999-on-the-host)
- [Option 2: Force the user/group ids on `docker run`](#option-2-force-the-usergroup-ids-on-docker-run)
- [Option 3: Build the image with a custom user/group](#option-3-build-the-image-with-a-custom-usergroup)
- [Tags](#tags)
- [Running with Podman](#running-with-podman)
- [Running behind Caddy](#running-behind-caddy)
- [Contributing](#contributing)
- [Releasing](#releasing)
- [Contributors](#contributors)
## Features
* :closed_lock_with_key: **Secured**: the container is read-only, with only access to its data dir, and without extraneous privileges
* :fire: **Safe**: run as a normal user (not root)
* :building_construction: **Multi-architecture**: run on amd64 and arm64
* :sparkles: **Batteries included**: git and ssh included for [versioning](https://github.com/tomsquest/docker-radicale/#versioning-with-git) and Pytz/tz-data for proper timezone handling
## Changelog
:page_with_curl: See [CHANGELOG.md](CHANGELOG.md)
## Latest version
## Running
### Option 1: **Basic** instruction
```
docker run -d --name radicale \
-p 5232:5232 \
-v ./data:/data \
tomsquest/docker-radicale
```
### Option 2: **Recommended, Production-grade** instruction (secured, safe...) :rocket:
This is the most secured instruction:
```
docker run -d --name radicale \
-p 127.0.0.1:5232:5232 \
--init \
--read-only \
--security-opt="no-new-privileges:true" \
--cap-drop ALL \
--cap-add CHOWN \
--cap-add SETUID \
--cap-add SETGID \
--cap-add KILL \
--pids-limit 50 \
--memory 256M \
--health-cmd="curl --fail http://localhost:5232 || exit 1" \
--health-interval=30s \
--health-retries=3 \
-v ./data:/data \
tomsquest/docker-radicale
```
A [Docker compose file](docker-compose.yml) is included.
Note on capabilities:
- `CHOWN` is used to restore the permission of the `data` directory. Remove this if you do not need the `chown` to be run (see [below](#volumes-versus-bind-mounts))
- `SETUID` and `SETGID` are used to run radicale as the less privileged `radicale` user (with su-exec), and are required.
- `KILL` is to allow Radicale to exit, and is required.
## Custom configuration
To customize Radicale configuration, first get the config file:
* (Recommended) use this repository preconfigured [config file](config),
* Or, use [the original Radicale config file](https://raw.githubusercontent.com/Kozea/Radicale/master/config) and:
1. set `hosts = 0.0.0.0:5232`
2. set `filesystem_folder = /data/collections`
Then:
1. create a config directory (eg. `mkdir -p /my_custom_config_directory`)
2. copy your config file into the config folder (e.g. `cp config /my_custom_config_directory/config`)
3. mount your custom config volume when running the container: `-v /my_custom_config_directory:/config:ro`.
The `:ro` at the end make the volume read-only, and is more secured.
## Authentication configuration
This section shows a basic example of configuring authentication for Radicale using htpasswd with bcrypt algorithm.
To learn more, refer to [the official Radicale document](https://radicale.org/v3.html#auth).
First, we need to configure Radicale to use htpasswd authentication and specify htpasswd file's location.
Create a `config` file inside the `config` directory (resulting in the path `config/config`).
```
[server]
hosts = 0.0.0.0:5232
[auth]
type = htpasswd
htpasswd_filename = /config/users
htpasswd_encryption = bcrypt
[storage]
filesystem_folder = /data/collections
```
Next, create a `users` file inside the `config` directory (resulting in the path `config/users`).
Each line contains the username and bcrypt-hashed password, separated by a colon (`:`).
```
john:$2a$10$l1Se4qIaRlfOnaC1pGt32uNe/Dr61r4JrZQCNnY.kTx2KgJ70GPSm
sarah:$2a$10$lKEHYHjrZ.QHpWQeB/feWe/0m4ZtckLI.cYkVOITW8/0xoLCp1/Wy
```
Finally, create and run the container using the appropriate volume mount.
In this example, both files are stored in the same directory (`./config`).
```bash
docker run -d --name radicale tomsquest/docker-radicale \
-p 5232:5232 \
-v ./data:/data \
-v ./config:/config \
```
## Volumes versus Bind-Mounts
This section is related to the error message `chown: /data: Permission denied`.
With [Docker volumes](https://docs.docker.com/storage/volumes/), and not [bind-mounts](https://docs.docker.com/storage/bind-mounts/) like shown in the examples above, you may need to disable the container trying to make the `data` directory writable.
This is done with the `TAKE_FILE_OWNERSHIP` environment variable.
The variable will tell the container to perform or skip the `chown` instruction.
The default value is `true`: the container will try to make the `data` directory writable to the `radicale` user.
To disable the `chown`, declare the variable like this:
```
docker run -d --name radicale tomsquest/docker-radicale \
-e "TAKE_FILE_OWNERSHIP=false"
```
## Running with Docker compose
A [Docker compose file](docker-compose.yml) is included.
It can also be [extended](https://docs.docker.com/compose/production/#modify-your-compose-file-for-production).
Make sure you have Docker compose version 2 or higher.
## Multi-architecture
Docker will automatically select the correct image type for your architecture, whether it is amd64 or arm64.
## Unraid
This image is compatible with Unraid, and you can find it in the [Community App store](https://unraid.net/community/apps?q=radicale#r).
## Extending the image
The image is extendable, as per Docker image architecture. You need to create your own `Dockerfile`.
For example, here is how to add [RadicaleIMAP](https://github.com/Unrud/RadicaleIMAP) (authenticate by email)
and [RadicaleInfCloud](https://www.inf-it.com/open-source/clients/infcloud/) (an alternative UI) to the image.
Please note that the [radicale-imap](https://gitlab.com/comzeradd/radicale-imap) plugin is not compatible with
Radicale 3.0 anymore!
First, create a `Dockerfile.extended` (pick the name you want) with this content:
```dockerfile
FROM tomsquest/docker-radicale
RUN /venv/bin/pip install git+https://github.com/Unrud/RadicaleIMAP
RUN /venv/bin/pip install git+https://github.com/Unrud/RadicaleInfCloud
```
Then, build and run it:
```bash
docker build -t radicale-extended -f Dockerfile.extended .
docker run --name radicale-extended -p 5232:5232 radicale-extended
```
## Versioning with Git
Radicale supports a hook which is executed after each change to the CalDAV/CardDAV files.
This hook can be used to keep a versions of your CalDAV/CardDAV files through git.
This image provides `git` to support this feature.
Refer to the [official documentation of Radicale](https://radicale.org/v3.html#versioning-with-git) for the details.
## Custom User/Group ID for the data volume
You will certainly mount a volume to keep Radicale data between restart/upgrade of the container.
But sharing files from the host and the container can be problematic.
The reason is that `radicale` user **in** the container does not match the user running the container **on** the host.
To solve this, this image offers four options (see below for details):
- Option 0: Do nothing, permission will be fixed by the container itself
- Option 1: Create a user/group with id `2999` on the host
- Option 2: Force the user/group ids on `docker run`
- Option 3: Build the image with a custom user/group
### Option 0: Do nothing, permission will be fixed by the container itself
When running the container with a /data volume (e.g. `-v ./data:/data`), the container entrypoint will automatically fix the permissions on `/data`.
This option is OK, but not optimal:
- Ok for the container, as inside the container, the `radicale` user can read and write its data
- But on the host, the data directory will then be owned by the user/group 2999:2999
### Option 1: Create a user/group with id `2999` on the host
The image creates a user and a group with id `2999` in the container.
You can create a user/group on your host matching this id.
Example:
```bash
# On your host
sudo addgroup --gid 2999 radicale
sudo adduser --gid 2999 --uid 2999 --shell /bin/false --disabled-password --no-create-home radicale
```
### Option 2: Force the user/group ids on `docker run`
The user and group ids used in the container can be overridden when the container is run.
This is done with the `UID` and `GID` env variables, e.g. `docker run -e UID=123 -e GID=456 ...`.
This will force all operations to be run with this UID/GID.
:warning: The **`--read-only`** run flag cannot be used in this case.
Using custom UID/GID tries to modify the filesystem at runtime but this is made **impossible** by the `--read-only` flag.
### Option 3: Build the image with a custom user/group
You can build the image with custom user and group ids and still use the `--read-only` flag.
But you will have to clone this repo, do a local build and keep up with changes of this image.
Usage: `docker build --build-arg=BUILD_UID=5000 --build-arg=BUILD_GID=5001 ...`.
`BUILD_UID` and `BUILD_GID` are also supported as environment variables to work around a problem on some Synology NAS. See this PR#68.
## Tags
The image is tagged with this scheme:
```
Version number = Architecture + '.' + Radicale version + '.' + This image increment number
```
Example:
- `tomsquest/docker-radicale:amd64.3.0.6.3`
- `tomsquest/docker-radicale:arm64.3.0.6.3`
The last number is **ours**, and it is incremented on new release.
For example, 2.1.11.**2** made the /config readonly (this is specific to this image).
## Running with Podman
Two users have given the instructions they used to run the image with Podman:
- [@greylinux's instructions](https://github.com/tomsquest/docker-radicale/issues/122#issuecomment-1361240992)
- [@strauss115's instructions](https://github.com/tomsquest/docker-radicale/issues/122#issuecomment-1874607285)
## Running behind Caddy
[Caddy](https://caddyserver.com) is sitting in front of all my self-hosted services, like Radicale.
It brings https and security (basic authentication).
The following Caddyfile works for me. Note that I don't use Radicale authentication, I have only one user.
```caddyfile
radicale.yourdomain.com {
reverse_proxy 127.0.0.1:5232
basicauth {
tom pas$w0rd
}
}
```
## Contributing
To run the tests:
1. `pip install pipenv`
2. `pipenv install -d`
3. `pipenv run pytest -v`
## Releasing
1. Create a Git tag, e.g. `3.0.6.0`, push it and the CI will build the images and publish them on Docker hub
2. Update the `latest` tag
3. Create release on GitHub (`Draft a new release` > pick the tag > `Generate release notes` > `Publish release`)
4. Update `CHANGELOG.md`
Example instructions :
```bash
# Update local tags
git fetch --all --tags
# Create tag
TAG=3.0.6.0 && git tag $TAG && git push origin $TAG
# Update latest tag
git push --delete origin latest && git tag -d latest && git tag latest && git push origin latest
```
## Contributors
* [Nate Harris](https://github.com/nwithan8): add image to Unraid community app store
* [SalaryTheft](https://github.com/SalaryTheft): add section about Authentication configuration
* [Dillbyrne](https://github.com/dillbyrne): update alpine
* [Jauder Ho](https://github.com/jauderho): update alpine
* [Greylinux](https://github.com/Greylinux): running with podman
* [Tionis](https://github.com/tionis): add openssh for git ssh remotes
* [flixhsw](https://github.com/flixhsw): support armv7 (Raspberry) and simplify the CI using Docker Buildx
* [hecd](https://github.com/hecd): fix to run su-exec only when the actual user is root
* [Jake Mayeux](https://github.com/jakemayeux): change "data" folder to `./data` instead of `~/radicale/data` in docker-compose.yml and doc
* [Thomas](https://github.com/symgryph): reduce image size (/root/.cache) and Alpine upgrade
* [Bernard Kerckenaere](https://github.com/bernieke): check for read-only container, and help for volumes versus bind-mounts
* [Dylan Van Assche](https://github.com/DylanVanAssche): hook to read/write to a Git repo
* [Adzero](https://github.com/adzero): override build args with environment variables
* [Robert Beal](https://github.com/robertbeal): fixed/configurable userId, versioning...
* [Loader23](https://github.com/Loader23): config volume idea
* [Waja](https://github.com/waja): fewer layers is more, InfCloud integration (UI for Radicale)
* [Christian Burmeister](https://github.com/christianbur): add tzdata to be able to specify timezone
* [Silas Lenz](https://github.com/silaslenz): add pytz for recurring events
* [Enno Richter](https://github.com/elohmeier): bcrypt support
* [Andrew u frank](https://github.com/andrewufrank): house-cleaning of whitespaces in doc
* [Marcus Kimpenhaus](https://github.com/kimpenhaus): fix for Alpine and https
* [Thomas Queste](https://github.com/tomsquest): initial image