Configuration

Config File Reference

Config File Location

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

  1. . - Current active/working directory.
  2. /config

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
database
natsrequired
jwtrequired
storage
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

FiveNet LogoCopyright © 2024 Galexrt All rights reserved.

We use cookies! 🍪

The main purpose of our cookies is to have a basic user tracking for analytical purposes.

The best way to remove this websites data is to use the clear website data function of your browser.