# Since .env is gitignored, you can use .env.example to build a new `.env` file when you clone the repo. # Keep this file up-to-date when you add new variables to `.env`. # This file will be committed to version control, so make sure not to have any secrets in it. # If you are cloning this repo, create a copy of this file named `.env` and populate it with your secrets. # Generate two different 64-character hex values with `openssl rand -hex 32` before starting Homarr. # Never reuse these values or commit the populated `.env` file. AUTH_SECRET= # The below secret is used to encrypt integration secrets in the database. # Homarr will reject an empty or invalid value and print a randomly generated candidate. SECRET_ENCRYPTION_KEY= LOG_LEVEL='info' # This is how you can use the sqlite driver: DB_DRIVER='better-sqlite3' # Safe local source-development path. SQLite files are ignored by Git. # Container images use /appdata/db/db.sqlite by default instead. DB_URL='./db.sqlite' # Those are the two ways to use the mysql2 driver: # 1. Using the URL format: # DB_DRIVER='mysql2' # DB_URL='mysql://user:password@host:port/database' # 2. Using the connection options format: # DB_DRIVER='mysql2' # DB_HOST='localhost' # DB_PORT='3306' # DB_USER='username' # DB_PASSWORD='password' # DB_NAME='name-of-database' # The following is an example on how to use the node-postgres driver: # DB_DRIVER='node-postgres' # DB_URL='postgres://user:password@host:port/database' # The below path can be used to store trusted certificates, it is not required and can be left empty. # If it is empty, it will default to `/appdata/trusted-certificates` in production. # If it is used, please use the full path to the directory where the certificates are stored. # LOCAL_CERTIFICATE_PATH='FULL_PATH_TO_CERTIFICATES' TURBO_TELEMETRY_DISABLED=1 # Turborepo remote cache (optional, for faster CI/local builds) # Uncomment and fill in to enable remote caching locally. # CI uses GitHub secrets for these values automatically. # TURBO_API=https://your-cache-worker.workers.dev # TURBO_TEAM=team_your_team # TURBO_TOKEN=your-turbo-token # TURBO_REMOTE_CACHE_SIGNATURE_KEY=your-signature-key # Comma-separated paths to Docker-compatible Unix sockets. # Useful for connecting to multiple runtimes (Docker + Podman) simultaneously. # When unset and no TCP hosts configured, defaults to /var/run/docker.sock. # Example: DOCKER_SOCKET_PATHS=/var/run/docker.sock,/run/user/1000/podman/podman.sock # DOCKER_SOCKET_PATHS= # Enable kubernetes tool # ENABLE_KUBERNETES=true # Enable mock integration UNSAFE_ENABLE_MOCK_INTEGRATION=true # Public URL contract. Values must be absolute HTTP(S) URLs without credentials, # query strings, or fragments. Trailing slashes are normalized at startup. # Public Homarr origin used by MCP OAuth metadata and redirects behind proxies. # BASE_URL=https://homarr.example.com HOMARR_WEBSITE_URL=https://homarr.dev # PocketBase API used by Homarr and by the standalone documentation site. # Defaults to HOMARR_WEBSITE_URL. # WORKSHOP_API_URL=https://homarr.dev # Public Workshop website used by links in Homarr, Custom Widgets, onboarding, # and assistant context. Defaults to HOMARR_WEBSITE_URL/workshop. # WORKSHOP_WEB_URL=https://homarr.dev/workshop # Documentation and PocketBase deployment settings. # WORKSHOP_PUBLIC_ORIGIN=https://homarr.dev # PB_ALLOWED_ORIGINS=* # Local Workshop stack: # HOMARR_WEBSITE_URL=http://127.0.0.1:3003 # WORKSHOP_API_URL=http://127.0.0.1:8090 # WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop # WORKSHOP_PUBLIC_ORIGIN=http://127.0.0.1:3003 # Optional: GITHUB_CLIENT_ID= # Optional: GITHUB_CLIENT_SECRET= # Enable demo mode (seeds a demo user "demo"/"demo", a sample board and a mock integration) # DEMO_MODE=true # Whether demo mode is read-only. Defaults to true (the public demo blocks all mutations). # Set to false for writable preview deployments so the demo user can modify the dashboard. # DEMO_READ_ONLY=false