Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

The Arminius logo. Black and white digital graphic depicting a stylized angel wing

contributing guide

Arminius

Welcome to the documentation for Arminius.

Whether you’re looking to deploy the project, explore its architectural design, or join the development effort, this documentation has you covered.

Warning

Arminius is not yet ready to be used in production. At its current state, deploying it and federating with other rooms could lead to Arminius messing up the state of these rooms.

Furthermore, parts of the code currently assume a development environment or are unfinished in ways that make it insecure for a public-facing deployment. Therefore, we currently advise against deploying Arminius publicly.

GitLab

The GitLab repository is:

Rustdoc

The rustdoc is also hosted alongside this documentation. It can be found here.

Admin OpenAPI

The OpenAPI documentation for the Admin service can be found here