Skip to content

Configuration

calsync reads its configuration from environment variables only. If a required variable is missing or a value is invalid, the app refuses to start, and the error names each offending variable.

Required

Variable Description
CALSYNC_BASE_URL The public base URL where calsync is reachable, for example https://calsync.example. It is used to build the OAuth redirect (<base>/auth/callback) and the feed URLs.
GOOGLE_CLIENT_ID The OAuth web client ID. See Google OAuth.
GOOGLE_CLIENT_SECRET The OAuth web client secret.
CALSYNC_SESSION_SECRET A random string that signs session cookies. Use at least 32 random bytes.
CALSYNC_TOKEN_ENC_KEY A Fernet key that encrypts stored Google refresh tokens.

You can generate the two secrets with:

python -c "import secrets; print(secrets.token_urlsafe(32))"                              # session secret
python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())" # token key

Optional

Variable Default Description
CALSYNC_DATA_DIR /data The directory for the SQLite database. Mount a persistent volume here.
CALSYNC_ALLOWED_EMAILS (empty) A comma-separated list of Google accounts allowed to sign in. Matching is case-insensitive.
CALSYNC_MIN_INTERVAL_MIN 30 The shortest sync interval, in minutes, that a source may use.
CALSYNC_FETCH_TIMEOUT_S 15 The time limit, in seconds, for each adapter run.
CALSYNC_FETCH_MAX_PAGES 20 The most pages or requests one adapter run may make.
CALSYNC_FETCH_MAX_BYTES 2097152 The most bytes (2 MiB) one adapter run may download.
CALSYNC_FETCH_ALLOW_PRIVATE false Allows fetching private, loopback, link-local and CGNAT addresses. Leave this off unless you need it. While it is off, the SSRF guard is active.
CALSYNC_TRUST_PROXY_HEADERS false Trusts X-Forwarded-* headers. Turn this on only behind a reverse proxy you control. See Reverse proxy.

Restrict who can sign in

If CALSYNC_ALLOWED_EMAILS is empty, any Google account can sign in to your instance. Set it whenever calsync is reachable from the internet.