Keyboard shortcuts

Press or to navigate between chapters

Press ? to show this help

Press Esc to hide this help

Configuration reference

Config

FieldTypeDescription
bindAddressstringThe IP address to bind your Beacon instance to.
portnumber (integer)The port to listen for HTTP requests.
domainstringThe resolvable domain name of your Beacon instance.
gracefulShutdownTimeoutnumber (integer)The maximum time (in seconds) to gracefully shut down your Beacon instance.
databaseDatabaseConfigDatabase configuration.
jwtJWTConfigJWT configuration.

DatabaseConfig

FieldTypeDescription
pathstringThe (absolute) path to the database file.

JWTConfig

FieldTypeDescription
secretstringThe randomly generated JWT secret key for signing JWTs.
You can generate a key for your instance using this example command:
openssl rand -base64 32
cookieNamestringThe name of the cookie to store your JWT session token. You can use any alpha-numeric characters plus +, -, ., and _.
By default the cookie name is set to beacon_is_great.