How Natel works with Baïkal
-
Your Baïkal address books. Sign in with your Baïkal account: Natel lists the books you created in Baïkal's admin, and stores no contacts itself.
-
Tested on Baïkal. The end-to-end suite runs in CI against Baïkal 0.10.1, with Digest and with Basic authentication. Manual checks use the same version.
-
Your cards' vCard version. Baïkal can hand a card stored as vCard 4.0 to Natel as 3.0. Natel then saves it as 3.0, the version it received, and doesn't convert it back.
Natel edits photos, details and groups, imports and exports vCard files, and keeps what iPhone and DAVx⁵ write. Everything it does.
Set it up
In a compose.yaml, set CARDDAV_URL to the origin Baïkal answers on, with no path. When Baïkal is a service of the same Compose file, http://baikal works.
services:
natel:
image: ghcr.io/kewindousse/natel:0.6
environment:
CARDDAV_URL: https://dav.example.com
ports:
- "127.0.0.1:8080:8080"
docker compose up -d
Natel answers Baïkal's Digest authentication, its default, and Basic too: nothing to change in Baïkal's settings.
Then open http://localhost:8080 and sign in with your Baïkal account. For HTTPS, reverse proxies and running without Docker, see the deployment guide.
Baïkal under a path
Natel finds Baïkal at the root of its domain with no setup. Under a path, such as https://example.com/baikal/html/ with CARDDAV_URL=https://example.com, add the .well-known redirect on that origin, for example with nginx:
location = /.well-known/carddav {
return 301 /baikal/html/dav.php;
}
Beta software. Export your address books, or back up your Baïkal server, before your first edit.
Questions
- Does Natel replace Baïkal's admin?
- No. You still create users and address books in Baïkal's admin. Natel edits the contacts in them.
- Can everyone on my Baïkal server use it?
- Yes. Each person signs in with their own Baïkal account and sees their own address books.
- Does it edit Baïkal's calendars?
- No. Natel edits contacts only. Keep your calendar app for those.
- What does it cost?
- Nothing. Natel is open source, under the MIT license.