Allow Database Access from Anywhere
+
Set IP Address to 0.0.0.0/0, then click Add Entry.
+
@@ -193,7 +203,7 @@ On the following **Security Quickstart** page, do the following:
1. Authentication method: _Username and Password_
- Username: `modmail`
+ Username: `modmail` *(You can use anything you wish for this field, however, keep it short and avoid any special characters. For most users, we recommend keeping `modmail`.)*
Password: Click **Autogenerate Secure Password** - don't type your own password!
2. Copy and **save the password** in your Notepad, you will need this for later.
@@ -264,7 +274,7 @@ You finished the MongoDB steps! At this point, your bot should still be **offlin
Once you have finished the previous steps, gather and save the variables listed below as they will be needed to run your bot in later steps:
* `TOKEN` - The token to run your Modmail application under your Discord bot account
-* `LOG_URL` - Logviewer URL that will be used to view threads in your web browser. *Please view the below **Danger** block if you do not intend on using a Logviewer.
+* `LOG_URL` - Logviewer URL that will be used to view threads in your web browser. *Please view the below **danger** block if you do not intend on using a Logviewer.*
* `GUILD_ID` - The ID of the main Discord server that your bot will operate in.
* `MODMAIL_GUILD_ID` - **\[Optional]** The ID of the Discord server that your bot will create ticket channels in. This is only needed if you want your ticket channels to be created in a separate server, for an example, Staff Server.
* `OWNERS` - The user ID of the Discord accounts you want to set as owner for the bot. Can consist of multiple users, separated by comma.
@@ -283,13 +293,17 @@ CONNECTION_URI=mongodb+srv://username:password@cluster0-abcde.mongodb.net/
{% endcode %}
{% hint style="danger" %}
-**DANGER!!** - `LOG_URL` Enviornment Variable without a Logviewer
+**DANGER** - `LOG_URL` Enviornment Variable without a Logviewer
*This is only relevant if you choose not to use a logviewer with your Modmail Instance, if you intend on having a fully featured instance, you can safely ignore this block.*
If you do not intend on using a Logviewer for your Modmail Instance, you must still ensure `LOG_URL` is set to a valid FQDN (Fully Qualified Domain Name). You can leave it as `example.com` or change it to anything else, but, do **not** delete the row, or set a value that is not an FQDN. `none`, `local`, `12032`, etc are **not** FQDNs.
-If you set the `LOG_URL` to an invalid FQDN, Discord will not handle it well and you will experience issues with thread creation.
+If you set the `LOG_URL` to an invalid FQDN, Discord will not be able to render it properly and you will experience issues with thread creation.
+{% endhint %}
+
+{% hint style="success" %}
+Congratulations! You have now completed all of the backend setup steps to get your Modmail ready, you can now move on to getting it deployed with the host of your choice. If you haven't chosen your host yet, check out our [Choosing a Host considerations](../choose-host/README.md).
{% endhint %}
@@ -305,7 +319,9 @@ A platform as a service (PaaS) that offers relatively low cost plans, which allo
### [Local Hosting](local-hosting-vps/) (free)
-If you have an old PC, a Raspberry Pi, or a Linux box that you're able to keep online 24/7, you can also host Modmail with your own machine at home. Since Modmail doesn't require intensive resources to run, you can get by with a system having as low as 1GB of RAM. Setting it up can be quite advanced but you have complete control over your bot instance. Refer to our local hosting guide supporting a few popular OSes by clicking [here](./#local-hosting-free).
+If you have an old PC, a Raspberry Pi, or a Linux box that you're able to keep online 24/7, you can also host Modmail with your own machine at home. Since Modmail doesn't require intensive resources to run, you can get by with a system having as low as 1GB of RAM. Setting it up can be quite advanced but you have complete control over your bot instance. Refer to our local hosting guide supporting a few popular OSes by clicking [here](local-hosting-vps/).
+
+> A tip for Local Hosting: if you don't want to, don't know how to, or don't feel comfortable exposing your local machine to the internet for the Logviewer component of Modmail, Lorenzo from the Modmail team offers FREE logviewer hosting! Check it out [here](./free-logviewer.md)
### [Modmail Team Hosting](https://buymeacoffee.com/modmaildev) (paid)
@@ -313,10 +329,14 @@ We offer paid hosting solution for your Modmail bot. Hosting Modmail with us cos
We will also fully manage your bot hosting for you, so you don't need to worry about upgrading or setting up your own host server. Refer to our [Patreon Hosting here](https://buymeacoffee.com/modmaildev).
+See guide [Modmail Panel Hosting](./modmail-panel.md)
+
### [modmail.lvh.lol](https://modmail.lvh.lol) (paid)
Run by a member of our community, this hosting provider has a purpose built software stack for hosting Modmail, logviewer not included.
+See guide [Modmail Panel Hosting](./modmail-panel.md).
+
### [Heroku](heroku.md) (paid)
Another popular PaaS that's used to be free. However, their recent pricing adjustments, it now costs $5-7 USD per month to host Modmail.
diff --git a/installation/community-guides.md b/installation/community-guides.md
index 214ca85..5177cc9 100644
--- a/installation/community-guides.md
+++ b/installation/community-guides.md
@@ -14,6 +14,8 @@ An online code execution environment that costs $7 USD per month. However, hosti
{% hint style="warning" %}
Replit is on the Modmail Team's unrecommended hosts list. See more details on the [unrecommended hosts page](../choose-host/unrecommended-hosts.md)
+
+**The Modmail team does not provide any support of any kind to anyone hosting with Repl.it.**
{% endhint %}
## [Oracle Guide](https://docs.lidistat67.eu/) by lidistat67
diff --git a/installation/free-logviewer.md b/installation/free-logviewer.md
new file mode 100644
index 0000000..e27a769
--- /dev/null
+++ b/installation/free-logviewer.md
@@ -0,0 +1,98 @@
+---
+description: How to setup Lorenzo's Free Logviewer Hosting
+---
+
+# Free Logviewer Hosting from Lorenzo
+
+
+[Lorenzo](https://lvh.lol), a long time contributor, supporter, and administrator in our community provides a free logviewer hosting service at this own expense to members of the Modmail community. Hosting using this service is facilitated through the Modmail project's official Discord server, which you can join [here](https://discord.gg/cnUpwrnpYb).
+
+
+## Limitations
+* You can only host three free logviewers with this service. Using secondary accounts, or other methods to bypass this limit may result in permanent restriction from the service. Please do not take abuse Lorenzo's selfless generosity. (He is providing this completely at his own expense.)
+ * If you wish to host additional logviewers with this service, DM our Modmail and you may be able to work out a deal at Lorenzo's discussion.
+* Logviewers hosted can only be subdomains of the `logs.vodka` domain. (Ex: `[yourlogviewenamehere].logs.vodka`).
+
+## Requirements
+* Join our Discord Server
+* Host your MongoDB connection URI using MongoDB Atlas (locally hosted databases are not supported).
+* Set your MongoDB database Network Security to be accessible from anywhere. *See an excerpt of our [installation guide](./README.md) below if you did not do this during installation.)
+
+Set IP Address to 0.0.0.0/0, then click Add Entry.
This is the Login page for the panel, press "Login with Discord" to get started.
This is the homepage of the panel once you have logged in. Press Create Instance to begin.
Enter the correct values into each of the fields shown, press the **Save Settings** box when completed.
After saving settings, you will receive a confirmation prompt to ensure you wish to change your bot's values, press **Ok**.
Press Start to boot up your instance for the first time.
Below your bot's settings, you can see the logs of your bot at any time. During setup it will simply display "(Waiting for bot to initialize...)". If there are issues during setup they will display here when you press Refresh.
Below your bot's settings, you can see the logs of your bot at any time. During setup it will simply display "(Waiting for bot to initialize...)". If there are issues during setup they will display here when you press Refresh.
Your logs will look something similar to this once your setup is complete.
Each bot has its own sharing settings, so if you'd like to share multiple bots, you'll need to do one at a time.
Paste the user you wish to share access with in the field labeled User ID then press the + button.
A new Shared With Me section will appear for all users with Modmail instances shared with them.
