.env.example 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. # BambuTrack Environment Configuration
  2. # Copy this file to .env and adjust values as needed
  3. # Debug mode (true = DEBUG logging, false = production with INFO logging)
  4. DEBUG=true
  5. # Log level (only used when DEBUG=false)
  6. # Options: DEBUG, INFO, WARNING, ERROR
  7. LOG_LEVEL=INFO
  8. # Enable file logging (logs written to logs/bambutrack.log)
  9. LOG_TO_FILE=true
  10. # Home Assistant Integration (for HA Add-on deployments)
  11. # When both HA_URL and HA_TOKEN are set, Home Assistant integration is automatically enabled
  12. # and these values override any database settings (read-only in UI)
  13. # HA_URL=http://supervisor/core
  14. # HA_TOKEN=your-long-lived-access-token
  15. # Trusted iframe origins (#1191) — comma-separated list of scheme://host[:port]
  16. # origins permitted to embed Bambuddy via <iframe>. Defaults to empty (strict:
  17. # only same-origin embedding allowed). Set this to your Home Assistant origin
  18. # when using the HA Webpage dashboard panel, since HA on port 8123 and Bambuddy
  19. # on port 8000 are different origins to the browser. Wildcards, paths, and
  20. # non-http(s) schemes are rejected at startup with a warning.
  21. # TRUSTED_FRAME_ORIGINS=http://homeassistant.local:8123
  22. # MFA at-rest encryption key (#1219) — Fernet, base64-encoded 32 bytes.
  23. # Auto-generated and stored in DATA_DIR/.mfa_encryption_key on first startup
  24. # if unset. Set explicitly to manage the key out-of-band (e.g. via a secret
  25. # manager).
  26. # Generate with: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
  27. #
  28. # NOTE: Local backups (.zip) include the auto-generated key file, so a backup
  29. # is self-contained. If you set this variable explicitly, ensure your backups
  30. # also store the value separately (otherwise an encrypted backup cannot be
  31. # restored after key loss).
  32. # MFA_ENCRYPTION_KEY=
  33. # External library folders (GHSA-r2qv follow-up) — colon-separated list of
  34. # host paths that users are permitted to register as external library
  35. # folders via Settings → Library → "Add external folder".
  36. #
  37. # Empty (the default) means the external-folder feature is DISABLED:
  38. # attempts to register one return HTTP 400. Set this to one or more
  39. # absolute paths to opt in. Paths that fall inside Bambuddy's own
  40. # DATA_DIR / LOG_DIR / static dir are always rejected regardless of
  41. # this value.
  42. #
  43. # Example for a single NAS mount:
  44. # BAMBUDDY_EXTERNAL_ROOTS=/mnt/nas/3d-prints
  45. # Example for two roots:
  46. # BAMBUDDY_EXTERNAL_ROOTS=/mnt/nas/3d-prints:/srv/library
  47. #
  48. # In Docker, also bind-mount the host path into the container at the same
  49. # location (see docker-compose.yml for the matching volume snippet).
  50. # BAMBUDDY_EXTERNAL_ROOTS=