cclohmar/inboxer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add .env.example as single source of truth for secrets documentation

Browse source 
Anyone cloning the repo can now see exactly which environment variables
are required by reading .env.example at the repo root.

install.sh updated to copy .env.example during deployment (rather than
duplicating the template inline), keeping the two in sync.
This commit is contained in:
Claus Lohmar 2026-04-23 19:57:44 +00:00
parent a9216459fc
commit 54dd30a2d6
2 changed files with 35 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
.env.example Normal file
View file

@ -0,0 +1,25 @@
# ───────────────────────────────────────────────────────
# inBOXER – Environment Configuration
# ───────────────────────────────────────────────────────
# Copy this file to .env and fill in your credentials:
# cp .env.example .env
# nano .env
#
# The application also reads these variables from the
# systemd EnvironmentFile (if deployed via install.sh).
# ───────────────────────────────────────────────────────
# DeepSeek API key – for AI-based email classification
# Sign up at https://platform.deepseek.com/ to get one.
DEEPSEEK_API_KEY=your_deepseek_api_key_here
# SMTP credentials – used to send one-time passwords (OTP)
# for user login. Supports STARTTLS on port 587.
SMTP_HOST=your.smtp.host.example.com
SMTP_PORT=587
SMTP_USER=your-email@example.com
SMTP_PASS=your-smtp-password
# (Optional) Override the session_secret from bin/config.yaml.
# Leave commented out to use the value in config.yaml.
# APP_SECRET=change-me-in-production

14
install.sh
View file

@ -113,11 +113,16 @@ sed -i 's|file: "bin/inboxer.log"|file: "'"${LOGS_DIR}"'/inboxer.log"|' "${BIN_D
# prompt_file: "bin/prompt.txt" works as-is relative to the working directory,
# since WorkingDirectory=/opt/inboxer resolves it to /opt/inboxer/bin/prompt.txt
# ─── Create .env template ────────────────────────────────────────────────────
# ─── Create .env from template ──────────────────────────────────────────────
ENV_FILE="${INSTALL_DIR}/.env"
if [[ ! -f "${ENV_FILE}" ]]; then
info "Creating .env template at ${ENV_FILE} ..."
cat > "${ENV_FILE}" << 'ENVEOF'
# Prefer .env.example from repo (single source of truth)
if [[ -f "${REPO_DIR}/.env.example" ]]; then
info "Copying .env.example from repository to ${ENV_FILE} ..."
cp "${REPO_DIR}/.env.example" "${ENV_FILE}"
else
info "Creating .env template at ${ENV_FILE} ..."
cat > "${ENV_FILE}" << 'ENVEOF'
# inBOXER Environment Configuration
# ====================================
# Set your credentials below. The service reads these variables on startup.
@ -136,7 +141,8 @@ SMTP_PASS=your-smtp-password
# (Optional) Override the session_secret from config.yaml.
# APP_SECRET=change-me-in-production
ENVEOF
info ".env template created."
fi
info ".env file created."
else
info ".env already exists, keeping existing file."
fi