You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: index.md
+8-15Lines changed: 8 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,19 +66,15 @@ Please enter the ID of your server. If you're unsure where to find the server ID
66
66
67
67
Modmail stores all configurations and logs in MongoDB, and you are required to provide a MongoDB connection string for your bot. [MongoDB Atlas](https://www.mongodb.com/products/platform/atlas-database){: target="_blank" rel="noopener"} provides a free 500MB tier, which is more than enough to store around 3 million message logs. Due to security concerns, we do not provide hosting for your data.
68
68
69
-
#### Video Tutorial (Slightly Outdated):
70
-
71
-
{% include video-guide.html %}
72
-
73
69
### Sign Up
74
70
75
71
[Sign-up for an account](https://www.mongodb.com/cloud/atlas/register){: target="_blank" rel="noopener"} and verify your email.
76
72
77
-
On the following page, click **Skip Personalization** (these questions does not matter).
73
+
On the following page, click **Skip Personalization** (these questions do not matter).
Next, you will be prompted to deploy your cluster. Click on the **free** option. Then choose any provider/region, US-WEST / US-CENTRAL is preferred but anything is fine. The cluster name can be anything. **<u>Disable</u> both quick setup options!**
77
+
Next, you will be prompted to deploy your cluster. Choose the **free** option, then select any provider and region: us-west / us-central is preferred, but anything is fine. The cluster name can be anything. **<u>Disable</u> both quick setup options!**
@@ -88,39 +84,36 @@ You should now see a quick setup pop-up window asking you to add connection IP a
88
84
89
85
#### IP Address Whitelist
90
86
91
-
Choose **Allow Access from Everywhere**, it will autofill `0.0.0.0/0`as the IP address (don't change this), click **Add IP Address** to save.
87
+
Choose **Allow Access from Everywhere**, it will autofill `0.0.0.0/0`under IP address (don't change this), click **Add IP Address** to save.
92
88
93
89

94
90
95
91
#### Create Database User
96
92
97
-
Under username: type `modmail`, and under password: type a random password with **only letters and numbers** (no symbols allowed). <u>You will need to share us this password so don't make it personal.</u> Click **Create Database User** to save.
93
+
Under username: type `modmail`, and under password: type a random password with **only letters and numbers** (don't use symbols!). <u>You will need to share us this password so don't make it personal.</u> Click **Create Database User** to save.
98
94
99
95

100
96
101
97
#### Retrieve the Database Connection String
102
98
103
-
The next step is to choose a connection method, you will click **Drivers** and then copy the connection string down below (the driver doesn't matter).
104
-
105
-
**You MUST replace the `<db_password>` within the connection string with the password you set when creating the database user!**
99
+
The next step is to choose a connection method. Click **Drivers** and then copy the connection string down below (the driver doesn't matter).
106
100
107
101

108
102
109
-
Example connection string format (not yours): `mongodb+srv://modmail:[email protected]`
103
+
**Replace the `<db_password>` within the connection string with the password you set when creating the database user!**
110
104
111
105
Paste your connection string that you copied here (remember to replace `<db_password>` with the database user's password):
Choose a memorable name for your Logviewer. You will be provided with a log URL under our **.modmail.dev** domain name. You can choose anything you like (with a few restrictions), if you feel it's reasonable, then most likely we do too! Note: only 3-16 alphanumeric characters are allowed.
111
+
Choose a name for your Logviewer. We will provide you with a free log URL under our **.modmail.dev** domain name. You can choose anything you like (with a few restrictions), if you feel it's reasonable, then we most likely do too! Note: only 3-16 alphanumeric characters are allowed.
118
112
119
113
Format (replace **yourchosenname** with your desired name): `https://yourchosenname.modmail.dev/`
Congrats! That should be everything we need. If you filled in all the input boxes, there should be 4-5 lines of data generated between **START** and **END**.
@@ -149,5 +142,5 @@ There you go! You should be all set :D
149
142
After sending all the details back to the Patreon Modmail DM, we will validate everything you sent us. This process might take a few hours depends on our availability, so please bear with us while you wait. We will contact you when the bot is running or if there are any problems!
150
143
151
144
152
-
> This guide is written by taku#3343 with parts taken from the [Modmail Wiki](https://github.com/kyb3r/modmail/wiki/Installation).<br>
145
+
> This guide is written by taku with parts taken from the [Modmail Wiki](https://github.com/kyb3r/modmail/wiki/Installation).<br>
153
146
> If you have found any issues with this guide, please report them to me. Thanks ❤️!
0 commit comments