Skip to content

Commit 1e9cfc4

Browse files
authored
Update README.md
1 parent b1dd891 commit 1e9cfc4

File tree

1 file changed

+1
-14
lines changed

1 file changed

+1
-14
lines changed

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,11 @@ You have two options for using this bot, host on Heroku or self-host the bot. If
4848

4949
## What is Heroku?
5050

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.
52-
53-
## Self-hosted logs
54-
55-
If you want complete control over your data and do not want to use the centralized API service, you can self-host your logs. We recommend this if you want stability and security for your bot. You can do this by adding two config variables:
56-
57-
* `MONGO_URI` - MongoDB connection URI, you can get a free 500 MB cluster from [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
58-
* `LOG_URL` - The URL of your log viewer Heroku app (`https://yourlogviewerappname.herokuapp.com`)
59-
60-
Optionally if you want autoupdates (bot syncs your fork with origin) you can add another config var:
61-
* `GITHUB_ACCESS_TOKEN` - Personal access token you can get from your GitHub developer settings.
62-
63-
You also need to create a separate Heroku app for the log viewer that you can deploy from [here](https://github.com/kyb3r/logviewer).
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.
6452

6553
## Features and Commands
6654
The bot comes with a plethora of useful functionality. Take a look at the [list of commands](https://github.com/kyb3r/modmail/wiki/Features-and-commands).
6755

68-
6956
### Automatic Updates
7057
The bot checks for new updates every hour and automatically updates to a newer version if found. This bot is under active development so you can always look forward to new, useful features! If you do not want this functionality, for example, if you want to make changes to your fork, you can do so by adding a `disable_autoupdates` config variable.
7158

0 commit comments

Comments
 (0)