Skip to content

Commit 665aee6

Browse files
Nov 30 Docs Update (#56)
* Nov 30 Docs Update - Remove additional hosting considerations page. (I do not feel like the information I was intending on putting there is substantial enough for its own page, and most of it is not relevant for most users) - Move setting-up-auto-restart into the local hosting vps category. It does not make sense for it to be on its own because the guide only applies to local hosting/vps - Add details regarding the official hosting on the recommended hosts page - Remove Windows 10 from the list of supported local hosting operating systems, and add it to the list of OS's no longer recieving security updates - Add instructions in Windows hosting guide to note the requirement to turn on file extension viewing to create a file named ".env" - Expand on reasons for not supporting wispbyte hosting - add note that wispbyte was previously pylex - add embiotic hosting to our list of unrecommended hosts - delete page for video tutorials as we do not have any at this time, or a plan for any in the near future - Edit the updating page to remove mention of bot updating automatically by default as this is no longer the case. - Update heroku pricing and student offer information * Update installation/heroku.md to reflect in years instead of months Co-authored-by: Cyrus Yip <cyruscmyip1@gmail.com> Signed-off-by: Stephen <48072084+StephenDaDev@users.noreply.github.com> --------- Signed-off-by: Stephen <48072084+StephenDaDev@users.noreply.github.com> Co-authored-by: Cyrus Yip <cyruscmyip1@gmail.com>
1 parent 7ea7f79 commit 665aee6

File tree

10 files changed

+37
-19
lines changed

10 files changed

+37
-19
lines changed
39.8 KB
Loading

SUMMARY.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
* [Introduction](README.md)
44
* [Choosing a Host](choose-host/README.md)
5-
* [Additional Considerations](choose-host/choose-host1.md)
65
* [Recommended Hosts](choose-host/recommended-hosts.md)
76
* [Unrecommended Hosts](choose-host/unrecommended-hosts.md)
87
* [Installation](installation/README.md)
@@ -16,10 +15,10 @@
1615
* [Alma Linux](installation/local-hosting-vps/almalinux.md)
1716
* [Logviewer](installation/local-hosting-vps/logviewer.md)
1817
* [Patreon logviewer](installation/local-hosting-vps/patreon\_logviewer.md)
18+
* [Setting up auto-restart](installation/local-hosting-vps/setting-up-auto-restart.md)
1919
* [Railway](installation/railway.md)
2020
* [Heroku](installation/heroku.md)
2121
* [Community Guides](installation/community-guides.md)
22-
* [Setting up auto-restart](setting-up-auto-restart.md)
2322
* [Updating](updating.md)
2423
* [Getting Started](getting-started.md)
2524
* [Usage](usage-guide/README.md)
@@ -38,4 +37,3 @@
3837
* [Frequently Asked Questions](<frequently-asked-questions (1).md>)
3938
* [Modmail Usage](modmail-usage.md)
4039
* [Updating](<updating (1).md>)
41-
* [Video Tutorials](video-tutorials.md)

choose-host/choose-host1.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

choose-host/recommended-hosts.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ description: These hosts are hosts we, and members of our community have had suc
77
{% hint style="info" %} The Modmail Team does not have any affiliation with any hosting providers or platforms. {% endhint %}
88

99
## Official Modmail Hosting
10-
[See details on the Hosting page](../choose-host/README.md).
10+
11+
The Modmail team provides official hosting of the bot using Buy Me a Coffee. Monthly plans start at $4/month.
12+
13+
Most plans also include premium logviewer, which allows locking a Loglink using OAuth Discord Login, and a dashboard.
14+
15+
Official Hosting is run on redundant servers with automatic failover.
16+
17+
See details on [Buy Me a Coffee](https://buymeacoffee.com/modmaildev/membership).
1118

1219
## VPS Providers
1320

choose-host/unrecommended-hosts.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,23 @@ description: These hosts are hosts we, and members of our community have had lit
2424

2525
- [Website](https://wispbyte.com/)
2626
- Similar setup and issues as Bot-Hosting.net — shared resources and inconsistent reliability.
27+
- Wispbyte's support team has also been seen to suggest random breaking changes to attempt to make the bot run. They do not work.
2728

2829
### Karlo Hosting
2930
- [Website](https://karlo-hosting.com/)
3031
- Another free or low cost hosting provider based on the Pterodactyl panel, our users have reported unusual difficulties deploying Modmail with this host due to their specific Pterodactyl configuration and limitations.
3132

33+
### Embotic Hosting
34+
- [Website](https://client.embotic.xyz/)
35+
- Despite claiming to provide a VPS, they do not do so, and hosting Modmail is likely not possible. See the response from company representatives below:
36+
37+
<details>
38+
39+
<summary>1x Screenshot</summary>
40+
<figure><img src="../.gitbook/assets/embotic-hosting.png" alt="It seems like the bot would simply not be compatible as it seems to need a higher level of permissons(system-level) which we do not provide for security reasons. You can try to find a workaround to run it in the userspace but I'm not sure wether that might work."></figure>
41+
42+
43+
</details>
3244

3345
{% hint style="danger" %}
3446
### Why These Are Not Recommended
@@ -40,4 +52,4 @@ These hosts generally:
4052

4153
If you value stability, security, and consistent uptime, avoid free or oversold shared hosts.
4254
Refer to [Choosing a Host](../choose-host/README.md) for guidance on reliable alternatives.
43-
{% endhint %}
55+
{% endhint %}

installation/heroku.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Heroku is a container-based cloud Platform as a Service (PaaS). Developers use H
1717

1818
## Costs
1919

20-
Unfortunately, Heroku is no longer free-of-charge. You will need at least their Eco plan, which currently costs $5 USD per month. See their [pricing page ](https://www.heroku.com/pricing)for more info and up-to-date prices.
20+
Unfortunately, Heroku is no longer free-of-charge. You will need at least their Eco plan, which currently costs $5 USD per month. See their [pricing page](https://www.heroku.com/pricing) for more info and up-to-date prices.
2121

22-
If you are a higher-education student, you may be eligible for their [student offer](https://www.heroku.com/github-students), which grants you $13 USD of credits per month for 12 months—enough to host Modmail free for one year.
22+
If you are a higher-education student, you *may* be eligible for their [student offer](https://www.heroku.com/github-students), which grants you $13 USD of credits per month for 24 months—enough to host Modmail free for two years.
2323

2424
## Fork our GitHub repositories
2525

installation/local-hosting-vps/patreon_logviewer.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,16 @@
22
description: Hosting the patreon logviewer on the cloud or on your own computer.
33
---
44

5-
# Patreon logviewer
5+
# Patreon Logviewer
6+
7+
{% hint style="danger" %}
8+
The Modmail team is no longer supporting or encouraging the self-hosting of the Patreon logviewer. This guide is saved for archive reasons only. This guide does not have any use to nearly any users. If you want to self-host the normal logviewer, this is supported. Please see the [Logviewer Hosting Guide](logviewer.md).
9+
{% endhint %}
10+
11+
12+
<details>
13+
14+
<summary>Archived Patreon Logviewer Guide</summary>
615

716
This logviewer hosting tutorial is written assuming you have already set up your bot and are running Ubuntu 20.04-22.04.
817

@@ -104,3 +113,5 @@ sudo pm2 start logviewer.sh --name "logviewer" && sudo pm2 save
104113
```
105114

106115
More info on how to use pm2 can be found [on pm2's website](https://pm2.keymetrics.io/docs/usage/quick-start/).
116+
117+
</details>

setting-up-auto-restart.md renamed to installation/local-hosting-vps/setting-up-auto-restart.md

File renamed without changes.

updating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Guide on how to update the Modmail bot.
44

55
# Updating
66

7-
Your Modmail is set to auto-update itself by default, but you can also run the `?update` command on your bot manually, replacing `?` with your bot prefix.
7+
You can run the `?update` command on your bot manually, replacing `?` with your bot prefix.
88

99
If for some reason your update command isn't working correctly, you can update your bot by going into your Modmail folder and pulling the latest changes from GitHub with the steps below.
1010

video-tutorials.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)