Files
simple-aircraft-manager-rails/.env.example
T
rickyandClaude Opus 5.5 3ad6b9493a Compose files and .env.example catch up
- The compose files' steps say where the first-run setup code is (it's
  asked for since 2026.11.5), that new accounts come from the admin, and
  who adds aircraft; the published image's release tags are mentioned.
- docker-compose.yml passes APP_REVISION/APP_BUILT_AT to the build when
  set, so a locally built image shows its build on Admin → About.
- .env.example lists the optional push notification keys, APP_LOCALE and
  APP_IMAGE, which the README documented but it didn't.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 19:35:45 -05:00

78 lines
3.8 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: an account at first sign-in for anyone the provider lets in, without an invitation
# 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
# --- Push notifications --------------------------------------------------
# Optional: without them the app makes a pair once and keeps it in storage/vapid_keys.json.
# Changing the pair turns notifications off on every device until turned on again.
# VAPID_PUBLIC_KEY=
# VAPID_PRIVATE_KEY= # bin/rails runner 'k = WebPush.generate_key; puts k.public_key, k.private_key'
# --- Other ---------------------------------------------------------------
# APP_LOCALE=en # language, e.g. es for config/locales/es.yml
# APP_REPOSITORY_URL= # source link on Admin → About (for a fork)
# APP_IMAGE= # Docker image named in the records package README (for a fork)
# RAILS_LOG_LEVEL=info