Skip to content

Reference

Keep this page handy while you configure deployments or automate infrastructure. It consolidates the values that previously lived in scattered guides.

VariablePurposeNotes
POSTGRES_PASSWORDDatabase password32+ random characters
DATABASE_URLConnection stringpostgres://postgres:${POSTGRES_PASSWORD}@postgres:5432/notes?sslmode=prefer
REDIS_PASSWORDRedis authentication16+ random characters
JWT_SECRETJWT signing keyBase64 string ≥ 64 chars
SERVER_ENCRYPTION_KEYServer-side encryptionExactly 32 characters
CORS_ORIGINSAllowed originsComma-separated URLs
VITE_API_URLFrontend API targethttps://your-domain/api/v1
VariablePurpose
ENABLE_REGISTRATIONAllow self-serve sign-up (false by default)
ENABLE_DEFAULT_ADMINCreates the bootstrap admin account
DEFAULT_ADMIN_EMAILAdmin username when bootstrap is enabled
DEFAULT_ADMIN_PASSWORDAdmin password when bootstrap is enabled
ENABLE_METRICSEnables Prometheus metrics endpoint
ServicePortNotes
Backend8080Exposes REST API and health endpoints
Frontend3000 build / 80 runtimeServed by Caddy in production images
PostgreSQL5432Internal only; protect externally
Redis6379Internal only; requires password
EndpointDescription
/api/v1/healthBasic liveness probe
/api/v1/readyReadiness probe (Kubernetes)
/metricsPrometheus endpoint when ENABLE_METRICS=true
PathContents
postgres-dataPostgreSQL data files
redis-dataRedis persistence (if enabled)
leaflock-uploadsEncrypted file attachments

If you add another platform or configuration, update this page so the fast facts stay accurate.