summary refs log tree commit diff
path: root/docs/admin_api/shutdown_room.md
diff options
context:
space:
mode:
authorTravis Ralston <travpc@gmail.com>2020-08-07 10:16:24 -0600
committerGitHub <noreply@github.com>2020-08-07 17:16:24 +0100
commit1048ed2afacf8f343fb269c696d97eb0f707264a (patch)
tree8197d6f6638a50da54c9c87e9f24b02b21868812 /docs/admin_api/shutdown_room.md
parentAdd a comment about SSLv23_METHOD (#8043) (diff)
downloadsynapse-1048ed2afacf8f343fb269c696d97eb0f707264a.tar.xz
Clarify that undoing a shutdown might not be possible (#8010)
Diffstat (limited to 'docs/admin_api/shutdown_room.md')
-rw-r--r--docs/admin_api/shutdown_room.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/admin_api/shutdown_room.md b/docs/admin_api/shutdown_room.md
index 2ff552bcb3..9b1cb1c184 100644
--- a/docs/admin_api/shutdown_room.md
+++ b/docs/admin_api/shutdown_room.md
@@ -79,13 +79,20 @@ Response:
 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.
+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
+to recover at all:
 
-1. For safety reasons, it is recommended to shut down Synapse prior to continuing.
+* If the room was invite-only, your users will need to be re-invited.
+* If the room no longer has any members at all, it'll be impossible to rejoin.
+* The first user to rejoin will have to do so via an alias on a different server.
+
+With all that being said, if you still want to try and recover the room:
+
+1. For safety reasons, shut down Synapse.
 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).
+3. Restart Synapse.
 
 You will have to manually handle, if you so choose, the following: