diff --git a/.gitbook/assets/permissionslevel.png b/.gitbook/assets/permissionslevel.png new file mode 100644 index 0000000..723a612 Binary files /dev/null and b/.gitbook/assets/permissionslevel.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 75b1fb4..d7cccde 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -31,6 +31,5 @@ * [Configure Modmail and Logviewer](configure-modmail-and-logviewer.md) * [Frequently Asked Questions]() * [Modmail Usage](modmail-usage.md) - * [Permissions](permissions.md) * [Updating]() * [Video Tutorials](video-tutorials.md) diff --git a/installation/community-guides.md b/installation/community-guides.md index 454d2f4..72a0ada 100644 --- a/installation/community-guides.md +++ b/installation/community-guides.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/permissions.md b/permissions.md deleted file mode 100644 index bc4d852..0000000 --- a/permissions.md +++ /dev/null @@ -1,41 +0,0 @@ -# Permissions - -Modmail comes with an advanced permission system. The different permission levels are: - -* Owner \[5] -* Administrator \[4] -* Moderator \[3] -* Supporter \[2] -* Regular \[1] - -To see which commands are available to which permission, you can see the numbers next to the command in the help menu. - -![Imgur](https://i.imgur.com/yNl7Ept.png) - -## Setting Up - -You can add permissions in 2 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` - -*** - -If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. One of our support members will help you. diff --git a/usage-guide/permissions.md b/usage-guide/permissions.md index 3ff6888..fbb3538 100644 --- a/usage-guide/permissions.md +++ b/usage-guide/permissions.md @@ -1,3 +1,54 @@ --- description: How to use permissions in modmail. ---- \ No newline at end of file +--- + +# 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. + +
Screenshot of the Logviewer homepage.
+ +## 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 ` + +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. \ No newline at end of file