From 75259ef399da269a8fa81bab7b0d33ae7d13c0e4 Mon Sep 17 00:00:00 2001 From: richvdh Date: Mon, 6 Sep 2021 13:24:53 +0000 Subject: deploy: e1641b46d19c9745f512e623544b2bddfc89551d --- develop/print.html | 43 ++++++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 13 deletions(-) (limited to 'develop/print.html') diff --git a/develop/print.html b/develop/print.html index ab8945348b..ee674b8156 100644 --- a/develop/print.html +++ b/develop/print.html @@ -9929,34 +9929,51 @@ clients in a confused state. the old room to the new.
  • new_room_id - A string representing the room ID of the new room.
    • -

    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, +

    Undoing room deletions

    +

    Note: This guide may be outdated by the time you read it. By nature of room deletions 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 +

    First, it's important to understand that a room deletion is very destructive. Undoing a deletion is not as simple as pretending it 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:

    With all that being said, if you still want to try and recover the room:

      +
    1. +

      If the room was blocked, you must unblock it on your server. This can be +accomplished as follows:

      +
      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.
          • +
        • The room ID is the same one supplied to the delete room API, not the Content Violation room.
      3. Restart Synapse.
      -

      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.
        • -
      +

      This step is unnecessary if block was not set.

      +
      2. +
    2. +

      Any room aliases on your server that pointed to the deleted room may have +been deleted, or redirected to the Content Violation room. These will need +to be restored manually.

      +
      3. +
    3. +

      Users on your server that were in the deleted room will have been kicked +from the room. Consider whether you want to update their membership +(possibly via the Edit Room Membership API) or let +them handle rejoining themselves.

      +
      4. +
    4. +

      If new_room_user_id was given, a 'Content Violation' will have been +created. Consider whether you want to delete that roomm.

      +
      5. +

    Deprecated endpoint

    The previous deprecated API will be removed in a future release, it was:

    POST /_synapse/admin/v1/rooms/<room_id>/delete
@@ -9974,7 +9991,7 @@ optionally be specified, e.g.:

    Forward Extremities Admin API

    Enables querying and deleting forward extremities from rooms. When a lot of forward -extremities accumulate in a room, performance can become degraded. For details, see +extremities accumulate in a room, performance can become degraded. For details, see #1760.

    Check for forward extremities

    To check the status of forward extremities for a room:

    @@ -9994,7 +10011,7 @@ extremities accumulate in a room, performance can become degraded. For details, }

    Deleting forward extremities

    -

    WARNING: Please ensure you know what you're doing and have read +

    WARNING: Please ensure you know what you're doing and have read the related issue #1760. Under no situations should this API be executed as an automated maintenance task!

    If a room has lots of forward extremities, the extra can be -- cgit 1.5.1