Skip to content

Commit 80f364d

Browse files
committed
Update readme
1 parent e63e341 commit 80f364d

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Modmail v5 - WIP, UNSTABLE BUILD
22

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
411
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
512
- Replace `DBTYPE` with `mongodb` or `sqlite`, only these two are supported at the moment
613
3. Start the bot with `uv run python start.py`
714

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.
916
You will need to drop the database when the structure changes.
1017

1118
### Short-Term TODOs
@@ -20,6 +27,6 @@ You will need to drop the database when the structure changes.
2027

2128
## Acknowledgements
2229

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.
2431
Special thanks to the original Modmail dev team (kyb3r, fourjr, Taaku18) for their work,
2532
and to the contributors of the original Modmail bot for their help in making this project possible.

config.yaml.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ sql_config:
9191
# Required: The SQL connection URI, supported SQL databases are:
9292
# * SQLite
9393
# Example for SQLite: "sqlite+aiosqlite:///modmail.db"
94-
# Example for PostgreSQL: "postgresql+asyncpg://user:password@localhost/modmail"
94+
# Example for PostgreSQL (does not work yet): "postgresql+asyncpg://user:password@localhost/modmail"
9595
# For SQLite, in-memory database is not supported, you must use a file.
9696
uri: "sqlite+aiosqlite:///modmail.db"
9797

0 commit comments

Comments
 (0)