Skip to content

Commit 2a12a8f

Browse files
committed
Merge from "master"
2 parents ddc4b02 + 6489af2 commit 2a12a8f

File tree

2 files changed

+14
-18
lines changed

2 files changed

+14
-18
lines changed

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,7 @@ When a user sends a direct message to the bot, a channel is created within an is
4444

4545
## Installation
4646

47-
Currently the easiest and fastest way to set up the bot is using Heroku. If you choose to install the bot using Heroku, you will not need to download anything. Read the **[installation guide](https://github.com/kyb3r/modmail/wiki/Installation)**. If you ran into any problems, join our [discord server](https://discord.gg/etJNHCQ) for help and support. Even if you don't have any issues, you should come and check out our awesome Discord community! :wink:
48-
49-
## What is Heroku?
50-
51-
Heroku is a container based cloud platform that currently offers a free plan to host web apps. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Modmail be accessible to anyone while still being feature-rich; it's a community run project that lets anyone get it up and running 24/7 for free. So how does our bot store data? Configs and logs are stored in a [centralized web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast. However, you do also have the option to self-host your data, check the installation guide for more info.
47+
Currently the easiest and fastest way to set up the bot is using Heroku which is a service that offers a free plan for hosting applications. If you choose to install the bot using Heroku, you will not need to download anything. Read the **[installation guide](https://github.com/kyb3r/modmail/wiki/Installation)**. If you ran into any problems, join our [discord server](https://discord.gg/etJNHCQ) for help and support. Even if you don't have any issues, you should come and check out our awesome Discord community! :wink:
5248

5349
## Notable Features
5450

app.json

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@
44
"repository": "https://github.com/kyb3r/modmail",
55
"env": {
66
"TOKEN": {
7-
"description": "Your discord bot's token.",
8-
"required": true
7+
"description": "Your discord bot's token.",
8+
"required": true
99
},
1010
"GUILD_ID": {
11-
"description": "The id for the server you are hosting this bot for.",
12-
"required": true
11+
"description": "The id for the server you are hosting this bot for.",
12+
"required": true
1313
},
1414
"OWNERS": {
15-
"description": "Comma separated user IDs of people that are allowed to use owner only commands. (eval and update).",
16-
"required": true
15+
"description": "Comma separated user IDs of people that are allowed to use owner only commands. (eval and update).",
16+
"required": true
1717
},
18-
"MODMAIL_API_TOKEN": {
19-
"description": "API token from https://modmail.tk.",
20-
"required": false
18+
"GITHUB_ACCESS_TOKEN": {
19+
"description": "Your personal access token for GitHub, adding this gives you the ability to use the 'update' command, which will sync your fork with the main repo.",
20+
"required": false
2121
},
2222
"MONGO_URI": {
23-
"description": "Mongo DB connection URI for self-hosting your data.",
24-
"required": false
23+
"description": "Mongo DB connection URI for self-hosting your data.",
24+
"required": true
2525
},
2626
"LOG_URL": {
27-
"description": "The url of the log viewer app for viewing self-hosted logs.",
28-
"required": false
27+
"description": "The url of the log viewer app for viewing self-hosted logs.",
28+
"required": true
2929
}
3030
}
3131
}

0 commit comments

Comments
 (0)