Menu
LocalAssistant docs

Configuration

Environment variables cover what the server needs at boot. Everything else (devices, invites, sign-in methods, email) is set in the app's admin area.

#Required

VariableWhat it does
AUTH_SECRETSigns sessions and encrypts stored secrets; 32 characters or up

Generate it with openssl rand -base64 32. Changing it signs everyone out and makes the stored device keys, passwords and tokens unreadable: add them again.

#Origin

VariableDefaultWhat it does
ORIGINfrom the proxy headersThe public URL; required on plain HTTP with no proxy

PORT, PROTOCOL_HEADER and HOST_HEADER belong to the Bun adapter; the image sets the two headers to x-forwarded-proto and x-forwarded-host.

#Sign-in override

VariableDefaultWhat it does
SIGN_IN_METHODSunsetpassword,passkey,magic-link,email-code: forces those methods

Set it to get back in after turning off the method you use, then remove it.

#Database

VariableDefault in the imageWhat it does
DATABASE_PATH/data/localassistant.sqliteThe SQLite file

Migrations run at every boot, before the worker starts.

#Background worker

VariableDefaultRangeWhat it does
WORKER_CONCURRENCY21 to 32Background jobs run at once
WORKER_POLL_INTERVAL_MS1000100 to 60000How often the worker looks for due jobs

#Logging

VariableDefaultValues
LOG_LEVELinfotrace, debug, info, warn, error
LOG_FORMATconsoleconsole, json

console writes coloured lines; json writes one object per line, for a log shipper.

#Version

VariableDefaultWhat it does
APP_VERSIONset by the release buildShown in the footer

This guide lives in the project repo: edit it there, and this page follows with the next release.