|
|
|
@@ -72,12 +72,16 @@ matrix_bot_draupnir_login_native: true |
|
|
|
matrix_bot_draupnir_management_room: "MANAGEMENT_ROOM_ID_HERE" |
|
|
|
``` |
|
|
|
|
|
|
|
Before proceeding to the next step, run the playbook with the following command to make sure that the bot user has been created. |
|
|
|
### Create and invite the bot to the management room |
|
|
|
|
|
|
|
Before proceeding to the next step, run the playbook with the following command to create the bot user. |
|
|
|
|
|
|
|
```sh |
|
|
|
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created |
|
|
|
``` |
|
|
|
|
|
|
|
Then, invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier. |
|
|
|
|
|
|
|
### Make sure the account is free from rate limiting (optional, recommended) |
|
|
|
|
|
|
|
If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a highly recommended step. If you do not configure it, Draupnir performance will be degraded.** |
|
|
|
@@ -171,8 +175,6 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use |
|
|
|
|
|
|
|
## Usage |
|
|
|
|
|
|
|
To use Draupnir, you need to invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier. |
|
|
|
|
|
|
|
You can refer to the upstream [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) for additional ways to use and configure Draupnir and for a more detailed usage guide. |
|
|
|
|
|
|
|
Below is a **non-exhaustive quick-start guide** for the impatient. |
|
|
|
|