Configuration reference¶
Generated from source
This page is generated directly from the Settings classes in the
saebooks (engine) and saebooks-web code by
scripts/gen-reference.sh. Do not edit it by hand — it is rebuilt on
every docs build, so it always matches the current product.
Last generated: 2026-10-16T17:24Z.
Engine (saebooks-api)¶
Set these on the api service. Aliases shown are the exact environment
variable names.
| Environment variable | Type | Default |
|---|---|---|
SAEBOOKS_EDITION |
Literal | community |
SAEBOOKS_LOG_LEVEL |
str | INFO |
SAEBOOKS_BIND_HOST |
str | 127.0.0.1 |
SAEBOOKS_BIND_PORT |
int | 8000 |
SAEBOOKS_DEBUG |
bool | false |
DATABASE_URL |
str | postgresql+asyncpg://saebooks:change-me-local-only@db:5432/saebooks |
SAEBOOKS_APP_DATABASE_URL |
str | (empty — disabled) |
SAEBOOKS_APP_DB_PASSWORD |
str | (empty — disabled) |
SAEBOOKS_SQL_RO_PASSWORD |
str | (empty — disabled) |
SEED_COMPANY_NAME |
str | (empty — disabled) |
SEED_COMPANY_LEGAL_NAME |
str | (empty — disabled) |
SEED_COMPANY_TRADING_NAME |
str | (empty — disabled) |
SEED_COMPANY_ABN |
str | (empty — disabled) |
SEED_COMPANY_ACN |
str | (empty — disabled) |
SEED_COMPANY_BASE_CURRENCY |
str | AUD |
SEED_COMPANY_FIN_YEAR_START_MONTH |
int | 7 |
SISS_CLIENT_ID |
str | (empty — disabled) |
SISS_CLIENT_SECRET |
str | (empty — disabled) |
SISS_SUBSCRIPTION_KEY |
str | (empty — disabled) |
SISS_TOKEN_URL |
str | https://auth.sissdata.com.au/oauth/token |
SISS_API_BASE |
str | https://api.sissdata.com.au/cdr-au/v1/ |
SISS_SANDBOX |
bool | false |
SISS_SANDBOX_PRIMARY_KEY |
str | (empty — disabled) |
SISS_BASE_URL |
str | https://sandboxapi.sissdata.com.au/cdr-au/v1/ |
SAEBOOKS_FIELD_ENCRYPTION_KEY |
str | (empty — disabled) |
ABR_API_GUID |
str | (empty — disabled) |
ABR_API_BASE |
str | https://abr.business.gov.au/json |
SMTP_HOST |
str | (empty — disabled) |
SMTP_PORT |
int | 587 |
SMTP_USER |
str | (empty — disabled) |
SMTP_PASSWORD |
str | (empty — disabled) |
SMTP_FROM |
str | [email protected] |
SMTP_TLS |
bool | true |
SAEBOOKS_MAIL_OUTBOX_DIR |
str | /app/mail-outbox |
SAEBOOKS_EMAIL_SEND_ENABLED |
bool | false |
RESEND_API_KEY |
str | (empty — disabled) |
RESEND_API_URL |
str | https://api.resend.com |
RESEND_WEBHOOK_SECRET |
str | (empty — disabled) |
SAEBOOKS_EMAIL_DRAFT_MODE |
bool | false |
GRAPH_TENANT_ID |
str | (empty — disabled) |
GRAPH_CLIENT_ID |
str | (empty — disabled) |
GRAPH_CLIENT_SECRET |
str | (empty — disabled) |
GRAPH_DRAFT_MAILBOX |
str | (empty — disabled) |
SENTRY_DSN |
str | (empty — disabled) |
SAEBOOKS_LOG_JSON |
bool | false |
PAPERLESS_URL |
str | (empty — disabled) |
PAPERLESS_API_URL |
str | (empty — disabled) |
PAPERLESS_API_TOKEN |
str | (empty — disabled) |
PAPERLESS_AUTO_BILL_ENABLED |
bool | false |
LEI_API_BASE |
str | https://api.gleif.org/api/v1 |
CH_API_KEY |
str | (empty — disabled) |
CH_API_BASE |
str | https://api.company-information.service.gov.uk |
SAEBOOKS_FRONTEND |
str | (empty — disabled) |
SAEBOOKS_SECRET_KEY |
str | (empty — disabled) |
STRIPE_WEBHOOK_SECRET |
str | (empty — disabled) |
STRIPE_DEFAULT_BANK_ACCOUNT_ID |
str | (empty — disabled) |
STRIPE_SECRET_KEY |
str | (empty — disabled) |
STRIPE_PUBLISHABLE_KEY |
str | (empty — disabled) |
LITELLM_API_KEY |
str | (empty — disabled) |
LITELLM_BASE_URL |
str | https://api.openai.com/v1 |
ATO_SBR_EVTE_BASE |
str | https://softwareauthorisations.acc.ato.gov.au |
ATO_SBR_PROD_BASE |
str | https://softwareauthorisations.ato.gov.au |
SAEBOOKS_OAUTH_ALLOWED_EMAILS |
str | (empty — disabled) |
SAEBOOKS_PUBLIC_BASE_URL |
str | http://localhost:8000 |
VAULT_URL |
str | http://saebooks-vault-api:18820 |
VAULT_SHARED_SECRET |
str | (empty — disabled) |
VAULT_ENABLED |
bool | false |
VAULT_TIMEOUT |
float | 10.0 |
VAULT_UPLOAD_TIMEOUT |
float | 60.0 |
LAUNCH_PROMO_ENABLED |
bool | false |
LAUNCH_PROMO_LIMIT |
int | 1000 |
LICENSE_SERVER_URL |
str | https://license.saebooks.com.au |
LICENSE_SERVER_TIMEOUT |
float | 5.0 |
REFERENCE_DATABASE_URL |
str | (empty — disabled) |
REFERENCE_MIGRATION_DATABASE_URL |
str | (empty — disabled) |
LATEX_API_URL |
str | http://latex-api:8000 |
LATEX_LOGO_PATH |
str | (empty — disabled) |
STATEMENT_LLM_API_KEY |
str | (empty — disabled) |
STATEMENT_LLM_BASE |
str | http://litellm:4000/v1 |
STATEMENT_LLM_MODEL |
str | claude-sonnet-4-6 |
STATEMENT_LLM_MODEL_ESCALATION |
str | claude-opus-4-7 |
STATEMENT_LLM_VISION_MODEL |
str | claude-haiku-4-5 |
DEMO_EPHEMERAL_ENABLED |
bool | false |
DEMO_IDLE_TTL |
int | 1800 |
DEMO_MAX_AGE |
int | 7200 |
DEMO_MAX_TENANTS |
int | 50 |
DEMO_PROVISION_PER_IP_PER_MIN |
int | 6 |
DEMO_REAPER_INTERVAL |
int | 60 |
DEMO_INTERNAL_SECRET |
str | (empty — disabled) |
DEMO_SEED_FLAVOUR |
str | saebooks |
DEMO_TEMPLATE_MAX_AGE |
int | 604800 |
Web (saebooks-web)¶
Set these on the web service. All variables use the SAEBOOKS_WEB_
prefix (the API base URL also accepts the unprefixed SAEBOOKS_API_URL).
| Environment variable | Type | Default |
|---|---|---|
SAEBOOKS_WEB_API_URL |
str | http://localhost:8042 |
SAEBOOKS_WEB_SECRET_KEY |
str | dev-insecure-change-me-before-prod |
SAEBOOKS_WEB_SESSION_COOKIE_NAME |
str | saebooks_web_session |
SAEBOOKS_WEB_SESSION_MAX_AGE |
int | 28800 |
SAEBOOKS_WEB_SESSION_HTTPS_ONLY |
bool | true |
SAEBOOKS_WEB_PORT |
int | 8043 |
SAEBOOKS_WEB_HOST |
str | 0.0.0.0 |
SAEBOOKS_WEB_DEBUG |
bool | false |
SAEBOOKS_WEB_LOG_LEVEL |
str | INFO |
SAEBOOKS_WEB_LAUNCH_PROMO_ENABLED |
bool | false |