Configuration

Config File Reference

Config File Location

By default FiveNet looks at the following places to find a config.yaml file (in order):

. - Current active/working directory.
/config - Mainly used by the containerized version of FiveNet.

Must Set Config Options

The most important options for FiveNet to run correctly:

http.publicURL - Public facing URL of your FiveNet instance.
http.sessions.cookieSecret - Secret used to handle user cookies (should be randomly generated once during install, at least 24 characters long).
http.sessions.domain - Public facing Domain/Subdomain name of your FiveNet instance.
database.dsn - Database connection string.
nats.url - NATS message queue URL (with credentials included).
jwt.secret - Secret used for creating the user tokens (should be randomly generated once during install, at least 24 characters long).
auth.superuserGroups - List of groups that will be granted superuser in FiveNet.

For detailed info on these options check the configuration reference section below.

Reference

Make sure to use the example config file (click here) to start writing your FiveNet config.

logLevel

string

Log level for FiveNet.

mode

string

Can be debug or release.

tracing

http

listen

string

Web listen address

adminListen

string

Admin listen address (for monitoring metrics)

publicURL

string required

Full public URL to the FiveNet instance, e.g., https://fivenet.example.com.

origins

string[] required

List of origins that are allowed to be served (can be ["*"] to allow any origin):

origins:
  - "https://fivenet.example.com"

sessions

required

trustedProxies

string[] required

List of trusted proxies (this enables the use of X-Forwarded-For/ X-Real-IP header from a proxy):

trustedProxies:
  - "1.2.3.4/24"

database

dsn

string required

The database source name (DSN) for your MySQL database.

DB_USER:DB_PASS@tcp(DB_HOST:DB_PORT)/DB_NAME?collation=utf8mb4_unicode_ci&parseTime=True&loc=Europe%2FBerlin

It is required to keep the parameters after the ?, only thing you can change is the &loc=Europe%2FBerlin to change the timezone for the database connection.

For writing a database source name (DSN), refer to https://github.com/go-sql-driver/mysql#dsn-data-source-name for details.

custom

See custom columns section.

For more information on the Golang SQL driver options available here, checkout https://go.dev/doc/database/manage-connections

maxOpenConns: 32
maxIdleConns: 5
connMaxIdleTime: 15m
connMaxLifetime: 60m

Only change these settings if you know what you are doing.

nats

required

jwt

required

storage

type

'filesystem' | 's3'

Either filesystem or S3 storage, requires the config options for the chosen storage type.

filesystem

imageProxy

cache

audit

oauth2

postalsFile

string

Path to the postals.json file, the default path is working for the provided FiveNet container image.

auth

dispatchCenter

discord

Advanced Config Options

Custom Columns

To disable a column, set it to "-" in the database.custom.columns structure like this:

database:
  # [...]
  custom:
    columns:
      user:
        # This would disable the display of the visum number
        visum: "-"
        playtime: "playtime"
      vehicle:
        # Your `owned_vehicles` table doesn't have a `model` column?
        # Just set it to `"-"` to disable it
        model: "model"
    conditions:
      user:
        filterEmptyName: false

Components

Config Examples