Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
Binary file added .gitbook/assets/permissionslevel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,5 @@
* [Configure Modmail and Logviewer](configure-modmail-and-logviewer.md)
* [Frequently Asked Questions](<frequently-asked-questions (1).md>)
* [Modmail Usage](modmail-usage.md)
* [Permissions](permissions.md)
* [Updating](<updating (1).md>)
* [Video Tutorials](video-tutorials.md)
7 changes: 6 additions & 1 deletion installation/community-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,9 @@ An online code execution environment which used to be free with certain exploids

## [Northflank](https://blog.project-mei.xyz/posts/2023-08-02-hosting-modmail-on-northflank.html) Guide by raidensakura

Northflank is a Platform as a Service (PaaS) like Railway that offers abilities to run micro-services like bots, schedule jobs that run periodically and databases with a powerful UI, API and CLI. Their panel is a bit more advanced as compared to Railway but comes with the perk of more customization and features. You will need a valid payment method to verify your account, but will unlock a free tier project that's separated from paid resources. They will not charge your card if you go over resource usage as you have limited allocation per service.
Northflank is a Platform as a Service (PaaS) like Railway that offers abilities to run micro-services like bots, schedule jobs that run periodically and databases with a powerful UI, API and CLI. Their panel is a bit more advanced as compared to Railway but comes with the perk of more customization and features. You will need a valid payment method to verify your account, but will unlock a free tier project that's separated from paid resources. They will not charge your card if you go over resource usage as you have limited allocation per service.

## [Pterodactyl](https://martinbndr.gitbook.io/modmail-hosting-on-pterodactyl/) Guide by martinbndr

Pterodactyl is a hosting self hostable platform that originally allows to host gameservers but it can also host other applications like modmail.
Some hosting provider providing you a free plan in order to application via this panel.
41 changes: 0 additions & 41 deletions permissions.md

This file was deleted.

53 changes: 52 additions & 1 deletion usage-guide/permissions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
---
description: How to use permissions in modmail.
---
---

# Permissions

The modmail bot comes with an advanced permission system that makes it able to choose which individual users or users with certain roles can use modmail specific commands.

The permission levels are the following:
* Owner \[5]
* Administrator \[4]
* Moderator \[3]
* Supporter \[2]
* Regular \[1]

You can view each permission level that is required for the specific command inside the help command.

<figure><img src="../.gitbook/assets/permissionslevel.png" alt="Screenshot of the Logviewer homepage."></figure>

## Setting up permissions
These permissions can added in two different ways.

### Adding a level to a role or user
`?permissions add level [name] [role/user]`

Examples:

* `?perms add level Regular everyone`
* `?perms add level Moderator @mods`
* `?perms add level Owner @user`

### Adding a command to a role or user

`?permissions add command [name] [role/user]`

Examples:

* `?perms add command reply @user`
* `?perms add command "plugin enabled" @role`
* `?perms add command help 984301093849028`

## Override permission level
In some cases it can be useful to override a command permission level.
This can be done like this:

`?permissions override <command_name> <level_name>`

Examples:

* `?perms override reply administrator`
* `?perms override "plugin enabled" moderator`

***
If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/zmdYe3ZVHG) and DM Modmail. One of our support members will help you.