Skip to content
footnote Docs
Install

Service settings

The service reads its settings from the environment, once, when it starts. If one is wrong, it refuses to start and names each bad setting.

.env.example lists every setting. Copy it to .env.local, which npm run dev:server loads. Settings an admin changes while the service runs, such as limits, are in Administer the service.

The service

SettingDefaultWhat it does
NODE_ENVdevelopmentdevelopment, test or production. The service image sets production
HOST127.0.0.1The address it listens on
PORT3000The port it listens on
LOG_LEVELinfofatal, error, warn, info, debug, trace or silent

The database

SettingWhat it does
DATABASE_URLThe service’s own role. Required
DATABASE_URL_SERVEThe restricted role that serves agents. Unset, it is DATABASE_URL with the user changed
DATABASE_URL_MIGRATEThe owner, for migrations and backups. The service image needs it
DATABASE_URL_BOOTSTRAPA superuser, to create the roles and the database when they are missing, and load the demo
SEED_DEMOon loads the demo into an empty database. Refused in production

Sign-in and addresses

SettingDefaultWhat it does
FOOTNOTE_AUTHoidc in production, dev elsewhereHow people sign in: see Set up company sign-in
FOOTNOTE_DEV_PEOPLE_FILEThe demo’s peopleWho the dev and demo pickers offer
FOOTNOTE_WEB_ORIGINShttp://localhost:5173, http://localhost:4173The web app’s origins, comma-separated. The first is the address links go to
FOOTNOTE_TRUSTED_PROXIESNoneThe proxies it believes: see The proxy in front
MCP_RESOURCE_URLhttp://localhost:3000/mcpThe MCP address
MCP_DEV_KEY_FILE.footnote-dev-key.pemThe key for dev tokens. Production refuses dev tokens

The login server’s own settings are on Agent sign-in settings.

Models

SettingDefaultWhat it does
MODELSmockmock is scripted and sends nothing. live uses real models
ANTHROPIC_API_KEYNoneThe key for the anthropic provider
ANTHROPIC_AUTH_TOKENNoneA gateway’s bearer token in place of the key
ANTHROPIC_BASE_URLAnthropicAny server that speaks Anthropic’s Messages API
VERCEL_AI_GATEWAY_API_KEYNoneThe key for the vercel-gateway provider
OPENAI_API_KEYNoneThe key for the openai provider; a local server needs none
OPENAI_BASE_URLOpenAIAny server that speaks OpenAI’s Chat Completions API
FOOTNOTE_MODELNone<provider>:<model> for every role no one has changed yet
FOOTNOTE_MODEL_PRICESNoneIts <input>,<output> price, needed for an unlisted model
FOOTNOTE_JUDGE_MODELNoneThe test runs’ judge, the same way, with _PRICES as well

With live, each role’s provider and model come from the models.* settings, and the service refuses to start when a provider, a model or a key is missing, or the provider does not list the model and its setting gives no prices.

Ask answers with one model that reads with Footnote’s own read tools, as the person asking (Ask’s loop). That model must call tools. What the loop shows is not checked yet beyond its citations. With MODELS=mock it runs a scripted reader.

Before you go live. Questions and answers then leave your company to the named provider and the model’s vendor. Real company data needs company approval of them first.

Connectors

SettingDefaultWhat it does
CUBE_MODEL_DIRNoneA folder of Cube model files. Unset, the service reads two invented definitions, or in the image outside production, the demo model
FOOTNOTE_DOMAIN_OVERRIDESNoneA JSON file: view to domain, for what the model leaves unnamed
CUBE_RENAMES_FILENoneA JSON file of renamed members, old id to new id
CUBE_VIEWS_FILENoneA JSON list of the Cube views to read, such as ["orders", "revenue"], until an admin chooses them in the app. Unset, every view; empty, none (views)
FOOTNOTE_FIGURE_OVERRIDESNoneA JSON file of figure settings, for what the model leaves unsaid
CUBE_COMPILE_TIMEOUT_SECONDS120How long Cube’s compiler may take
CUBE_COMPILE_MEMORY_MB1024The memory Cube’s compiler may use
FOOTNOTE_SERVER_FOLDERSNoneA JSON object of connector ids to folders on the server
FOOTNOTE_EGRESS_PRIVATE_HOSTSNoneHosts on a private network connectors may reach over https, comma-separated
FOOTNOTE_SECRETS_DIRNoneThe folder that keeps the tokens of sources added in Integrations

FOOTNOTE_SERVER_FOLDERS looks like {"dbt-metricflow":"/srv/dbt/target"}. Each folder is read by that connector as one of the server’s own sources, and the demo definitions stop. In Docker, share the folder into the container and name its path there.

A connector that cannot read a folder stops the service at start. A folder that is not there shows as a failed read in Settings, Integrations.

Moving off a server folder. Moving a project from a server folder to a source of the same definitions is not supported yet. A server source taken out of the configuration keeps its definitions, so a source added later cannot take them.

FOOTNOTE_EGRESS_PRIVATE_HOSTS applies to files and APIs read over https, not to Git or figures. An admin in the app cannot add a host: see Connector security.

FOOTNOTE_SECRETS_DIR must be outside the repository, and only the server’s user may open it (mode 0700). compose.yaml sets it to a folder in the footnote_keys volume. Unset, no secret is kept, and a source that needs one cannot be added: connecting says so at its first step.

The product

SettingDefaultWhat it does
FOOTNOTE_PRODUCT_NAMEFootnoteThe name the app and the help pages say
FOOTNOTE_PROFILE_LABELNoneA name for this install, at most 40 characters, in the header and on the sign-in page: see Private profiles
FOOTNOTE_SUPPORT_EMAILNoneWhere Contact support and Report a problem write to. Unset, they open the project’s GitHub issues. Read when the app and the docs are built
FOOTNOTE_METRICS_TOKENNoneTurns on /metrics. At least 32 characters
FOOTNOTE_FIXED_TODAYNonePins the service’s day for demos and tests. A day in the past is kept whole: Ask’s records read it as ending at the end of that day. Refused in production

Report a problem opens a mail in the person’s own mail app, or an issue on GitHub when FOOTNOTE_SUPPORT_EMAIL is unset, and sends nothing through the service. An issue leaves out the install’s address.