mash-playbook/docs/services/radicale.md

52 lines
1.9 KiB
Markdown
Raw Normal View History

2023-03-15 09:58:12 +01:00
# Radicale
[Radicale](https://radicale.org/) is a Free and Open-Source CalDAV and CardDAV Server (solution for hosting contacts and calendars).
## Dependencies
This service requires the following other services:
- a [Traefik](traefik.md) reverse-proxy server
## Configuration
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
```yaml
########################################################################
# #
# radicale #
# #
########################################################################
radicale_enabled: true
radicale_hostname: mash.example.com
radicale_path_prefix: /radicale
radicale_credentials:
- username: someone
password: secret-password
- username: another
password: more-secret-password
########################################################################
# #
# /radicale #
# #
########################################################################
```
In the example configuration above, we configure the service to be hosted at `https://mash.example.com/radicale`.
You can remove the `radicale_path_prefix` variable definition, to make it default to `/`, so that the service is served at `https://mash.example.com/`.
## Usage
After installation, you can log in with your credentials (see the `radicale_credentials` configuration variable).
Creating new users requires changing the `radicale_credentials` variable and [re-running the playbook](../installing.md). You can rebuild only this service quickly by running: `just install-service radicale`.