You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,18 @@
1
1
# Modmail v5 - WIP, UNSTABLE BUILD
2
2
3
-
1. Fill in the configs from `config.yaml.example` and rename it to `config.yaml`
3
+
> [!CAUTION]
4
+
> This build of Modmail is currently a work in progress and is considered highly unstable and lacks essential features.
5
+
> It is not recommended for general usage at this time. Please use the stable v4 release for production environments at https://github.com/modmail-dev/modmail.
6
+
>
7
+
> No migration effort will be made between pushes, bugs and vulnerabilities are expected, and data loss may occur if used.
8
+
> We are also not accepting contributions through issues and pull requests for this branch at this time.
9
+
10
+
1. Copy `config.yaml.example` and rename it to `config.yaml`, then edit it with your settings
4
11
2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then run `uv sync --locked --compile-bytecode --no-default-groups --extra speed --extra DBTYPE` to install the dependencies
5
12
- Replace `DBTYPE` with `mongodb` or `sqlite`, only these two are supported at the moment
6
13
3. Start the bot with `uv run python start.py`
7
14
8
-
Please note that the database structure may change at any time, and database migrations between development versions are not available.
15
+
Please note that the database structure may change at any time, and database migrations between v5 alpha development versions are not available.
9
16
You will need to drop the database when the structure changes.
10
17
11
18
### Short-Term TODOs
@@ -20,6 +27,6 @@ You will need to drop the database when the structure changes.
20
27
21
28
## Acknowledgements
22
29
23
-
The current release of Modmail (v5) is a complete rewrite of the original Modmail bot.
30
+
The current release of Modmail (v5) is a complete relicensed rewrite of the original Modmail bot.
24
31
Special thanks to the original Modmail dev team (kyb3r, fourjr, Taaku18) for their work,
25
32
and to the contributors of the original Modmail bot for their help in making this project possible.
0 commit comments