Configuration reference
Config
| Field | Type | Description |
|---|---|---|
| bindAddress | string | The IP address to bind your Beacon instance to. |
| port | number (integer) | The port to listen for HTTP requests. |
| domain | string | The resolvable domain name of your Beacon instance. |
| gracefulShutdownTimeout | number (integer) | The maximum time (in seconds) to gracefully shut down your Beacon instance. |
| database | DatabaseConfig | Database configuration. |
| jwt | JWTConfig | JWT configuration. |
DatabaseConfig
| Field | Type | Description |
|---|---|---|
| path | string | The (absolute) path to the database file. |
JWTConfig
| Field | Type | Description |
|---|---|---|
| secret | string | The randomly generated JWT secret key for signing JWTs. You can generate a key for your instance using this example command: openssl rand -base64 32 |
| cookieName | string | The 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. |