diff options
| author | Erik Johnston <erikj@jki.re> | 2016-07-28 15:19:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-28 15:19:30 +0100 |
| commit | 591ad2268cc2ff0a402b64db737ce9ddc4d22bf0 (patch) | |
| tree | 4141c8143cb893dffc7520da6b734dd044c77bd8 /docs/admin_api/README.rst | |
| parent | Merge branch 'release-v0.17.0' of github.com:matrix-org/synapse into develop (diff) | |
| parent | Use correct path (diff) | |
| download | synapse-591ad2268cc2ff0a402b64db737ce9ddc4d22bf0.tar.xz | |
Merge pull request #963 from matrix-org/erikj/admin_docs
Add some basic admin API docs
Diffstat (limited to 'docs/admin_api/README.rst')
| -rw-r--r-- | docs/admin_api/README.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/admin_api/README.rst b/docs/admin_api/README.rst new file mode 100644 index 0000000000..d4f564cfae --- /dev/null +++ b/docs/admin_api/README.rst @@ -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. |