Site configuration options

Database

We currently support sqlite3, postgres and cockroach databases.

If you use dsn you don’t need to specify database type, host, port, name, user or pass.

Migrations

Upon startup the system checks if there are any pending database schema migrations and applies them in sequence. If one of the migrations fail everything gets rolled back and the startup fails with details in its log output.

The migrate setting allows you to control automatic schema migrations. If you want to update or upgrade the system you must set this to true.

Database opts

The opts setting allows you to set additional configuration parameters for the database.

The options you can set depends on the database type and version you are using.

Example sqlite3 database configuration.

copy
[database]
type = "sqlite3"
name = "/storage/site.db"
migrate = true
[[database.opts]]
set = "foreign_keys"
val = "ON"
[[database.opts]]
set = "journal_mode"
val = "WAL"

The database file gets created if it doesn’t exist.

Example Postgres database configuration.

copy
[database]
type = "postgres"
name = "site"
user = "postgres"
pass = "postgres"
host = "127.0.0.1"
port = 5432
migrate = true

If you have granted create database permission to the db user the database is created.

Example Cockroach database configuration using dsn.

copy
[database]
dsn = "cockroach://root@localhost:26257/site?sslmode=disable"
migrate = true

You must first create the site database in cockroach or it will use defaultdb instead.

Server

Server configuration options.

When server HOST is unset or if set to localhost or 127.0.0.1 it embeds a NATS messaging backend service. Otherwise it attaches itself to the nats://HOST:PORT service.

Example

copy
[server]
Host: "message.server.int"
Port: 4222
Dir: "/tmp"

Cluster

Site cluster configuration.