Skip to main content

Configuration

Kazarma is configured using environment variables.

Database configuration​

DATABASE_HOST (required)​

The host to reach PostgreSQL.

DATABASE_USERNAME (required)​

The SQL username.

DATABASE_PASSWORD (required)​

The SQL password.

DATABASE_DB (required)​

The SQL database.

Application service configuration​

HOMESERVER_TOKEN (required)​

Token defined in the application service configuration file, will be used to authenticate the Matrix server against Kazarma.

ACCESS_TOKEN (required)​

Token defined in the application service configuration file, will be used to authenticate Kazarma against the Matrix server.

MATRIX_URL (required)​

URL to the Matrix server.

Addresses​

ACTIVITY_PUB_DOMAIN (required)​

ActivityPub domain for puppet actors. If different than the host, you need to serve a file at domain/.well-known/host-meta, containing a link to the real host, like this

PUPPET_PREFIX​

Default: _ap_

Username prefix for Matrix puppet users that correspond to ActivityPub actors.

General configuration​

HOST (required)​

Host for the Kazarma application, used to generate URLs.

SECRET_KEY_BASE (required)​

Phoenix's secret key base, used to sign session cookies. With Mix and Phoenix, it can be easily generated with mix phx.gen.secret.

BRIDGE_REMOTE​

Default: false

True or false, wether Kazarma should bridge Matrix users from different homeservers (than the one beside Kazarma), to the ActivityPub network.

Default: false

True or false, wether to show the search field on Kazarma HTML pages.

HTML_AP​

Default: false

True or false, wether to display profiles for ActivityPub actors. It can help Matrix users to get the (puppet) Matrix ID to reach an ActivityPub actor.

Observability​

SENTRY_DSN​

Default:

Sentry DSN, if used.

RELEASE_LEVEL​

Default: production

Release level, used in Sentry.

ENABLE_PROM_EX​

Default: false

Enable Prometheus metrics.