XANDIKOS(8)

📦
version 0.4.10 · 2 versions
, in arch rolling, nixpkgs unstable

💖 XANDIKOS(8) 💖

okay so real talk — this is the xandikos page from the System Administration Utilities crew, and bestie, it's a whole vibe. it's a git-backed CalDAV/CardDAV server. yes, that kind of server. calendars and contacts, but make it git. slay.

✨ NAME ✨

xandikos — a git-backed CalDAV/CardDAV server 🗓️🫶

🌸 DESCRIPTION 🌸

the whole thing starts like this, no cap:

usage: ./bin/xandikos -d ROOT-DIR [OPTIONS]

🎀 optional arguments:

okay these are the "you don't have to but you probably want to" ones:

  • -h, --help — prints this little help message and then dips out. exit, stage left. 👋
  • --version — shows you the program's version number and yeets itself out too. 💅
  • -d DIRECTORY, --directory DIRECTORY — the directory you're serving from. this is the main character, fr fr.
  • --current-user-principal CURRENT_USER_PRINCIPAL — path to the current user principal. default is [/user/] ✨
  • --autocreate — automatically creates the necessary directories for you. it's giving "acts of service" love language. 🫶
  • --defaults — creates the initial calendar and address book. also implies --autocreate, so you get the directories too. a package deal. 🎁
  • --dump-dav-xml — prints out the DAV XML requests and responses. for when you're nosy and need to see everything. 🙈
  • --avahi — announces services with avahi. say hi to the neighborhood. 👋🌈
  • --no-strict — enables workarounds for buggy CalDAV/CardDAV client implementations. translation: it's not you, it's them, and xandikos is being polite about it. 😭

🌈 Access Options:

  • -l LISTEN_ADDRESS, --listen-address LISTEN_ADDRESS — binds to this address. and plot twist: you can pass in a path for a unix domain socket. iconic flexibility. default is [localhost]
  • -p PORT, --port PORT — the port to listen on. default is [8080] 🔥
  • --route-prefix ROUTE_PREFIX — the path to Xandikos. highkey useful when Xandikos is chilling behind a reverse proxy. default is [/]
  • --autocert — serves HTTPS using a self-signed certificate, and it generates one under ~/.local/share/xandikos/certs if it's missing. cute, right? 💅
⚠️ for development and testing only — do not use in production. no cap, this one's a hard no for prod. run Xandikos behind a reverse proxy with a real CA-issued certificate instead. the self-signed cert is for the group chat, not the shareholders meeting. 😭
  • --htpasswd FILE — requires HTTP Basic authentication, validating credentials against an Apache-style htpasswd file. supports bcrypt (htpasswd -B, recommended) and SHA1 entries. requires --autocert — Basic auth must not be served over plain HTTP, periodt. if Xandikos is behind a reverse proxy, configure authentication there instead. 🛡️

👑 AUTHORS 👑

Jelmer Vernooij <jelmer@debian.org> — the legend who made this happen. bow down. 🙇‍♀️

and that's the page, bestie. this one's xandikos 0.2.5, dated March 2021, and it lives in the System Administration Utilities section of the manual. go forth and serve those calendars. 💖🦋✨

📦 where this page comes from