Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-12-17 04:24:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for undoing room shutdowns (#7998)

Browse Source 
These docs were tested successfully in production by a customer, so it's probably fine.
This commit is contained in:
Travis Ralston 2020-07-30 21:41:44 -06:00 committed by GitHub
parent 6d4b790021
commit e2a4ba6f9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/7998.doc Normal file
View File

@ -0,0 +1 @@
Add documentation for how to undo a room shutdown.

22
docs/admin_api/shutdown_room.md
View File

@ -33,7 +33,7 @@ You will need to authenticate with an access token for an admin user.
* `message` - Optional. A string containing the first message that will be sent as * `message` - Optional. A string containing the first message that will be sent as
`new_room_user_id` in the new room. Ideally this will clearly convey why the `new_room_user_id` in the new room. Ideally this will clearly convey why the
original room was shut down. original room was shut down.
If not specified, the default value of `room_name` is "Content Violation If not specified, the default value of `room_name` is "Content Violation
Notification". The default value of `message` is "Sharing illegal content on Notification". The default value of `message` is "Sharing illegal content on
othis server is not permitted and rooms in violation will be blocked." othis server is not permitted and rooms in violation will be blocked."
@ -72,3 +72,23 @@ Response:
"new_room_id": "!newroomid:example.com", "new_room_id": "!newroomid:example.com",
}, },
``` ```
## Undoing room shutdowns
*Note*: This guide may be outdated by the time you read it. By nature of room shutdowns being performed at the database level,
the structure can and does change without notice.
First, it's important to understand that a room shutdown is very destructive. Undoing a shutdown is not as simple as pretending it
never happened - work has to be done to move forward instead of resetting the past.
1. For safety reasons, it is recommended to shut down Synapse prior to continuing.
2. In the database, run `DELETE FROM blocked_rooms WHERE room_id = '!example:example.org';`
* For caution: it's recommended to run this in a transaction: `BEGIN; DELETE ...;`, verify you got 1 result, then `COMMIT;`.
* The room ID is the same one supplied to the shutdown room API, not the Content Violation room.
3. Restart Synapse (required).
You will have to manually handle, if you so choose, the following:
* Aliases that would have been redirected to the Content Violation room.
* Users that would have been booted from the room (and will have been force-joined to the Content Violation room).
* Removal of the Content Violation room if desired.