~davidlang/mlrbd

aa282d5ecf463ebea49e4d852213664de614d749 — David Lang 11 months ago ac98319 master
Added readme + fixed bug in service file
2 files changed, 64 insertions(+), 1 deletions(-)

A README.md
M dist/mlrbd.service
A README.md => README.md +64 -0
@@ 0,0 1,64 @@
# mlrbd

mlrbd is bot to sync ldap groups to matrix rooms

Send support questions and feature requests to 
[~davidlang/mlrbd@lists.sr.ht](https://lists.sr.ht/~davidlang/mlrbd).

## Requirements

- ldap server
- matrix-synapse
- postgres (>=10)

## Building

Install the dependencies:

- go (>=1.12)

Then compile mlrbd:

    $ make

## Installation

    # make install

Insert your credentials in the config file `/etc/mlrbd/mlrbd.conf` and set 
the options as needed.

On your host running matrix-synapse, create a file called `mlrbd.yaml` in a 
location accessible by matrix-synapse (i.e. `/etc/matrix-synapse/mlrbd.yaml` 
with the following content:

    id: "Mlrbd"
    url: null
    as_token: "<your access token>"
    hs_token: "<dummy access token, currently unused>"
    sender_localpart: "mlrbd"
    namespaces:
      users: []
      aliases: []
      rooms: []

On your host running matrix-synapse, edit `homeserver.yaml` to include this file:

    app_service_config_files: ["/path/to/mlrbd.yaml"]

Restart matrix synapse

On your host running mlrbd, run

    $ mlrbd

or use a service file provided in `dist/`

## Contributing/development

[Send patches](https://git-send-email.io) to
[~davidlang/mlrbd-dev@lists.sr.ht](https://lists.sr.ht/~davidlang/mlrbd-dev).

Bugs & todo here : [~davidlang/mlrbd](https://todo.sr.ht/~davidlang/mlrbd)



M dist/mlrbd.service => dist/mlrbd.service +0 -1
@@ 4,7 4,6 @@ After=network.target

[Service]
Type=simple
EnvironmentFile=/etc/mlrbd.conf
User=mlrbd
ExecStart=/usr/bin/mlrbd
Restart=always