diff options
Diffstat (limited to 'docs/administration/admin_api/README.md')
| -rw-r--r-- | docs/administration/admin_api/README.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/administration/admin_api/README.md b/docs/administration/admin_api/README.md index f11e0b19a6..d42b2159df 100644 --- a/docs/administration/admin_api/README.md +++ b/docs/administration/admin_api/README.md @@ -7,7 +7,11 @@ server admin. (Note that a server admin is distinct from a room admin.) An existing user can be marked as a server admin by updating the database directly. -Check your [database settings](config_documentation.md#database) in the configuration file, connect to the correct database using either `psql [database name]` (if using PostgreSQL) or `sqlite3 path/to/your/database.db` (if using SQLite) and elevate the user `@foo:bar.com` to administrator. +Check your [database settings](../../usage/configuration/config_documentation.md#database) +in the configuration file, connect to the correct database using either +`psql [database name]` (if using PostgreSQL) or +`sqlite3 path/to/your/database.db` (if using SQLite) and elevate the user +`@foo:bar.com` to administrator. ```sql UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'; ``` @@ -19,7 +23,7 @@ already on your `$PATH` depending on how Synapse was installed. Finding your user's `access_token` is client-dependent, but will usually be shown in the client's settings. ## Making an Admin API request -For security reasons, we [recommend](reverse_proxy.md#synapse-administration-endpoints) +For security reasons, we [recommend](../../setup/reverse_proxy.md#synapse-administration-endpoints) that the Admin API (`/_synapse/admin/...`) should be hidden from public view using a reverse proxy. This means you should typically query the Admin API from a terminal on the machine which runs Synapse. @@ -35,7 +39,7 @@ For example, suppose we want to [query the account](user_admin_api.md#query-user-account) of the user `@foo:bar.com`. We need an admin access token (e.g. `syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk`), and we need to know which port -Synapse's [`client` listener](config_documentation.md#listeners) is listening +Synapse's [`client` listener](../../usage/configuration/config_documentation.md#listeners) is listening on (e.g. `8008`). Then we can use the following command to request the account information from the Admin API. |