From 8e1d17f37a89e9b2f07347e18839ce12901e6242 Mon Sep 17 00:00:00 2001 From: EEKIM10 Date: Wed, 22 Feb 2023 01:38:27 +0000 Subject: [PATCH] add a basic info readme for tomorrow --- web/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 web/README.md diff --git a/web/README.md b/web/README.md new file mode 100644 index 0000000..f1785d1 --- /dev/null +++ b/web/README.md @@ -0,0 +1,12 @@ +The webserver for the bot will do the following: +* Handle uptime pings +* Provide authentication +* Replace the old email verification code system (replace it with a one-click link rather than a clunky code) +* Store some data for use in eastereggs like the "Nice argument" doxx response +* provide a basic API for some system related information + +The server will be located at `127.0.0.1:3762` with the intention of being accessed via reverse-proxy (namely @ https://droplet.nexy7574.co.uk/jimmy/). + +Discord auth will require OAUTH_ID, OAUTH_SECRET, and OAUTH_REDIRECT_URI to be set in the `config.py` file. + +The web server will auto-start, unless `NO_WEB=True` is set in the `config.py` file. \ No newline at end of file