Skip to main content

Configure the server

The server reads YAML configuration. A custom configuration file can be supplied using the -c flag:

./hivekit-server -c ../config/server.yml

Configuration changes require a server restart. The normal environment override for a YAML key is hkt_<key>, for example hkt_externalUrl. Authentication-specific HIVEKIT_AUTH_* settings are documented separately.

Configuration reference​

The field reference inventories the current configuration struct. Field availability does not establish a supported default or production recommendation; those still need release-specific validation.

Use tcpEnabled, not the older documentation typo tcpEndabled. The previous guide’s saveFrequency setting is absent from the current configuration struct and has been removed from this guide.

Configure by responsibility​