Matrix-Mirrors/mjolnir
1
0
Fork 0
mirror of https://github.com/matrix-org/mjolnir.git synced 2024-10-01 01:36:06 -04:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
H. Shay 2024-09-30 13:04:53 -07:00
parent e640fc968b
commit 8e0f8400bc
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/moderators.md
View File

@ -34,8 +34,8 @@ the ACL format while membership bans are applied on sight. Within Matrix it is n
ban a set of users by glob/regex, so Mjolnir monitors the rooms it protects for membership changes and
bans people who match rules when they join/are invited.
Mjolnir can run through Pantalaimon if your coordination room is encrypted (this is recommended). Your
coordination/management room is where you and all of your moderators can speak to Mjolnir and update the
It is recommended that your management room be encrypted. Ensure that you have enabled encryption in the configuration
Your coordination/management room is where you and all of your moderators can speak to Mjolnir and update the
rules it uses. Be sure to keep this room private to avoid unauthorized access to the bot.
Note that Mjolnir performs all its moderation actions as itself rather than encouraging you to use your

7
docs/setup.md
View File

@ -1,7 +1,7 @@
# Setting up Mjolnir
It is recommended to use [Pantalaimon](https://github.com/matrix-org/pantalaimon) so your management
room can be encrypted. This also applies if you are looking to moderate an encrypted room.
It is recommended that your management room be encrypted. To ensure that your bot can communicate with encrypted rooms,
ensure that you have encryption enabled in the config.
If you aren't using encrypted rooms anywhere, get an access token by opening Element in a
seperate browser profile or incognito tab, and log in as the bot. Then, go to "All Settings", "Help & About", and
@ -39,7 +39,8 @@ See the below links for corresponding installation documentation;
After installation, create a room, and ensure the mjolnir has joined. This will be your "management room".
If you're using pantalaimon, this room can be encrypted. If you're not using pantalaimon, this room **can not** be encrypted.
It is highly recommended that this room be encrypted. Ensure that you have properly configured your mjolnir to use
encryption in the configuration.
Acquire the room ID of this room, in Element Web you can find this via `(Room Name) -> Settings -> Advanced -> "Internal Room ID"`.