Skip to content

Latest commit

 

History

History
202 lines (128 loc) · 9.59 KB

README.md

File metadata and controls

202 lines (128 loc) · 9.59 KB
Raw

👮 MASZ

LatestVersion https://github.com/users/zaanposni/packages/container/package/masz_backend https://discord.gg/5zjpzw6h3S SupportedLanguages

⭐ Infractions and managed (temporary) punishments - to moderate your server
⭐ Quicksearch - to reliably search for any infractions or notes a user has
⭐ Localization - timezones and languages are fully customizable
⭐ Automoderation - to give trolls no chance
⭐ Ban appeals and webhook notifications - to moderate your server transparently
⭐ A website and a discord bot - to use MASZ
⭐ Full API and plugin support - for custom scripts and automations

🤝 Maintainers

This project is stable to use. However, it is no longer actively maintained by me.
If you want to become a maintainer, please contact me via Mail or Discord.

👀 Preview

dashboard preview

Previews and examples can be found at: https://github.com/zaanposni/discord-masz/tree/master/docs

🤝 Support Server

Join this server to receive update information or get support: https://discord.gg/5zjpzw6h3S

🛠 Hosting

You can host your own instance of MASZ by using the instructions below.
If you have any questions, feel free to contact Zaanposni, or a support member:

Note that MASZ is not hosted publicly. You will have to host your own instance.
Furthermore, only deployments on a linux and windows server are supported. Read below for software requirements.
Free hosting providers like replit or heroku do not work. You will have to use a VPS instead.

TL;DR;

  • Create a discord application at https://discord.com/developers/applications
  • Set redirect urls on your discord application as defined.
  • Enable Server Members and Message Content Intent in your bot settings.
  • Use python3 setup.py (python setup.py on windows) to setup the configuration.
  • Start the application with docker-compose up -d.
  • App will be hosted on 127.0.0.1:5565.
  • Read further for more information on different deployment methods and further steps.

Discord OAuth

Create your own OAuth application here. Also set the redirect paths in the tab OAuth2.
Be sure to set the following (choose localhost or domain depending on your deployment):

redirect example redirect example 2

Bot Intents

Enable Server Members and Message Content Intent in your bot settings.

intents example

Slash commands

If you have added your bot yourself, your bot might be missing the permission to create slashcommands.
Use the following link to authorize your bot to do so https://discord.com/api/oauth2/authorize?permissions=8&scope=bot%20applications.commands&client_id=yourid.
Be sure to replace "yourid" at the end with your client id.

✔️ Docker Setup (Recommended)

https://github.com/users/zaanposni/packages/container/package/masz_backend

Requirements

If you want to deploy on a domain

  • a (sub)domain to host the application on
  • a reverse proxy on your host

Instructions

  • Download this repository git clone https://github.com/zaanposni/discord-masz (zip link)
  • Use python3 setup.py (python setup.py on windows) to setup the configuration.
  • Start the application with docker-compose up -d.
  • App will be hosted on 127.0.0.1:5565, if you are hosting the app on a domain, redirect your reverse proxy to this local port!

Update

To install a new update of MASZ just use:

docker-compose pull
docker-compose up -d

↪ After Deployment

🐾 First Steps

  • You can visit your application at yourdomain.com (or 127.0.0.1:5565). You will see a login screen that will ask you to authenticate yourself using Discord OAuth2.
  • After authorizing your service to use your Discord account you will see your profile picture in the toolbar (this is hosted on 127.0.0.1:8080 when developing).
  • If you are logged in as a siteadmin, you can use the "register guild" (+) button to register your guilds and to get started.
  • Based on wanted features and functionalities you might have to grant your bot advanced permissions, read under Enabling Restricted Features.

Request logging and ratelimit

MASZ uses the X-Forwarded-For http header for logging and ratelimit.
Ensure that this header is set in your reverse proxy for best experience.

Enabling Restricted Features

⭐ Unban request feature

If you want banned users to see their cases, grant your bot the ban people permission.
This way they can see the reason for their ban and comment or send an unban request.
Furthermore, make sure the bot is high enough in the role hierarchy to ban people below him.

Additionally, if you want to enable unban requests ("ban appeals"), prepare questions in the "appeals" section of your guild dashboard.

⭐ Punishment feature

If you want the application to execute punishments like mutes and bans and manage them automatically (like unban after defined time on tempban), grant your bot the following permissions based on your needs:

Manage roles - for muted role | Moderate members - for using discord's timeouts
Kick people
Ban people

Furthermore, make sure the bot is high enough in the role hierarchy to punish people below him.

If you do not want to use a role to mute members, MASZ will automatically use discord's timeouts if you dont define a muted role.

⭐ Automoderation feature

To avoid any issue for message deletion or read permissions it is recommended to grant your bot a very high and strong or even the administrator role.

⭐ Invite tracking

Allows MASZ to track the invites new members are using. Grant your bot the manage guild permission to use this feature.

⭐ Strict permission check

You can enable strict permissions in your guildconfig. This mode will check your moderators role permissions before creating a modcase.
A moderator can only create a kick or ban modcase if he has the respective permission in discord.
If you do not enable this mode, moderators can create any modcase.

🗃️ Backup

There are backup example scripts in the scripts directory to backup uploaded files and the database.

💻 Self Hosting (Development)

.NET

  • If you're using an IDE like Visual Studio, you can copy and paste your launchSettingsExample.json file inside Properties if your C# solution to launchSettings.json, replacing the values to your testing variables. On running the program, it will treat these as environmental variables.

Svelte

If you want to develop on the svelte frontend, set the env var ENABLE_CORS=true for the backend container. To use the svelte instance, please change the DEV_MODE value to their development alternatives in the config.ts file inside the src/ directory. Then use npm run dev to get a hotload svelte instance.

MySQL Errors

Entity Framework implores some new features of MySQL for sake of optimising calls to the database.
As such, it is recommended you install MySQL 8+ to use this new syntax. Otherwise, you will encounter a MySQLException stating you need to check your MySQL version corresponds correctly with the version in your manual.

Building Docker Containers

After development, you may want to build a docker container to test on! This can be done simply through the following commands:

docker-compose -f docker-compose-dev.yml up --force-recreate --build

🤖 API scripting

As a siteadmin you can create a token to authenticate yourself while making API requests.
You can also use my python library to integrate the MASZ API into your project.

🤖 Custom plugins

You can write custom backend plugins for MASZ using C# [documentation].

🤝 Contribute

Contributions are welcome.
You can find our contributions guidelines here.
If you are new to open source, checkout this tutorial.
Feel free to get in touch with me via our support server https://discord.gg/5zjpzw6h3S.

💁🏻 Further Help

Feel free to join our discord at https://discord.gg/5zjpzw6h3S if you have further questions about your dev environment.