Add some basic admin API docs

This commit is contained in:
Erik Johnston 2016-07-28 14:56:09 +01:00
parent 7861cfec0a
commit 367b594183
3 changed files with 46 additions and 0 deletions

12
docs/admin_api/README.rst Normal file
View file

@ -0,0 +1,12 @@
Admin APIs
==========
This directory includes documentation for the various synapse specific admin
APIs available.
Only users that are server admins can use these APIs. A user can be marked as a
server admin by updating the database directly, e.g.:
``UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'``
Restarting may be required for the changes to register.