From dc5aeda06bf5b1426cc69a8038b985fa2d3c11c1 Mon Sep 17 00:00:00 2001 From: Luna Date: Fri, 22 Mar 2019 19:04:36 -0300 Subject: [PATCH] README: add note on docs/operating.md --- README.md | 5 ++++- docs/operating.md | 15 +++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 docs/operating.md diff --git a/README.md b/README.md index 4ee38a0..fb1e849 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ or third party libraries (such as [Eris](https://github.com/abalabahaha/eris)). Requirements: - **Python 3.7+** -- PostgreSQL (tested using 9.6+) +- PostgreSQL (tested using 9.6+), SQL knowledge is recommended. - gifsicle for GIF emoji and avatar handling - [pipenv] @@ -133,6 +133,9 @@ You can check if your instance is running by performing an HTTP `GET` request on the `/api/v6/gateway` endpoint. For basic websocket testing, a tool such as [ws](https://github.com/hashrocket/ws) can be used. +After checking that it actually works, `docs/operating.md` continues on common +operations for a Litecord instance. + ## Updating Update the code and run any new database migrations: diff --git a/docs/operating.md b/docs/operating.md new file mode 100644 index 0000000..b859cfe --- /dev/null +++ b/docs/operating.md @@ -0,0 +1,15 @@ +# Operating a Litecord instance + +`./manage.py` contains common admin tasks that you may want to do to the +instance, e.g make someone an admin, or migrate the database, etc. + +Note, however, that many commands (example the ones related to user deletion) +may be moved to the Admin API without proper notice. There is no frontend yet +for the Admin API. + +The possible actions on `./manage.py` can be accessed via `./manage.py -h`, or +`pipenv run ./manage.py -h` if you're on pipenv. + +## `./manage.py generate_token`? + +You can generate a user token but only if that user is a bot.