diff --git a/README.md b/README.md index 26fb9c4..f8cd360 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ When a member sends a direct message to Modmail, the bot will create a channel (

An example of a Modmail thread.

-Our Logviewer will save the threads so your staff can view previous threads through their corresponding log link. ~~Here is an~~ [~~**example**~~](https://logs.modmail.dev/example). +Our Logviewer will save the threads so your staff can view previous threads through their corresponding log link. ~~Here is an~~ [~~**example**~~](https://publicmodmail.logs.vodka/logs/example). ## Features @@ -52,7 +52,7 @@ Visit our [installation page](installation/) for detailed instructions on settin ## Supporting the project -You have various options to help the project. Giving this repository a star is greatly appreciated. You can also help people that have trouble setting up Modmail at our [Discord server](https://discord.gg/etJNHCQ). +You have various options to help the project. Giving this repository a star is greatly appreciated. You can also help people that have trouble setting up Modmail at our [Discord server](https://discord.gg/cnUpwrnpYb). If you like to show your appreciation, consider supporting us on [**Patreon**](https://www.patreon.com/kyber)! diff --git a/configure-modmail-and-logviewer.md b/configure-modmail-and-logviewer.md index 9d07f4f..160005f 100644 --- a/configure-modmail-and-logviewer.md +++ b/configure-modmail-and-logviewer.md @@ -54,6 +54,6 @@ Star the repository before you start 😉 10. If you want, you can go over and check the application logs to see if everything is running smoothly. 11. Once the bot is online in your server, do `[your prefix]setup` (defaults `?`) and you are good to go! -Your bot is ready! Head over to Discord and try it out! If you have any issues, join the [Discord server](https://discord.gg/etJNHCQ). +Your bot is ready! Head over to Discord and try it out! If you have any issues, join the [Discord server](https://discord.gg/cnUpwrnpYb). **Make sure to give the bot Manage Channels, Manage Messages and View Audit Logs permissions!** diff --git a/frequently-asked-questions.md b/frequently-asked-questions.md index d1b58c7..e39b59f 100644 --- a/frequently-asked-questions.md +++ b/frequently-asked-questions.md @@ -28,7 +28,7 @@ Modmail is an open-source project, which means you can easily add or request new #### How do I become a support member? -To join our support team, join our [Discord server](https://discord.gg/etJNHCQ). One of the more experienced members will hold an interview to check if you fit the requirements. +To join our support team, join our [Discord server](https://discord.gg/cnUpwrnpYb). One of the more experienced members will hold an interview to check if you fit the requirements. #### Can I add commands to the bot? @@ -36,7 +36,7 @@ You can add commands to the bot using plugins. All currently approved plugins ca #### My bot is offline, what do I do? -Join our [Discord server](https://discord.gg/etJNHCQ) and DM Modmail. One of our support members will assist you and help you fix the issue. +Join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. One of our support members will assist you and help you fix the issue. #### How can I donate the developers? @@ -50,4 +50,4 @@ There is not much information we get about your instance of modmail, The only th #### Answer not found? -Feel free to join our [Discord server](https://discord.gg/etJNHCQ). People will gladly help you with any questions that you have! +Feel free to join our [Discord server](https://discord.gg/cnUpwrnpYb). People will gladly help you with any questions that you have! diff --git a/installation-1.md b/installation-1.md index a84c5fa..f9ab8c2 100644 --- a/installation-1.md +++ b/installation-1.md @@ -1,6 +1,6 @@ # Installation -**If you need help beyond this tutorial please join our support server and the support team will be happy to help you** [https://discord.gg/etJNHCQ](https://discord.gg/etJNHCQ) +**If you need help beyond this tutorial please join our support server and the support team will be happy to help you** [https://discord.gg/cnUpwrnpYb](https://discord.gg/cnUpwrnpYb) > **Self Hosting Tutorial**: https://taaku18.github.io/modmail/local-hosting/ diff --git a/installation-continued.md b/installation-continued.md index 83856b9..576999f 100644 --- a/installation-continued.md +++ b/installation-continued.md @@ -104,7 +104,7 @@ After that's done configuring, click the `View` button. It will redirect you to **6.10.** Click `Manage App` and go into the `Resources` tab, where you need to turn on the worker by clicking the pencil icon next to it. -**6.11.** If you want, you can go over and check the application logs to see if everything is running smoothly. If any unexpected errors pop up, join our [Discord server](https://discord.gg/etJNHCQ) and DM Modmail. The support members will help you figure out the issue and show you how to fix it. +**6.11.** If you want, you can go over and check the application logs to see if everything is running smoothly. If any unexpected errors pop up, join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. The support members will help you figure out the issue and show you how to fix it. **6.12.** Once the bot is online in your server, make sure to give it `Manage Channels`, `Manage Messages` and `View Audit Logs` permissions. If your bot is not online, recheck the previous steps above. @@ -112,7 +112,7 @@ After that's done configuring, click the `View` button. It will redirect you to *** -Congratulations! Your bot is ready! Head over to Discord and try it out! If you have any issues or questions, join the [Discord server](https://discord.gg/etJNHCQ). +Congratulations! Your bot is ready! Head over to Discord and try it out! If you have any issues or questions, join the [Discord server](https://discord.gg/cnUpwrnpYb). Make sure to setup permissions using this [handy guide](https://github.com/modmail-dev/modmail/wiki/Permissions)! diff --git a/installation/local-hosting-vps/windows.md b/installation/local-hosting-vps/windows.md index 7f92b40..98d4c5f 100644 --- a/installation/local-hosting-vps/windows.md +++ b/installation/local-hosting-vps/windows.md @@ -4,8 +4,89 @@ description: Deploy Modmail on a Windows machine. # Windows -TODO - ## Prerequisites +* Somewhat recent hardware / software. +* Stable internet connection from hosting server. +* The hosting server remains online 24/7. +* You have completed the initial steps: [invited your bot](../#create-a-discord-bot) and [created a MongoDB database](../#create-a-mongodb-database). +* Windows 10 or 11 (any varient) + +## Filling Enviornment Variables +Once you have finished the prerequsite steps, gather your: +* BotToken +* Logviewer URL (or what you plan on using if you haven't set it up yet.) +* Primary Guild (Server) ID +* Inbox Guild (Server) ID (if applicable) +* Bot Owner's ID (usually just your ID) +* Completed MongoURI + +Once you have done so, open the file `.env.example` included in your download in your preferred raw text editor of choice (Usually Notepad or Notepad++, however others exist. *Do not use Word, WordPad, or similar*) + + +Begin to fill in the information required: +``TOKEN=`` your bot’s token. + + +``LOG_URL=`` the URL of your log viewer. + + +``GUILD_ID=`` the ID of the server your bot operates in. + + +``OWNERS=`` your user ID (ie. OWNERS=9821302031291298, or if multiple owners, OWNERS=9821302031291298,9781239213813229,924822913921391). + + +``MONGO_URI=`` your Mongo connection URI from the MongoDB setup. + + +Together, they should resemble something similar to the original ``.env.example`` file. + + +Save the file as ``.env`` when done. + +It should look something like this: +{% code title=".env" %} +```py +TOKEN=yourbottokengoeshere +LOG_URL=https://example.logs.vodka/ +GUILD_ID=1079074933008781362 +OWNERS=188363246695219201,231595246213922828 +MONGO_URI=mongodb+srv://username:password@cluster0-abcde.mongodb.net/ +``` +{% endcode %} + +## Installing Python + +Download Python and set up Python from official Python download page: https://www.python.org/downloads/. The pre-installed Python on your local machine is usually out of date, you need the version of Python 3.09 for Modmail. + +> The version of Python required may change overtime. Use the version that is recommended in this guide, and then reach out to us in the Support Server if that gives you problems. We will attempt to keep these guides as up to date as possible, however, this is the one place where a potiental version mismatch could occur. + +## Running Modmail + +Open Command Prompt, or "cmd". You can do this in one of two ways. + +1. Press the Windows Key, then type "cmd" and press enter. +2. Hold down the Windows Key + R, a Run Dialog will appear, type in "cmd" and press enter. + +### Navigate to where you stored Modmail + +Find the path of where you located your modmail in File Explorer, right click the folder name `modmail` or `modmail-master` and click "Copy Path". + +Then go back to your Command Prompt, and type ``cd `` then right click and press paste. This will paste in the path of the folder you just found in File Explorer. Press enter to change to that directory. + +### Install the requirements + +Run this command: +```py -3.9 -m pip install pipenv && py -3.9 -m pipenv install``` + +This will install the pipenv package, and then use it to install the most up-to-date list of dependencies from our dependency list. + +### Start your Modmail + +To start the Modmail bot itself, run this command: +```py -3.9 -m pipenv run python bot.py``` + +Your Modmail should now be working properly. If you are still having issues, let us know in our [support server](https://discord.gg/zmdYe3ZVHG). + ## Updating diff --git a/installation/railway.md b/installation/railway.md index b15a2aa..b287180 100644 --- a/installation/railway.md +++ b/installation/railway.md @@ -280,7 +280,7 @@ You can disable auto-updates by heading to the settings page for **both** your M Now that you've successfully set up Modmail, visit the [Getting Started](../getting-started.md) page to find information on using Modmail. -You can also join our [**Discord Server**](https://discord.gg/etJNHCQ) to interact with our community or get support for Modmail. +You can also join our [**Discord Server**](https://discord.gg/cnUpwrnpYb) to interact with our community or get support for Modmail. diff --git a/permissions.md b/permissions.md index 609e287..bc4d852 100644 --- a/permissions.md +++ b/permissions.md @@ -38,4 +38,4 @@ Examples: *** -If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/etJNHCQ) and DM Modmail. One of our support members will help you. +If you need help setting up permissions, feel free to join our [Discord server](https://discord.gg/cnUpwrnpYb) and DM Modmail. One of our support members will help you.