mirror of
https://github.com/nexy7574/LCC-bot.git
synced 2024-09-19 01:53:39 +01:00
add a basic info readme for tomorrow
This commit is contained in:
parent
b27388a44a
commit
8e1d17f37a
1 changed files with 12 additions and 0 deletions
12
web/README.md
Normal file
12
web/README.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue