mirror of
https://github.com/lennart-k/rustical.git
synced 2025-12-13 21:42:34 +00:00
Move stuff from README.md to docs
This commit is contained in:
@@ -35,6 +35,8 @@ You can generate a default `config.toml` configuration using
|
||||
rustical gen-config
|
||||
```
|
||||
|
||||
You'll have to set your database path to something like `/var/lib/rustical/db.sqlite3`.
|
||||
|
||||
### Environment variables
|
||||
|
||||
The options in `config.toml` can also be configured using environment variables.
|
||||
@@ -52,3 +54,60 @@ Every variable is
|
||||
- prefixed by `RUSTICAL_`
|
||||
- Dots become `__`
|
||||
- Arrays are JSON-encoded
|
||||
|
||||
|
||||
## Users and groups
|
||||
|
||||
Next, configure the principals by creating a file specified in `auth.toml.path` (by default `/etc/rustical/principals.toml`) and inserting your principals:
|
||||
|
||||
```toml
|
||||
[[principals]]
|
||||
id = "user"
|
||||
displayname = "User"
|
||||
password = "$argon2id$......."
|
||||
app_tokens = [
|
||||
{id = "1", name = "Token", token = "$pbkdf2-sha256$........"},
|
||||
]
|
||||
memberships = ["group:amazing_group"]
|
||||
|
||||
[[principals]]
|
||||
id = "group:amazing_group"
|
||||
user_type = "group"
|
||||
displayname = "Amazing group"
|
||||
```
|
||||
|
||||
Password hashes can be generated with
|
||||
|
||||
```sh
|
||||
rustical pwhash
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
You can also run the upper commands in Docker with
|
||||
|
||||
```sh
|
||||
docker run --rm ghcr.io/lennart-k/rustical rustical gen-config
|
||||
docker run -it --rm ghcr.io/lennart-k/rustical rustical pwhash
|
||||
```
|
||||
|
||||
## Password vs app tokens
|
||||
|
||||
The password is optional (if you have configured OpenID Connect) and is only used to log in to the frontend.
|
||||
Since it's sensitive information,
|
||||
the secure but slow hash algorithm `argon2` is chosen.
|
||||
|
||||
App tokens are used by your CalDAV/CardDAV client (which can be managed through the frontend).
|
||||
I recommend to generate random app tokens for each CalDAV/CardDAV client.
|
||||
Since the app tokens are random they use the faster `pbkdf2` algorithm.
|
||||
|
||||
## WebDAV Push
|
||||
|
||||
RustiCal supports [WebDAV Push](https://github.com/bitfireAT/webdav-push/) which can notify compatible clients like DAVx5 about changed calendar/addressbook objects.
|
||||
Since push messages are currently not encrypted you might potentially want to ensure that users only subscribe through your push server (e.g. [ntfy.sh](https://ntfy.sh/)), you can configure it the following:
|
||||
|
||||
```toml
|
||||
[dav_push]
|
||||
# Must strictly be the URL origin (so no trailing slashes)
|
||||
allowed_push_servers = ["https://your-instance-ntfy.sh"]
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user