Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 6685972

Browse files
jejo86reivilibre
andauthored
Improve documentation on becoming server admin (#13230)
* Improved section regarding server admin Added steps describing how to elevate an existing user to administrator by manipulating a `postgres` database. Signed-off-by: jejo86 [email protected] * Improved section regarding server admin * Reference database settings Add instructions to check database settings to find out the database name, instead of listing all available PostgreSQL databases. * Add suggestions from PR conversation Replace config filename `homeserver.yaml`. with "config file". Remove instructions to switch to `postgres` user. Add instructions how to connect to SQLite database. * Update changelog.d/13230.doc Co-authored-by: reivilibre <[email protected]>
1 parent fb7a2cc commit 6685972

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

changelog.d/13230.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add steps describing how to elevate an existing user to administrator by manipulating the database.

docs/usage/administration/admin_api/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
Many of the API calls in the admin api will require an `access_token` for a
66
server admin. (Note that a server admin is distinct from a room admin.)
77

8-
A user can be marked as a server admin by updating the database directly, e.g.:
8+
An existing user can be marked as a server admin by updating the database directly.
99

10+
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.
1011
```sql
1112
UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';
1213
```

0 commit comments

Comments
 (0)