Configuration
Ingle is configured with environment variables. Where you set them depends on how you run it:
- Docker Compose: in
.envnext tocompose.yaml. Rundocker compose up -dafter a change. - Without Docker: in
/etc/ingle/ingle.env. Runsudo systemctl restart ingleafter a change. - From a checkout: in
.envat the top of the repository, whichtaskloads.
Most household settings, such as the timezone, when the day starts and the lock schedule, live in Admin › Settings instead.
Ingle’s settings
Section titled “Ingle’s settings”| Variable | Default | Notes |
|---|---|---|
INGLE_ADDR |
:8080 |
Listen address. 127.0.0.1:8080 listens on this machine only |
INGLE_DB_PATH |
./data/ingle.db |
The SQLite database. Photos and avatars are kept in the same folder |
INGLE_TZ |
Europe/London |
The timezone for a new household. After setup, change it in Admin › Settings |
INGLE_DATE_FORMAT |
02/01/2006 |
A Go date layout. The default is DD/MM/YYYY; 2006-01-02 is YYYY-MM-DD |
INGLE_WEEK_START |
monday |
Any day name |
INGLE_CURRENCY |
GBP |
An ISO currency code. Amounts are stored in pence (or cents) |
INGLE_PHOTOS_DIR |
(none) | A read-only folder of photos for the screensaver. See The photos folder |
INGLE_BACKUP_DIR |
backups beside the database |
Where the nightly backups go |
INGLE_BACKUP_KEEP |
14 |
How many backups to keep, up to 365. 0 turns backups off |
INGLE_BACKUP_AT |
03:00 |
When the nightly backup runs, in household time (HH:MM) |
INGLE_TRUSTED_PROXIES |
(none) | Reverse proxies whose X-Forwarded-For is believed: IPs or CIDRs, separated by commas or spaces. See Reverse proxy |
Ingle checks these when it starts, and a bad value stops it with a message naming the setting, such as INGLE_BACKUP_AT "3am": want HH:MM.
In the Docker image, INGLE_DB_PATH is /data/ingle.db and INGLE_BACKUP_DIR is /backups. In the systemd service, they’re /var/lib/ingle/ingle.db and /var/lib/ingle/backups.
Docker Compose only
Section titled “Docker Compose only”These are read by compose.yaml in deploy/, not by Ingle itself:
| Variable | Default | Notes |
|---|---|---|
INGLE_HOSTNAME |
(required) | The address the family types, such as ingle.home.example.com |
CLOUDFLARE_API_TOKEN |
(required) | For Caddy’s certificate. See Install |
INGLE_TAG |
latest |
The image tag to run, such as v0.2.0 |
BACKUP_PATH |
./backups |
The folder on the host that backups go to |
PHOTOS_PATH |
(none) | The folder on the host to mount as the photos folder |
INGLE_SUBNET |
172.30.40.0/24 |
The Compose network. Change it only if it clashes with yours |
INGLE_PROXY_IP |
172.30.40.2 |
Caddy’s address on that network, which Ingle trusts. Must be inside INGLE_SUBNET |
Names from before the rename
Section titled “Names from before the rename”Ingle used to be called Domus. Each INGLE_* setting falls back to its old DOMUS_* name when it isn’t set, so an old .env keeps working, and Ingle’s log lists any old names still in use. An existing domus.db is opened as long as there’s no ingle.db beside it. To rename them all at once: sed -i.bak 's/DOMUS_/INGLE_/g' .env.
Where things are stored
Section titled “Where things are stored”Everything lives in the folder that holds the database:
ingle.db, plusingle.db-walandingle.db-shmwhile it’s running: the database.avatars/: people’s photos.photos/: screensaver photos uploaded in admin.photo-cache/: resized copies of photos from the photos folder. Safe to delete.
Migrations run automatically when Ingle starts.