tileradotorg/synapse
1
0
Fork 0
forked from MirrorHub/synapse
Code Pull requests Activity

Improve documentation on becoming server admin (#13230)

Browse source 
* 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 28619134+jejo86@users.noreply.github.com

* 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 <olivier@librepush.net>
This commit is contained in:
jejo86 2022-08-03 12:15:23 +02:00 committed by GitHub
parent fb7a2cc4cc
commit 668597214f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/13230.doc Normal file
View file

@ -0,0 +1 @@
Add steps describing how to elevate an existing user to administrator by manipulating the database.

3
docs/usage/administration/admin_api/README.md
View file

@ -5,8 +5,9 @@
Many of the API calls in the admin api will require an `access_token` for a Many of the API calls in the admin api will require an `access_token` for a
server admin. (Note that a server admin is distinct from a room admin.) server admin. (Note that a server admin is distinct from a room admin.)
A user can be marked as a server admin by updating the database directly, e.g.: 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.
```sql ```sql
UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'; UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';
``` ```