GitHub - the-draupnir-project/Draupnir: A Matrix community management platform (original) (raw)

Draupnir is a unified platform to grow, manage, and sustain communities on Matrix.

Why communities choose Draupnir

• Draupnir provides Unified control to manage your Matrix community from one place.
• Draupnir has Open governance andtransparent project leadershipgrounded in grassroots community focus.
• Draupnir is Extensible, dynamically reconfigure protections and plugins for your circumstances or needs.
• Draupnir utilizes Distributed moderation: Subscribe to trusted, community-curated policy lists that keep spaces safe around the clock.

Status

We have recently passed a huge milestone: Draupnir's 3.0.0 release 🎉

Seegovernance reportsfor the current project focus.

Draupnir is supported by NLnet through the NGI Zero Core programme. The goals of this work are describedhere.

Draupnir also accepts community support throughOpen Collective, hosted byOpen Source Collective. Contributions help sustain development, maintenance, and contributor expenses with public budget transparency.

Quick start

SeeSetting up Draupnir.

Visit #draupnir:matrix.org in your client and come say hi.

Core Features

• Draupnir's UX is centred around intuitive interactive prompts, with no need to type out commands for most activities. Just use your client to invite the bot to rooms, or manage community members, and Draupnir will prompt you to complete your changes.
• Draupnir can protect your community by applying policies from community curated policy lists. For example lists such as the thecommunity moderation effortcan be watched to protect your rooms around the clock. This means that adjacent Matrix communities can warn and protect each other of known threats. Draupnir and the list provided by the community moderation effort are the bread and butter essentials of moderating public spaces on Matrix.
• Draupnir includes advancedhomeserver administrativefeatures, such as automatically suspending user accounts, blocking invitations, and taking down rooms. As well as reviewing abuse reports. This also includes protecting your homeserver with Draupnir's watched policy rooms.
• Draupnir can be used standalone to protect a community without a homeserver.
• Draupnir includes a series ofprotectionsthat can be enabled that can help you in given scenarios when your community is being targeted.
• Draupnir is a forwards and backwards compatible drop in replacement forMjolnir.

Prompt UX

It is no longer necessary to use commands for most core functions. Banning a user in a protected room from your Matrix client will cause Draupnir to show a prompt in the management room, which will offer to add the ban to a policy list1.

You can also unban users the same way, and Draupnir will prompt you to unban them without any confusing hiccups. If you do still wish to use the ban command, please note that users and other entities that are being banned are now the first argument to the ban command. It is now also possible to provide only the entity to Draupnir and have Draupnir prompt you for the policy list and the ban reason.

In general, all commands have been migrated to a new interface which feature better error messages for common problems and allow admins to trace the cause of unexpected errors much more easily.

Technical differences from Mjolnir and other moderation bots

I offer you the ring, which was burned, laid upon the pyre of Baldr by Odin.

Draupnir began as a fork of Mjolnir, in order to break a feature freeze and improve the architecture.

Draupnir remains a forwards and backwards compatible drop in replacement for Mjolnir that provides significant technical improvements:

• Draupnir is much less dependant on commands and will automatically send prompts to the management room. Prompts are sent for inviting Draupnir to protect rooms, watch policy lists, ban users, and unban users.
• Draupnir is much more responsive. Unlike Mjolnir and other bots, Draupnir does not need to request any data from the homeserver before applying new bans or to ban new users.
• Draupnir uses an advanced persistent revision system for room state, members, policies, and policy matches. By using revisions, Draupnir only has to process room state once in terms of simple deltas as room state is updated.
• Draupnir offers aroom state backing store, allowing Draupnir to startup quickly, even when deployed at distance from the homeserver.
• Draupnir's core functionality is implemented as protections, which can be configured and dynamically turned on and off. If you can write even a little JS/TS, Draupnir's behaviour can be radically changed or customized. And because the core functionality is implemented with the extension system, there are less limits.
• A huge effort has been spent refactoring the code base, paving the way for future feature development of Draupnir and adjacent projects. This includes the rewrite of the core of Draupnir into thematrix-protection-suite, providing all the Matrix client code required to operate a protection platform. The matrix-protection-suite also covers severall shortfalls in the available SDK's, providing event parsing and types that keep code secure and sound. Theinterface-managerproviding an advanced command-oriented interface (note, this does not mean command-line interface). Thematrix-basic-typeslibrary for dealing with Matrix's various string types. And finally the introduction of prettier,eslint andtypescript-eslint into Draupnir's development tooling, modernising TypeScript development.

Migration

Migrating from Mjolnir is straightforward and requires no manual steps, migration for your setup is likely as simple as changing your server config to pull the latest Draupnir docker image gnuxie/draupnir:latest instead of a mjolnir one. Draupnir remains backwards compatible so that it is possible to try Draupnir and still have the option to switch back to Mjolnir.

Any problems with migration should be reported to oursupport room.

Setting up

See thesetup documentationfor first-time setup documentation.

See the configuration sample with documentation for detailed information about Draupnir's configuration.

Seehomeserver administrationfor how to use Draupnir's features to protect your homeserver and users.

After your bot is up and running, you'll want to run a couple commands to get everything set up:

1. !draupnir list create my-coc code-of-conduct-ban-list - This will create a new ban list with the shortcode my-coc and an alias of#code-of-conduct-ban-list:example.org. You will be invited to the room it creates automatically where you can change settings such as the visibility of the room.
2. Review theModerator's Guide.
3. Review !draupnir help to see what else the bot can do.

Legacy documentation (v1.87.0 and below)

For information about the legacy version of Draupnir, see v1.87.0, the documentation for which can be foundhere.

Contributing & Opening Issues

Please see orcontributing document, but do not worry too much about following the guidance to the letter. And keep that in mind throughout.

Supported by

NLnet

This project is funded through NGI Zero Core, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.

You can find details of the work that is being supported from NLnethere and the goalshere.

1. Yes, i know they don't align horizontally, you are welcome to suggest how this should be fixed. ↩