Aller au contenu principal

Configuration

kazarma is configured using environment variables. It will refuse to start if the required variables are not provided.

For optional environment variables, defaults are the recommended values to run kazarma beside your homeserver, bridging only your own users.

You may also want to customize the frontend or enable observability features.

Configuration de la Base de Données​

DATABASE_HOST (obligatoire)​

L'hôte qui héberge PostgreSQL.

DATABASE_USERNAME (obligatoire)​

Le nom de l'utilisateur SQL à connecter.

DATABASE_PASSWORD (obligatoire)​

Le mot de passe SQL associé à l'utilisateur SQL.

DATABASE_DB (obligatoire)​

Le nom de la base de données SQL.

Configuration du service de l'application​

HOMESERVER_TOKEN (obligatoire)​

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

ACCESS_TOKEN (obligatoire)​

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

MATRIX_URL (obligatoire)​

L'URL du serveur Matrix.

Adresses​

ACTIVITY_PUB_DOMAIN (obligatoire)​

Domaine ActivityPub pour les acteurs associés aux marionnettes. 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_

Préfixe du nom d'utilisateur pour les utilisateurs de marionnettes Matrix qui correspondent aux acteurs ActivityPub.

Configuration générale​

HOST (obligatoire)​

Host for the kazarma application, used to generate URLs.

SECRET_KEY_BASE (obligatoire)​

La base de la clé secrète de Phoenix, utilisée pour signer les cookies de session. Avec Mix et Phoenix, la génération est facile en utilisant mix phx.gen.secret.

PUBLIC_BRIDGE​

Default: false

True or false, whether kazarma is deployed as a "public bridge":

  • in private mode, it will only bridge the Matrix users of the homeserver it is installed alongside of;
  • in public mode, it will also bridge the remote Matrix users, but the ActivityPub users discoverability will be opt-in. It will also allow bridging of ActivityPub users' public activity, with a separate opt-in mechanism. This is only intended for a deployment at kazar.ma.

Default: false

True or false, whether to show the search field on kazarma HTML pages.

HTML_AP​

Default: false

True or false, whether to display profiles for ActivityPub actors. Pour aider les utilisateurs de Matrix à obtenir l'ID de Matrix (marionnette) servant à atteindre un acteur ActivityPub.

Frontend customization​

FRONTPAGE_HELP​

Default: true

True or false, whether the frontend should display integrated help.

FRONTPAGE_BEFORE_TEXT​

Default: ""

Text to show before kazarma introduction on the index page.

FRONTPAGE_AFTER_TEXT​

Default: ""

Text to show after kazarma introduction on the index page.

Observabilité​

SENTRY_DSN​

Default: ``

DSN de Sentry, si utilisé.

RELEASE_LEVEL​

Default: production

Niveau de Release, utilisé dans Sentry.

ENABLE_PROM_EX​

Default: false

Activer les mesures Prometheus.