Configuration

Sirveo requires some minimal configuration, which can be provided via configuration file, command-line options, and/or environment variables. For example, the database host can be configured with:

• db_host in a configuration file key
• --db-host in a CLI option
• SIRVEO_DB_HOST in an environment variable

Tip

All server configuration options are documented in the configuration reference.

By convention, the documentation usually refers to configuration options by environment variable name.

Default configuration

To use a configuration file, generate one like this:

sirveo default-config > /etc/sirveo/config.json

If you prefer yaml:

sirveo default-config --yml > /etc/sirveo/config.yaml

The generated configuration file will contain default values for all settings.

Minimal configuration

Minimal configuration should include:

---
# Change to "yes" to accept the EULA
eula_accept: no

# Add a license here
license: ""

# database
db_host: localhost
db_port: 5432
db_sslmode: prefer
db_name: sirveo
db_user: changeme
db_password: changeme

# server user
create_default_user: false
default_password: sirveoadmin
default_username: admin

# ...

Note

The End User License Agreement is available here, or in the binary:

sirveo legal --eula

Starting the server

To start the server using a configuration file, run:

sirveo server --config-file /etc/sirveo/config.yml

Or:

SIRVEO_CONFIG_FILE=/etc/sirveo/config.yml \
sirveo server

A configuration file is optional. All configuration parameters can be provided as environment variables and/or CLI options.