Repository navigation
Configuration
github-actions[bot] edited this page Oct 15, 2026
·
1 revision
Generated from
README.mdin the repository. Edit it there; this wiki is rebuilt on every change.
All settings come from .env (or -e flags for Docker). The ones you are most likely to change:
| Variable | Default | Description |
|---|---|---|
EDGESHELL_DOMAIN |
(empty) | Public domain for production (enables Nginx + TLS) |
LETSENCRYPT_EMAIL |
(empty) | Email for Let's Encrypt expiry notices |
SECRET_KEY |
(generated) | Session signing key. Required in production |
CREDENTIAL_KEY |
(generated) | Encrypts node passwords and API keys. Required in production |
FLASK_ENV |
development |
development or production
|
DATABASE_URL |
SQLite in instance/
|
SQLAlchemy URL (set automatically by the production installer) |
DISPLAY_TZ |
Asia/Kolkata |
Time zone for the UI and system clock. The database always stores UTC |
SESSION_HOURS |
8 |
Session lifetime |
SINGLE_SESSION |
true |
Enforce each user's device limit (1 by default, up to 4, set by an admin) |
MAX_FAILED_LOGINS / LOCKOUT_MINUTES
|
5 / 15
|
Account lockout policy |
SESSION_COOKIE_SECURE |
false (true in the image) |
true behind HTTPS; false for plain-HTTP testing |
BEHIND_PROXY |
false |
true behind a reverse proxy, so lockout, rate limits and audit see real client IPs |
GUNICORN_THREADS |
8 |
Worker threads in the container image |
VPN_BACKEND |
tailscale |
tailscale or wireguard
|
METRICS_RETENTION_DAYS |
14 |
How long monitoring history is kept |
EMAIL_ENABLED |
false |
Turn on useSend email notifications for issues |
See .env.example for the full list with comments.
Repository · Docker Hub · Report a security problem · MIT licence
Start
Deploy
- Deploy on AWS EC2
- Run on Any Cloud
- Configuration
- MQTT Heartbeat
- VPN and Network
- Database Migration
Use
How it is built
Project
Decision records