π The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.
Vue dockergolangkanbanknowledge-baseknowledge-managementmarkdownnote-takingnotesnotes-appnotionnuxtnuxtjsoffline-firstoidcpwaselfhostedssovuevuejswiki
# ==============================================================================
# ALEXANDRIE - ENVIRONMENT CONFIGURATION
# ==============================================================================
# Instructions:
# 1. Copy this file to a new file named ".env"
# 2. Modify the values below to suit your environment
# 3. DO NOT commit your final ".env" file to source control
# ==============================================================================
# Important: If you want more detailed explanations about each variable, please refer to the "docs/README.md" file.
# Important: If you have some errors or something is not working as expected, please refer to FAQ in the "docs/README.md" file.
# ==============================================================================
# 1. PUBLIC ACCESS & GLOBAL URLS
# ==============================================================================
# Public URLs used by the client's browser to reach the services.
# If using a Reverse Proxy (Nginx/Traefik), use your public domain names here.
FRONTEND_URL=http://localhost:8200
API_URL=http://localhost:8201
CDN_URL=http://localhost:9000
CDN_ENDPOINT=/alexandrie/ # The base path in the CDN where files are served from (you probably want to keep this as /alexandrie/ to match the bucket name, change it only if you changed the bucket name or if you have configured a reverse proxy path)
# ==============================================================================
# 2. APPLICATION FEATURE FLAGS
# ==============================================================================
# Enable or disable optional frontend features.
CONFIG_DISABLE_LANDING=false # Disable the landing page if set to true
CONFIG_DISABLE_SIGNUP=false # Disable the signup page if set to true
CONFIG_DISABLE_NATIVE_LOGIN=false # Disable native username/password login if set to true (useful if you only want OAuth providers)
CONFIG_HIDE_NATIVE_LOGIN=false # Hide native username/password login if set to true (useful if you only want OAuth providers)
CONFIG_OIDC_PROVIDER_AUTO_REDIRECT= # Name of OIDC provider to redirect to when landing on login page (can be omitted)
# ==============================================================================
# 3. BACKEND API β RUNTIME & SECURITY
# ==============================================================================
BACKEND_EXTERNAL_PORT=8201 # The port exposed on your host machine for the Backend API
COOKIE_DOMAIN=localhost:8200 # Common domain for cookies (e.g., yourdomain.com if you have frontend.yourdomain.com and api.yourdomain.com)
ALLOW_UNSECURE=true # true = HTTP allowed (local dev / local machine), false = HTTPS only
JWT_SECRET=your-secure-jwt-secret-key-change-this-in-production
# ==============================================================================
# 4. DATABASE β MYSQL
# ==============================================================================
# MySQL service configuration
MYSQL_EXTERNAL_PORT=3307
MYSQL_DATABASE=alexandrie
# Credentials
MYSQL_USER=alexandrie
MYSQL_PASSWORD=password
MYSQL_ROOT_PASSWORD=rootpassword
# ==============================================================================
# 5. OBJECT STORAGE β S3 (RustFS / MinIO-compatible) (optional, leave empty to disable)
# ==============================================================================
# S3 API exposure
RUSTFS_EXTERNAL_PORT=9000
# Access credentials
RUSTFS_ACCESS_KEY=alexandrie-key
RUSTFS_SECRET_KEY=alexandrie-secret
# Default bucket used by the application
MINIO_BUCKET=alexandrie
# Runtime options
RUSTFS_CONSOLE_ENABLE=false
RUSTFS_LOG_LEVEL=error # debug | info | warn | error
#MINIO_SECURE=false # true = HTTPS, false = HTTP (local dev / local machine)
#MINIO_CA_PATH=... # Path to CA certificate for HTTPS (if using self-signed certs)
# MINIO_INSECURE_TLS=false # Disables TLS certificate verification while keeping HTTPS enabled. Intended for debugging/local testing and not recommended for production.
# ==============================================================================
# 6. EMAIL β SMTP (OPTIONAL)
# ==============================================================================
# Required only for password reset only.
# Leave empty to disable email features.
SMTP_HOST=
SMTP_MAIL= # Used for authentication and as default "from" address in emails
SMTP_MAIL_FROM= # Used as the "from" address in emails, if different from SMTP_MAIL
SMTP_PASSWORD=
# ==============================================================================
# 7. FRONTEND β NUXT
# ==============================================================================
FRONTEND_EXTERNAL_PORT=8200 # The port exposed on your host machine for the Frontend service
# ==============================================================================
# 8. ADVANCED OPTIONS (OPTIONAL)
# ==============================================================================
# CONFIG_PATH=./config.toml # Path to a custom config.toml file for the backend API (should be mounted as a volume in the docker-compose.yml file). Follow the structure of the default config.toml file (https://github.com/Smaug6739/Alexandrie/blob/main/backend/config.toml)