Skip to content

systemli/userli-synapse-user-retention

Repository files navigation

userli-synapse-user-retention

Integration Maintainability Rating Quality Gate Status Coverage

This project is a simple extention for Userli to update users when they are active in Matrix. It will also delete users that are not active anymore in Matrix. You can run this as a cronjob or a systemd timer.

Configuration

The following environment variables are required:

  • USERLI_URL: The URL of the Userli instance.
  • USERLI_DOMAIN: The domain you are using for Matrix.
  • USERLI_TOKEN: The token to authenticate against the Userli instance.
  • SYNAPSE_URL: The URL of the Synapse instance.
  • SYNAPSE_TOKEN: The token to authenticate against the Synapse instance.

Usage

We recommend to use the provided Docker image:

docker run -d --name userli-synapse-user-retention \
  -e USERLI_URL=https://userli \
  -e USERLI_DOMAIN=example.com \
  -e USERLI_TOKEN=secret \
  -e SYNAPSE_URL=https://synapse \
  -e SYNAPSE_TOKEN=secret \
  systemli/userli-synapse-user-retention:latest