Skip to content

Commit 786903a

Browse files
authored
Update index.md
1 parent 0c5c998 commit 786903a

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

index.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,19 +66,15 @@ Please enter the ID of your server. If you're unsure where to find the server ID
6666

6767
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.
6868

69-
#### Video Tutorial (Slightly Outdated):
70-
71-
{% include video-guide.html %}
72-
7369
### Sign Up
7470

7571
[Sign-up for an account](https://www.mongodb.com/cloud/atlas/register){: target="_blank" rel="noopener"} and verify your email.
7672

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).
7874

7975
![MongoDB Personalization Questions](/assets/image/step4-1.png)
8076

81-
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!**
8278

8379
![MongoDB Deploy Cluster](/assets/image/step4-2.png)
8480

@@ -88,39 +84,36 @@ You should now see a quick setup pop-up window asking you to add connection IP a
8884

8985
#### IP Address Whitelist
9086

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.
9288

9389
![Whitelist IP](/assets/image/step4-3.gif)
9490

9591
#### Create Database User
9692

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.
9894

9995
![Create user](/assets/image/step4-4.gif)
10096

10197
#### Retrieve the Database Connection String
10298

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).
106100

107101
![Database URI](/assets/image/step4-5.gif)
108102

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!**
110104

111105
Paste your connection string that you copied here (remember to replace `<db_password>` with the database user's password):
112106

113107
**Connection String:** <input id="mongo" oninput="document.getElementById('enteredmongo').innerText = 'DATABASE_URI=' + this.value;">
114108

115109
### Step 5 - Choose a Logviewer Name
116110

117-
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.
118112

119113
Format (replace **yourchosenname** with your desired name): `https://yourchosenname.modmail.dev/`
120114

121115
**Logviewer Name:** <input id="logviewer" oninput="document.getElementById('enteredlogviewer').innerText = 'LOG_URI=' + this.value;">
122116

123-
124117
### Step 6 - Collecting Data
125118

126119
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
149142
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!
150143

151144

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>
153146
> If you have found any issues with this guide, please report them to me. Thanks ❤️!

0 commit comments

Comments
 (0)