Skip to content

Commit e468ee6

Browse files
committed
Merge branch 'master' of https://github.com/verixx/modmail
2 parents 3207ba8 + 2ea9ee1 commit e468ee6

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
<img src="https://img.shields.io/badge/license-mit-e74c3c.svg?style=for-the-badge" alt="MIT License" />
3232
</a>
3333

34-
3534
</div>
3635
<br>
3736

@@ -49,7 +48,14 @@ You have two options for using this bot, hosting on Heroku or self hosting the b
4948

5049
## What is heroku?
5150

52-
Heroku is a container based cloud platform that offers free plans to host web applications. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Mod Mail to 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? Config and logs are stored in a [centralised web service](https://modmail.tk) hosted by us. This enables you to get started fast without having to worry about [anything](https://github.com/kyb3r/modmail/wiki/Installation#transparency).
51+
Heroku is a container based cloud platform that offers free plans to host web applications. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Mod Mail to 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? Config and logs are stored in a [centralised 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 centralised API service, you can self host your logs. You can do this by adding two config variables:
56+
57+
* `MONGO_URI` - Mongodb connection URI, you can get a free 500mb cluster from [mongodb atlas](https://www.mongodb.com/cloud/atlas).
58+
* `LOG_URL` - The url of your heroku app (`https://yourappname.herokuapp.com`)
5359

5460
## Features and Commands
5561
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).

0 commit comments

Comments
 (0)