Home Information - Your home, your data, organized.
Python
# Home Information environment configuration — EXAMPLE
#
# Format: docker-compose env_file (KEY=value). No `export`, no shell quoting,
# no ${VAR} interpolation. For developer shell-sourced env, run:
# ./deploy/env-generate.py --env-name development
#
# If you are installing via install.sh, you do NOT need this file —
# install.sh creates `~/.hi/env/local.env` for you with real values filled
# in. Do not manually place this file at `~/.hi/env/local.env`; install.sh
# will then treat your system as already-installed and refuse to proceed.
# This file exists as a reference for the variables that real env file
# will contain.
#
# If you are integrating Home Information into your own docker-compose stack
# (bypassing install.sh), copy this file alongside your compose file, fill
# in the placeholder values, and start the app.
#
# Required vs. optional is noted per section.
# --- Core Django (required) ---
DJANGO_SETTINGS_MODULE=hi.settings.local
DJANGO_SERVER_PORT=8000
DJANGO_SECRET_KEY=<replace-with-50-char-random-string>
# --- Admin user (required) ---
[email protected]
DJANGO_SUPERUSER_PASSWORD=<replace-with-strong-password>
# --- Data paths inside the container (required; leave at defaults for the standard install) ---
HI_DB_PATH=/data/database
HI_MEDIA_PATH=/data/media
# --- Redis (required; defaults are correct for the bundled in-container Redis) ---
HI_REDIS_HOST=127.0.0.1
HI_REDIS_PORT=6379
HI_REDIS_KEY_PREFIX=
# --- Authentication (optional; "true" disables login for simple single-user setups) ---
HI_SUPPRESS_AUTHENTICATION=true
# --- Email / alerts (optional; leave HI_EMAIL_HOST empty to disable email notifications) ---
HI_EMAIL_SUBJECT_PREFIX=
HI_DEFAULT_FROM_EMAIL=
HI_SERVER_EMAIL=
HI_EMAIL_HOST=
HI_EMAIL_PORT=587
HI_EMAIL_HOST_USER=
HI_EMAIL_HOST_PASSWORD=
HI_EMAIL_USE_TLS=false
HI_EMAIL_USE_SSL=false
# --- Network (optional; needed when accessing beyond localhost) ---
HI_EXTRA_HOST_URLS=
HI_EXTRA_CSP_URLS=