README: add note on docs/operating.md

This commit is contained in:
Luna 2019-03-22 19:04:36 -03:00
parent 3b85556d89
commit dc5aeda06b
2 changed files with 19 additions and 1 deletions

View File

@ -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:

15
docs/operating.md Normal file
View File

@ -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.