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

Commit 1048ed2

Browse files
authored
Clarify that undoing a shutdown might not be possible (#8010)
1 parent de6f892 commit 1048ed2

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

changelog.d/8010.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add documentation for how to undo a room shutdown.

docs/admin_api/shutdown_room.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,20 @@ Response:
7979
the structure can and does change without notice.
8080

8181
First, it's important to understand that a room shutdown is very destructive. Undoing a shutdown is not as simple as pretending it
82-
never happened - work has to be done to move forward instead of resetting the past.
82+
never happened - work has to be done to move forward instead of resetting the past. In fact, in some cases it might not be possible
83+
to recover at all:
8384

84-
1. For safety reasons, it is recommended to shut down Synapse prior to continuing.
85+
* If the room was invite-only, your users will need to be re-invited.
86+
* If the room no longer has any members at all, it'll be impossible to rejoin.
87+
* The first user to rejoin will have to do so via an alias on a different server.
88+
89+
With all that being said, if you still want to try and recover the room:
90+
91+
1. For safety reasons, shut down Synapse.
8592
2. In the database, run `DELETE FROM blocked_rooms WHERE room_id = '!example:example.org';`
8693
* For caution: it's recommended to run this in a transaction: `BEGIN; DELETE ...;`, verify you got 1 result, then `COMMIT;`.
8794
* The room ID is the same one supplied to the shutdown room API, not the Content Violation room.
88-
3. Restart Synapse (required).
95+
3. Restart Synapse.
8996

9097
You will have to manually handle, if you so choose, the following:
9198

0 commit comments

Comments
 (0)