MakerLab/matrix-bot
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

Docs: update README

Browse source
This commit is contained in:
Dorian Zedler 2022-09-29 21:04:41 +02:00
parent 60ac9211e1
commit d791a7d903
Signed by: dozedler
GPG key ID: 989DE36109AFA354
1 changed files with 32 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -4,5 +4,35 @@ Unser Matrix-Bot, der Gruppen, Gruppenmitgliedschaften und Rechte verwaltet.
# How it works
1. load all users from matrix
2. add all users to the default channels
1. create default rooms
2. load users and their groups from matrix and ldap
3. create rooms for all projects which have `sophomorixMailList=TRUE`
4. load all rooms (created by the bot) and their power levels from matrix
5. sync user memberships and power levels
# How to use
.matrix-bot.env:
```env
MATRIX_BOT_LDAP_URI="ldap://10.0.0.1"
MATRIX_BOT_LDAP_BASE_DN=DC=linuxmuster,DC=lan
MATRIX_BOT_LDAP_BIND_DN=CN=global-binduser,OU=Management,OU=GLOBAL,DC=linuxmuster,DC=lan
MATRIX_BOT_LDAP_BIND_DN_PASSWORD=SomeSuperSafePassword
MATRIX_BOT_MATRIX_SERVER="https://matrix.org"
MATRIX_BOT_MATRIX_DOMAIN="matrix.org"
MATRIX_BOT_MATRIX_SPACE_ID="!bajjed:matrix.org"
MATRIX_BOT_MATRIX_USERNAME="synapse"
MATRIX_BOT_MATRIX_PASSWORD="SomeSuperSafePassword"
MATRIX_BOT_DEFAULT_ROOMS="info,talk,show"
MATRIX_BOT_ADMIN_GROUP="p_admin"
MATRIX_BOT_MODERATOR_GROUP="p_moderator"
```
docker-compose.yaml:
```yaml
version: "3"
services:
matrix-bot:
image: git.makerlab-murnau.de/makerlab/matrix-bot:latest
env_file: .matrix-bot.env
```