Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the README now that we're moving. #575

Merged
merged 2 commits into from
Sep 20, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0

# Draupnir

A [Matrix](https://matrix.org) moderation bot.
A [Matrix](https://matrix.org) moderation bot and protections platform.
Visit [#draupnir:matrix.org](https://matrix.to/#/#draupnir:matrix.org)
in your client and come say hi.

Please see the [draupnir
documentation](https://the-draupnir-project.github.io/draupnir-documentation/)
for installation instructions and usage guides.

## Features

Draupnir has two main functions, the first is to synchronise bans for
users and servers across all of the matrix rooms that you moderate.
The second is to protect your community by applying policies from community curated
policy lists, for example the [community moderation effort](https://matrix.to/#/#community-moderation-effort-bl:neko.dev),
to your rooms around the clock. This means that communities can warn
and protect each other of known threats
and protect each other of known threats.

Draupnir also includes a series of protections that can be enabled
that might help you in some scenarios.
Expand All @@ -38,6 +42,27 @@ and is a continuation of Mjolnir. However, large sections of the the
code base are now very distinct and much of Draupnir was rewritten
into a library called the [matrix-protection-suite](https://github.com/Gnuxie/matrix-protection-suite).

#### Changes in `v2.0.0-beta.*` (pre-release)

* Draupnir's new core efficiently caches room state and room
membership allowing Draupnir to be much more responsive than
Mjolnir.

* Draupnir is much less dependant on commands
and will automatically send prompts to the managment room.
Prompts are sent for inviting Draupnir to protect rooms,
watch policy lists, ban users, and unban users.

* Draupnir offers a [room state backing
store](https://github.com/the-draupnir-project/Draupnir/blob/main/config/default.yaml#L206-L212),
allowing Draupnir startup quickly, even when deployed at distance
from the homeserver.

* Draupnir's core functionality is implemented as protections,
which can be dynamically turned on and off.

#### Changes in latest `v1.87.0`

The main difference from Mjolnir is that it is no longer necessary to use
commands for some functions. Banning a user in a protected room from your
Matrix client will cause Draupnir to show a prompt in the management room,
Expand All @@ -64,13 +89,20 @@ to trace the cause of unexpected errors much more easily.

## Status

The UX and code base of Draupnir is being overhauled and Draupnir is
slowly moving towards a 2.0.0 release.
Draupnir is being supported with a grant from NLnet,
the goals of the work are described [here](https://marewolf.me/posts/draupnir/24-nlnet-goals.html)

Currently The UX and code base of Draupnir has been overhauled and
Draupnir is moving towards a 2.0.0 release.

As Draupnir heads towards `v2.0.0`, releases will appear [here](https://github.com/Gnuxie/Draupnir/releases).
Until `v2.0.0` there will be frequent changes to commands but all of these
will be noted in the changes for that release.

Currently, we are running a beta channel (`v2.0.0-beta.*`). As of now
all functionality apart from dynamic configuration of protection
settings is stable in the beta channel.

For the latest stable release, see `v1.87.0`, the documentation
for which can be found [here](https://github.com/the-draupnir-project/Draupnir/tree/v1.87.0).

Expand Down
Loading