Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
8152017
GitBook: No commit message
Apr 7, 2023
6e1f692
Merge pull request #19 from modmail-dev/main
raidensakura Apr 7, 2023
12f447f
Merge branch 'modmail-dev:development' into development
raidensakura Apr 7, 2023
f554e3d
MMM Sus
raidensakura Apr 7, 2023
a4aa466
GITBOOK-1: No subject
Apr 7, 2023
485f4e2
GITBOOK-2: Specify to run all 3 lines at once
Apr 7, 2023
0132448
Update configuration.md
Zinoviya99 Apr 10, 2023
909121d
Merge pull request #21 from modmail-dev/Zinoviya99-patch-1
Zinoviya99 Apr 10, 2023
edf5e04
GITBOOK-13: Add Fedora guide
raidensakura Apr 10, 2023
4119d90
Update configuration.md
Zinoviya99 Apr 10, 2023
1708538
Merge pull request #22 from modmail-dev/Zinoviya99-patch-2
lorenzo132 Apr 10, 2023
46ea0a4
Update configuration.md
Zinoviya99 Apr 10, 2023
484202a
Update configuration.md
Zinoviya99 Apr 10, 2023
b5ba00b
Update configuration.md
Zinoviya99 Apr 10, 2023
74d9412
Update configuration.md
Zinoviya99 Apr 10, 2023
40b9343
Finished Config Page
Zinoviya99 Apr 10, 2023
fd95889
Merge branch 'development' into Zinoviya99-patch-4
sebkuip Apr 10, 2023
e1f50d3
Merge pull request #24 from modmail-dev/Zinoviya99-patch-4
Zinoviya99 Apr 10, 2023
6b8c884
Add base logviewer instructions
sebkuip Mar 30, 2023
61e2f05
Add a patreon logviewer hosting setup
sebkuip Mar 30, 2023
3097d6e
Added info on how to clone a private repo
sebkuip Mar 30, 2023
9d4aaa4
Added logviewer links to summary
sebkuip Mar 30, 2023
7373c16
Fix links
sebkuip Mar 30, 2023
eb865e2
Fix patreon underscore
sebkuip Mar 30, 2023
8699e67
Fix another underscore
sebkuip Mar 30, 2023
59c4e73
Apply stephen's suggestions
sebkuip Mar 31, 2023
f09e980
Change extra line in premium logviewer guide
sebkuip Mar 31, 2023
ad764f4
Fix for stephen's review
sebkuip Apr 10, 2023
9a94c4c
Fix small oversight
sebkuip Apr 10, 2023
d6f1b47
Fix some additional formatting
sebkuip Apr 10, 2023
f8ec24a
Merge branch 'development' into development
raidensakura Apr 11, 2023
72a89d5
GITBOOK-14: Add Alma Linux guide
raidensakura Apr 11, 2023
ca3b54f
GITBOOK-15: Minor tweaks and correction
raidensakura Apr 11, 2023
47dfdb7
GITBOOK-16: Update links
raidensakura Apr 11, 2023
b3b52bd
GITBOOK-17: Move auto-restart guide to its own page
raidensakura Apr 11, 2023
50277c1
GITBOOK-18: Add pm2 auto-restart
raidensakura Apr 11, 2023
471d33d
GITBOOK-19: Add community guide description
raidensakura Apr 11, 2023
cb82ac1
Merge pull request #20 from raidensakura/development
Zinoviya99 Apr 11, 2023
f542172
Self-hosting correction and enhancement (#26)
raidensakura May 7, 2023
dfcfefe
Small correction (#27)
raidensakura Jul 14, 2023
12335a3
Update windows.md (#29)
StephenDaDev Nov 1, 2023
19dc417
Fix merge errors that made main and development no longer in sync (#32)
StephenDaDev Nov 10, 2023
f8652a6
Move Plugin Page
martinbndr Feb 23, 2024
1bed27f
GITBOOK-1: No subject
martinbndr Feb 25, 2024
fe8c5ba
Remove unofficial plugins
martinbndr Feb 25, 2024
efa71f5
Move Seperate Server to FAQ
martinbndr Feb 25, 2024
7b7c5dd
Update Railway
martinbndr Feb 25, 2024
b7e2c00
Update community-guides.md
martinbndr Feb 25, 2024
5531a3e
Merge pull request #34 from martinbndr/development
Zinoviya99 Feb 25, 2024
92187b7
Update plugins.md
martinbndr Feb 25, 2024
b423505
Merge pull request #35 from martinbndr/development
Zinoviya99 Feb 25, 2024
65f072f
Permissions Page
martinbndr Mar 2, 2024
4db3aaf
Pterodactyl Guide
martinbndr Mar 7, 2024
58a5d65
Merge pull request #36 from martinbndr/development
Zinoviya99 Mar 8, 2024
2dd53e5
Updated to the new mongo connect UI
sebkuip Mar 12, 2024
bf15655
Merge pull request #37 from sebkuip/development
Zinoviya99 Mar 12, 2024
27d7858
Railway is no longer free
sebkuip Mar 12, 2024
f8f30f9
Merge branch 'modmail-dev:development' into development
sebkuip Mar 12, 2024
b61b003
Merge pull request #38 from sebkuip/development
Zinoviya99 Mar 12, 2024
b05eebd
Update example .env
martinbndr Mar 19, 2024
f02b1da
Merge pull request #39 from martinbndr/development
raidensakura Mar 19, 2024
a53a8df
Resolve merge conflicts
Taaku18 Jun 23, 2024
1a10c5e
Merge pull request #41 from modmail-dev/rsv-merge-confl
Taaku18 Jun 23, 2024
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 modified .gitbook/assets/Image19.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/Image20.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/Image21.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
4 changes: 0 additions & 4 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +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)
* [Plugins](plugins.md)
* [Seperate Server Setup](seperate-server-setup.md)
* [The Unofficial List of Plugins](the-unofficial-list-of-plugins.md)
* [Updating](<updating (1).md>)
* [Video Tutorials](video-tutorials.md)
7 changes: 6 additions & 1 deletion frequently-asked-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,9 @@ And then, fetch the original files with:
git checkout FETCH_HEAD -- Pipfile && git checkout FETCH_HEAD -- Pipfile.lock
```

###
### I would like to have threads in a seperate guild inbox, how can I do that?

If you want to use a separate server to the main one as the inbox server (Where threads get relayed to) add the following environment variables into your ``.env`` file:

* `MODMAIL_GUILD_ID` (the server where messages are sent to)
* `GUILD_ID` (The server where users message from)
10 changes: 5 additions & 5 deletions installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ Next, we will need to generate a _MongoDB connection string_. Simply click **Con



<figure><img src="../.gitbook/assets/Image20.png" alt=""><figcaption><p>Choose <strong>Connect your application</strong>.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/Image20.png" alt=""><figcaption><p>Choose <strong>Drivers</strong>.</p></figcaption></figure>



Expand Down Expand Up @@ -279,7 +279,7 @@ TOKEN=OTY3Nzy5MzU5NjAzMzU2NzE4.GtKp_5.JOTYRwGW-LB1He5widCu73vXtmi90KxsqkmoOg
LOG_URL=https://logs.mymodmailbot.com/
GUILD_ID=1079074933008781362
OWNERS=188363246695219201,231595246213922828
MONGO_URI=mongodb+srv://username:password@cluster0-abcde.mongodb.net/
CONNECTION_URI=mongodb+srv://username:password@cluster0-abcde.mongodb.net/
```
{% endcode %}

Expand All @@ -289,9 +289,9 @@ Your next step is to choose one of our supported hosting method that's available

Click on one of the links below to view further instructions for your preferred hosting method. Each method has their pros and cons, be sure to take them into consideration when choosing your hosting platform to run Modmail.

### [Railway](railway.md) (free/paid)
### [Railway](railway.md) (paid)

A platform as a service (PaaS) that offers a generous free plan, which allows you to host Modmail for free without any downtime. A credit card is required for verification purposes. Their UI is very simple and easy for beginners to quickly deploy and run your Modmail bot on. You can learn more about their Free Tier plan and pricing by clicking [here](https://railway.app/pricing).&#x20;
A platform as a service (PaaS) that offers relatively low cost plans, which allows you to host Modmail for little without any downtime. A credit card is required for payment. Their UI is very simple and easy for beginners to quickly deploy and run your Modmail bot on. You can learn more about their plans and pricing by clicking [here](https://railway.app/pricing).&#x20;

### [Northflank](https://northflank.com/) (free/paid)

Expand Down Expand Up @@ -327,7 +327,7 @@ The Modmail team does not recommend this hosting method due to their highly unst
Please note that our Support Team will not be offering any official help or support if you choose this method to host Modmail.
{% endhint %}

An online code execution environment. You can host Modmail there for free using certain exploits. The legitimate method costs $7 USD per month. However, regardless if you pay or host for free, hosting on Replit are often unstable and thus not recommended. However, a community guide is still available by clicking [here](broken-reference).
An online code execution environment that costs $7 USD per month. However, hosting on Replit is often unstable, and thus not recommended. However, a community guide is still available by clicking [here](broken-reference).

## Community Guides

Expand Down
7 changes: 6 additions & 1 deletion installation/community-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Community guides are not verified by the Modmail team, so use them at your own r

## [Replit Guide](https://gist.github.com/anondev-sudo/24978429b85b44348bcff5c0885afe82) by AnonDev

An online code execution environment. You can host Modmail there for free using certain exploits. The legitimate method costs $7 USD per month. However, regardless if you pay or host for free, hosting on Replit are often unstable and thus not recommended. But for now, this is the only option for those without a payment method for hosting or verification.
An online code execution environment that costs $7 USD per month. However, hosting on Replit is often unstable, and thus not recommended. For the up-to-date pricing info check out their [pricing](https://replit.com/pricing) page.

## [Northflank](https://blog.project-mei.xyz/2023/04/11/hosting-discord-modmail-on-northflank/) Guide by raidensakura

Expand All @@ -19,3 +19,8 @@ Northflank is a Platform as a Service (PaaS) like Railway that offers abilities
## [Oracle Guide](http://docs.lidistat67.xyz/) by lidistat67

Oracle Cloud Compute is an Infrastructure as a Service (IaaS) platform. Unlike Railway and Heroku, Oracle gives you access to a VPS where you can have a more direct control of your instance. Oracle is a reputable company known for owning products such as Java, VirtualBox, MySQL, etc. Oracle Cloud offers 3,000 OCPU hours and 18,000 GB hours per month. This is equivalent to 24 GB of RAM and 4 OCPUs. TL;DR, Oracle offers powerful instances for free! Oracle requires a credit card for verification but will never charge you as long as you are on their free plan. The setup is similar to self-hosting Modmail as Oracle offers a VPS.

## [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.
9 changes: 3 additions & 6 deletions installation/railway.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,15 @@ Railway is a deployment platform where you can provision infrastructure, develop

## Requirements

* A credit card (for verification only).
* A credit card.
* An email account.
* A [GitHub](https://github.com/signup) account.
* You have completed the initial steps: [invited your bot](./#create-a-discord-bot) and [created a MongoDB database](./#create-a-mongodb-database).

## Costs

Railway provides a **free** "Starter" plan. This plan allows you to try out their platform for free without requiring a credit card\*. Your bot will be online for 10 days after signing up.

To keep your bot running 24/7, you'll need to sign up for their "Developer" plan. This plan is also **free**, but you will need to verify using your credit card, as it's to prevent abuse on their systems.

\*Credit card may be required for some users.
Their lowest plan starts at $5 per month.
Visit the [pricing](https://railway.app/pricing) page for the up-to-date pricing info.

## Fork our GitHub repositories

Expand Down
41 changes: 0 additions & 41 deletions permissions.md

This file was deleted.

147 changes: 0 additions & 147 deletions plugins.md

This file was deleted.

6 changes: 0 additions & 6 deletions seperate-server-setup.md

This file was deleted.

52 changes: 0 additions & 52 deletions the-unofficial-list-of-plugins.md

This file was deleted.

Loading