|
1 | 1 | <div align="center"> |
2 | | - <img src="https://modmail-docs.netlify.app/logo-long.png" align="center"> |
3 | 2 | <br> |
4 | 3 | <strong><i>Fork² of a feature-rich Modmail bot for Discord written in Python.</i></strong> |
5 | 4 | <br> |
6 | 5 | <br> |
7 | | - |
8 | | - <a href="#"> |
9 | | - <img src="https://img.shields.io/badge/Version-4.1.0-7d5edd?style=shield&logo=https://modmail-docs.netlify.app/favicon.png"> |
10 | | - </a> |
11 | | - <a href="https://www.python.org/downloads/"> |
12 | | - <img src="https://img.shields.io/badge/Compatible%20With-Python%203.12%20|%203.13-blue.svg?style=shield&logo=Python" alt="Made with Python 3.12"> |
13 | | - </a> |
14 | | - <a href="https://github.com/ambv/black"> |
15 | | - <img src="https://img.shields.io/badge/Code%20Style-Black-black?style=shield"> |
16 | | - </a> |
17 | | - <a href="https://github.com/khakers/modmail/blob/master/LICENSE"> |
18 | | - <img src="https://img.shields.io/badge/license-agpl-e74c3c.svg?style=shield" alt="AGPL-3.0-or-later"> |
19 | | - </a> |
20 | | - |
21 | 6 | <img src='https://github.com/raidensakura/modmail/assets/38610216/106e8fa3-6f8e-4b00-9968-f5c2f3108da0' align='center' width=500> |
22 | 7 | </div> |
23 | 8 |
|
24 | 9 | > [!NOTE] |
25 | | -> This is a semi-maintained *hard* fork of modmail by khakers based on [raidensakura](https://github.com/raidensakura)'s fork |
| 10 | +> This is a *hard* fork of modmail by khakers based on [raidensakura](https://github.com/raidensakura)'s fork |
26 | 11 | > of modmail. |
27 | 12 | > This fork is not affiliated with the original modmail project. |
28 | | -> It was done to add features that were not being added to the original modmail project due to its inactivity and to |
29 | | -> better align with what I wanted for modmail-viewer. |
| 13 | +> |
| 14 | +> It was done to add features that were not being added to the original modmail project due slow PR merges and to |
| 15 | +> better align with what I wanted for modmail-viewer (and now modmail-view-ts). |
30 | 16 | > You probably shouldn't use this, but if you for some reason do, it does have some extra features, fixes, and bugs. |
| 17 | +> I try to fix issues that I've caused as quickly as is reasonable, but my time is very limited. |
31 | 18 |
|
32 | 19 | I am the developer of [modmail-viewer](https://github.com/khakers/modmail-viewer) and [modmail-viewer-ts](https://github.com/khakers/modmail-viewer-ts), which are the recommended way to view |
33 | 20 | logs for this fork. |
@@ -60,47 +47,23 @@ logs for this fork. |
60 | 47 |
|
61 | 48 | ## Installation |
62 | 49 |
|
63 | | -> [!Important] |
64 | | -> This has not been updated, you should deploy modmail with docker whenever possible. |
65 | | -
|
66 | | -This is a general installation guide. Refer to the [documentation](https://modmail-docs.netlify.app) for detailed user guide. |
67 | | - |
68 | | -This guide assumes you have git, and a supported Python version installed and added to system PATH. |
69 | | - |
70 | | -1. Clone the repository |
71 | | - ```console |
72 | | - $ git clone https://github.com/khakers/openmodmail |
73 | | - $ cd modmail |
74 | | - ``` |
75 | | -2. Create a Discord bot account, grant the necessary intents, and invite the bot. |
76 | | -3. Create a free MongoDB database. |
77 | | -4. Rename the file `.env.example` to `.env` and fill it with appropriate values |
78 | | -5. Update pip |
79 | | - ```console |
80 | | - $ pip install -U pip |
81 | | - ``` |
82 | | -6. [Install PDM](https://pdm.fming.dev/latest/#recommended-installation-method) |
83 | | -7. Install dependencies using PDM |
84 | | - ```console |
85 | | - $ pdm sync |
86 | | - ``` |
87 | | -8. Start the bot |
88 | | - ```console |
89 | | - $ pdm run bot |
90 | | - ``` |
91 | | - |
92 | 50 | ### Running the Docker Image |
93 | 51 |
|
94 | 52 | This guide assume you already have Docker or Docker Compose installed. |
95 | 53 |
|
96 | 54 | - Running with docker: |
97 | 55 | ```console |
98 | | - $ docker run --env-file=.env --name=modmail ghcr.io/khakers/openmodmail:stable |
| 56 | + $ docker run --env-file=.env --name=modmail ghcr.io/khakers/openmodmail:latest |
99 | 57 | ``` |
100 | 58 | - Running with Docker Compose: |
101 | 59 | ```console |
102 | 60 | $ docker compose up -d |
103 | 61 | ``` |
| 62 | +> [!NOTE] |
| 63 | +> You should always view the docker compose file to understand the services that it runs and modify it to your wishes. |
| 64 | +> |
| 65 | +> I always recommend using a specific tagged release or commit as your image ( i.e. ghcr.io/khakers/openmodmail:sha-32asfd7 or an immutable sha256 hash) |
| 66 | + |
104 | 67 | |
105 | 68 | ### Docker image tags |
106 | 69 |
|
|
0 commit comments