Barad-dûr

Another matrix phone-home stats collector.

Requirements

• TLS, so that servers can reach you securely.
• PostgreSQL, used for storing stats.

Installation

You can either use cargo to install Barad-dûr on your machine locally with cargo install --git https://gitlab.com/famedly/company/devops/services/barad-dur.git, or deploy it in a container, with images available from registry.gitlab.com/famedly/company/devops/services/barad-dur.

Usage

Configuration

For configuration options look into config.sample.yaml.

Importing existing data from panopticon

Barad-dûr has import scripts for panopticon, which you can find in misc/panopticon-import, together with usage instructions.

Healthcheck for Docker container

The service API implements the /health checks for the Docker containers.

curl -fSs http://localhost:8080/health || exit 1

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

AGPL-3.0-only

Authors

• Shekhinah Memmel ([email protected])
• Jan Christian Grünhage ([email protected])