185 lines
8.9 KiB
Bash
185 lines
8.9 KiB
Bash
# Yuvomi - Environment Variables
|
|
# Copy this file to .env and adjust the values.
|
|
|
|
# Server
|
|
PORT=3000
|
|
NODE_ENV=production
|
|
# LOG_LEVEL=info # debug, info, warn, error (default: info)
|
|
|
|
# Container host port mapping (compose maps OIKOS_HTTP_PORT:3000).
|
|
# The app inside the container always listens on 3000; change only the host port here.
|
|
OIKOS_HTTP_PORT=2700
|
|
# Host bind address for the published port (podman-compose.yml only; default 0.0.0.0).
|
|
# Set to 127.0.0.1 for rootless Podman behind a reverse proxy on the same host.
|
|
# OIKOS_HTTP_BIND=0.0.0.0
|
|
# TZ=Europe/Berlin # Container timezone (default: UTC). Also the fallback zone for
|
|
# # events pushed to Google Calendar when the target calendar
|
|
# # reports no time zone of its own.
|
|
|
|
# Container storage paths (bind mounts)
|
|
DATA_DIR=/volume2/docker/docker_projects/yuvomi/data
|
|
# Host folder for the database and stored app data
|
|
BACKUP_DIR=/volume2/docker/docker_projects/yuvomi/backups
|
|
# Host folder for scheduled backups
|
|
# These two are HOST paths, used only by docker-compose.yml / podman-compose.yml to
|
|
# build the volume mapping. Inside the container the app always writes to /data and
|
|
# /backups (the compose files set DB_PATH and BACKUP_DIR accordingly). Do not pass
|
|
# this file to a bare `docker run --env-file`: BACKUP_DIR=./backups would then point
|
|
# the app at /app/backups, which is outside the mounted volume and not writable.
|
|
# On SELinux systems (RHEL/Fedora/CentOS Stream) use podman-compose.yml — it adds
|
|
# the :Z relabel automatically so the container can access these folders.
|
|
MODULES_DIR=/volume2/docker/docker_projects/yuvomi/modules
|
|
DOCUMENT_STORAGE_LOCAL_DIR=/volume2/docker/docker_projects/yuvomi/documents
|
|
|
|
|
|
# Session
|
|
SESSION_SECRET=6JHynEHERoq8F
|
|
# SESSION_SECURE=true # Set when running behind an HTTPS reverse proxy (Caddy, Nginx, Traefik)
|
|
|
|
# Database (SQLite/SQLCipher)
|
|
# Legacy installs may still have /data/oikos.db — the app auto-migrates it to yuvomi.db on boot.
|
|
DB_PATH=/data/yuvomi.db
|
|
DB_ENCRYPTION_KEY=7wGeb6jm3KAoe
|
|
|
|
# NOTE: The optional integrations below (weather, Google/OIDC, WebDAV backup) may
|
|
# transmit data to third parties, some outside the EU/EEA. If you run Yuvomi under
|
|
# the GDPR, see docs/PRIVACY-FOR-SELFHOSTERS.md for per-service third-country
|
|
# assessments, data-processing-agreement notes and log-retention guidance.
|
|
|
|
# Weather widget — Open-Meteo (recommended, free, no API key). Set your coordinates:
|
|
WEATHER_LAT=
|
|
WEATHER_LON=
|
|
WEATHER_CITY=
|
|
WEATHER_UNITS=metric
|
|
|
|
# Weather widget — OpenWeatherMap (legacy, optional; only if you already use it):
|
|
OPENWEATHER_API_KEY=YOUR_API_KEY
|
|
OPENWEATHER_CITY=Berlin
|
|
OPENWEATHER_UNITS=metric
|
|
OPENWEATHER_LANG=de
|
|
|
|
# Google Calendar (optional)
|
|
GOOGLE_CLIENT_ID=
|
|
GOOGLE_CLIENT_SECRET=
|
|
GOOGLE_REDIRECT_URI=https://your-domain.com/api/v1/calendar/google/callback
|
|
|
|
# Google Drive document storage (optional)
|
|
# Enable the Google Drive API in the same Cloud project. Yuvomi requests only
|
|
# https://www.googleapis.com/auth/drive.file and accesses files it creates.
|
|
# Leave both Drive-specific credentials empty to reuse GOOGLE_CLIENT_ID and
|
|
# GOOGLE_CLIENT_SECRET. The Drive redirect URI is always separate and exact.
|
|
GOOGLE_DRIVE_CLIENT_ID=
|
|
GOOGLE_DRIVE_CLIENT_SECRET=
|
|
GOOGLE_DRIVE_REDIRECT_URI=https://your-domain.com/api/v1/documents/storage/google-drive/callback
|
|
# After deployment, connect Drive and explicitly select it under
|
|
# Settings -> Documents -> Storage. Connecting alone never activates uploads.
|
|
|
|
# OIDC / SSO (optional — alle vier Werte müssen gesetzt sein um OIDC zu aktivieren)
|
|
OIDC_ISSUER=https://authentik.example.com/application/o/yuvomi/
|
|
OIDC_CLIENT_ID=
|
|
OIDC_CLIENT_SECRET=
|
|
OIDC_REDIRECT_URI=https://your-domain.com/api/v1/auth/oidc/callback
|
|
# Opt-in: Bestehende Accounts per E-Mail verknüpfen, wenn der IdP keinen
|
|
# email_verified-Claim sendet. Nur setzen wenn der IdP vollständig unter eigener
|
|
# Kontrolle steht und keine unverifizierten E-Mails zulässt (z. B. ältere
|
|
# Authentik-Versionen ohne explizites email_verified-Mapping).
|
|
# OIDC_TRUST_EMAIL_WITHOUT_VERIFIED_CLAIM=true
|
|
|
|
# Apple Calendar CalDAV (optional)
|
|
APPLE_CALDAV_URL=https://caldav.icloud.com
|
|
APPLE_USERNAME=
|
|
APPLE_APP_SPECIFIC_PASSWORD=
|
|
|
|
# Sync interval in minutes for calendars and contacts (default: 15)
|
|
SYNC_INTERVAL_MINUTES=15
|
|
|
|
# ICS calendar subscriptions: allow http:// and private/local network feeds
|
|
# (e.g. Sonarr/Radarr/Home Assistant in the same LAN). Set true to lift the
|
|
# SSRF protection for ICS subscriptions — only in controlled environments.
|
|
# ICS_SUBSCRIPTION_ALLOW_PRIVATE_NETWORK=false
|
|
|
|
# Budget → Subscriptions (optional)
|
|
# Live currency conversion:
|
|
# FIXER_API_KEY=
|
|
|
|
# Automatic Backups
|
|
# BACKUP_ENABLED=true # Enable/disable automated backups (default: true)
|
|
# BACKUP_SCHEDULE=0 2 * * * # Cron schedule (default: 2 AM daily)
|
|
# BACKUP_KEEP=7 # Number of backups to keep (default: 7)
|
|
# TZ=Europe/Berlin # Timezone for scheduled backups (default: UTC, see above)
|
|
|
|
# WebDAV Backup Target (optional — uploads each backup to a WebDAV server)
|
|
# Supported: Nextcloud, ownCloud, Hetzner Storage Box, Infomaniak kDrive, etc.
|
|
# If set here, these values take precedence over the UI configuration in Settings → Backup.
|
|
# WEBDAV_BACKUP_ENABLED=true
|
|
# WEBDAV_BACKUP_URL=https://cloud.example.com/remote.php/dav/files/username/
|
|
# WEBDAV_BACKUP_USERNAME=username
|
|
# WEBDAV_BACKUP_PASSWORD=secret
|
|
# WEBDAV_BACKUP_PATH=/yuvomi/backups/
|
|
# WEBDAV_BACKUP_KEEP=10 # Remote backups to keep (default: 7)
|
|
|
|
# Local Folder Document Storage (optional — stores newly uploaded document files on a mounted host folder)
|
|
# When enabled, uploads are written to DOCUMENT_STORAGE_LOCAL_PATH/<key> instead of the database BLOB,
|
|
# and this backend takes precedence over WebDAV. Mount the folder into the container (see docker-compose.yml).
|
|
# Existing database/WebDAV documents remain readable; no automatic migration is performed.
|
|
# DOCUMENT_STORAGE_LOCAL_ENABLED=false
|
|
# DOCUMENT_STORAGE_LOCAL_PATH=/documents
|
|
|
|
# WebDAV Document Storage (optional — stores newly uploaded document files remotely)
|
|
# Non-empty values override the corresponding database settings. Existing WebDAV
|
|
# documents remain readable when new WebDAV uploads are disabled. Use this trusted
|
|
# deployment configuration for private/LAN WebDAV targets; UI-managed URLs must be public.
|
|
# DOCUMENT_STORAGE_WEBDAV_ENABLED=false
|
|
# DOCUMENT_STORAGE_WEBDAV_URL=https://cloud.example.com/remote.php/dav/files/username/
|
|
# DOCUMENT_STORAGE_WEBDAV_USERNAME=username
|
|
# DOCUMENT_STORAGE_WEBDAV_PASSWORD=secret
|
|
# DOCUMENT_STORAGE_WEBDAV_PATH=yuvomi-documents
|
|
# DOCUMENT_STORAGE_WEBDAV_ALLOW_PRIVATE_NETWORK=false # Set true to allow local/private network WebDAV targets (e.g. Nextcloud in same Docker network)
|
|
|
|
# Web Push (PWA notifications, optional)
|
|
# Delivers due reminders as system notifications even when the app is closed (requires HTTPS).
|
|
# VAPID keys are generated automatically on first use and stored in the database — leave these
|
|
# unset for a zero-config setup. Set them only to pin a fixed key pair across redeployments
|
|
# (generate with: npx web-push generate-vapid-keys).
|
|
# VAPID_PUBLIC_KEY=
|
|
# VAPID_PRIVATE_KEY=
|
|
# VAPID_SUBJECT=mailto:admin@example.com # Contact URI sent to push services (default: mailto:admin@localhost)
|
|
|
|
# Email / SMTP (optional)
|
|
# Configure an SMTP server to enable the "Forgot password" self-service flow.
|
|
# Can also be set in Settings → Administration → Email; non-empty values here override the DB.
|
|
# EMAIL_SMTP_HOST=smtp.example.com
|
|
# EMAIL_SMTP_PORT=587
|
|
# EMAIL_SMTP_SECURE=starttls # ssl | starttls | none
|
|
# EMAIL_SMTP_USER=
|
|
# EMAIL_SMTP_PASS=
|
|
# EMAIL_FROM_ADDRESS=yuvomi@example.com
|
|
# EMAIL_FROM_NAME=Yuvomi
|
|
# Absolute origin for password-reset links and calendar export-feed URLs. REQUIRED for
|
|
# reset emails: links are only sent when this is set (the request Host header is never
|
|
# trusted, to prevent reset poisoning). The export feed falls back to the request's
|
|
# protocol/host when unset.
|
|
# BASE_URL=https://yuvomi.example.com
|
|
|
|
# Security
|
|
RATE_LIMIT_WINDOW_MS=60000
|
|
RATE_LIMIT_MAX_ATTEMPTS=5
|
|
RATE_LIMIT_BLOCK_DURATION_MS=900000
|
|
|
|
# API documentation (/docs, /openapi.json) is admin-only and hidden entirely in
|
|
# production (NODE_ENV=production). Set to "true" to expose it to signed-in admins
|
|
# in production as well. Leave unset to keep it hidden.
|
|
# ENABLE_API_DOCS=true
|
|
|
|
# MCP endpoint (/mcp): the built-in Model Context Protocol bridge (call_api_operation)
|
|
# calls the REST API back over a loopback request. Override the base URL only for
|
|
# non-standard bind addresses; defaults to BASE_URL or http://127.0.0.1:<PORT>.
|
|
# MCP_INTERNAL_BASE_URL=http://127.0.0.1:3000
|
|
|
|
# Reverse proxy trust (controls which X-Forwarded-For / X-Real-IP values Express accepts)
|
|
# Default: 1 (trust one hop — correct for Caddy, nginx, Traefik in Docker)
|
|
# Set to a subnet when behind multiple proxy layers, e.g.:
|
|
# TRUST_PROXY=172.16.0.0/12,10.0.0.0/8
|
|
# Set to "loopback" for direct (no proxy) deployments.
|
|
# TRUST_PROXY=1
|