Files
simple-aircraft-manager-rails/.env.example
T
rickyandClaude Opus 5.5 5876c07a1a Harden installs reachable from the internet without a proxy
- Refuse to start with a placeholder or short SECRET_KEY_BASE (under 32
  characters); warn and fail sam:doctor under 64. .env.example no longer
  ships a placeholder.
- First-run setup needs a one-time code printed only in the server log, so
  only whoever runs the server can create the admin account.
- AirTrail: the server resolves the address and connects to exactly that;
  never the server itself or link-local addresses (cloud metadata);
  private-network addresses only for admins or hosts in
  AIRTRAIL_ALLOWED_HOSTS.
- Host authorization when APP_HOST is set: APP_HOST, the APP_URL host,
  ALLOWED_HOSTS, localhost and IP addresses; /up exempt. A blocked name
  gets a short explanation instead of a blank 403.
- docker-compose.direct.yml: HTTPS without a proxy via Thruster's built-in
  Let's Encrypt (TLS_DOMAIN).
- Notes' Markdown no longer allows the unused class attribute.
- README, .env.example and the user guide updated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 12:42:53 -05:00

70 lines
3.2 KiB
Bash

# Simple Aircraft Manager settings. Copy to .env and edit; only the first
# block is required. Every setting is explained in the README.
# --- Required ----------------------------------------------------------
# Generate with: bin/rails secret (or: openssl rand -hex 64). Anyone who knows
# it can sign in as anyone, so the app won't start with a placeholder or a
# short one. Keep a copy somewhere safe off the server: signatures and stored
# secrets depend on it, and a restore needs the same one.
SECRET_KEY_BASE=
# The host name people use to reach the app (used in email links).
APP_HOST=aircraft.example.com
# The installation's time zone (scheduled jobs run on its clock; people see
# their own zone, from Profile or their device). Default UTC.
# TZ=America/New_York
# true: the app redirects to HTTPS and sets secure cookies (use behind a TLS
# proxy such as Traefik, Caddy or Cloudflare Tunnel, or with TLS_DOMAIN).
# false: plain HTTP, only on a private network: passwords travel unencrypted.
FORCE_SSL=true
# --- HTTPS without a proxy (docker-compose.direct.yml) -------------------
# The app gets a Let's Encrypt certificate for this name itself (ports 80
# and 443 must reach it).
# TLS_DOMAIN=aircraft.example.com
# --- Allowed addresses ---------------------------------------------------
# Requests are answered only for APP_HOST (and the APP_URL host), localhost
# and IP addresses. Other names that should work, comma-separated:
# ALLOWED_HOSTS=sam.lan,aircraft.home.arpa
# --- Address -----------------------------------------------------------
# Full public URL, if it isn't https://APP_HOST (used for the single sign-on
# and Google Drive redirect URIs).
# APP_URL=https://aircraft.example.com
# --- Email (password resets, sign-in links, invitations, reminders, alerts)
# SMTP_ADDRESS=smtp.example.com
# SMTP_PORT=587
# SMTP_USERNAME=
# SMTP_PASSWORD=
# SMTP_TLS=false # true for TLS from the start (default on port 465)
# MAIL_FROM=aircraft@example.com
# --- Single sign-on (OpenID Connect, e.g. Authentik) ----------------------
# OIDC_ISSUER=https://auth.example.com/application/o/aircraft/
# OIDC_CLIENT_ID=
# OIDC_CLIENT_SECRET=
# OIDC_PROVIDER_NAME=Authentik
# OIDC_AUTO_CREATE_USERS=false # true: create an account at first sign-in
# OIDC_TRUST_EMAIL=false # true: link accounts by unverified email
# OIDC_ADMIN_GROUP= # members become admins (synced at sign-in)
# --- AirTrail ------------------------------------------------------------
# AirTrail servers on your private network that everyone may connect to
# (admins can always use private addresses), comma-separated host names:
# AIRTRAIL_ALLOWED_HOSTS=airtrail.lan
# PASSWORD_LOGIN=true # false: SSO only (invited mechanics then can't sign in)
# --- Sign-in security ----------------------------------------------------
# PWNED_PASSWORDS_CHECK=true # false if the server has no outbound internet
# --- Logbook transcription with Claude -----------------------------------
# ANTHROPIC_API_KEY=
# LOGBOOK_AI_MODEL=claude-opus-5-5
# LOGBOOK_AI_EFFORT=high
# --- Other ---------------------------------------------------------------
# APP_REPOSITORY_URL= # source link on Admin → About (for a fork)
# RAILS_LOG_LEVEL=info