From 7a927aac59bad94111ef585dc9770bfc92280e6d Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 21 Sep 2021 13:05:07 +0000 Subject: deploy: 9ffa787eb243c98a6ca1ecd9eac4a6b5dac2bef0 --- latest/admin_api/account_validity.html | 2 +- latest/admin_api/delete_group.html | 2 +- latest/admin_api/event_reports.html | 2 +- latest/admin_api/media_admin_api.html | 2 +- latest/admin_api/purge_history_api.html | 2 +- latest/admin_api/register_api.html | 2 +- latest/admin_api/room_membership.html | 2 +- latest/admin_api/rooms.html | 45 +++++++++++++++++++++++---------- latest/admin_api/server_notices.html | 2 +- latest/admin_api/statistics.html | 2 +- latest/admin_api/user_admin_api.html | 2 +- latest/admin_api/version_api.html | 2 +- 12 files changed, 42 insertions(+), 25 deletions(-) (limited to 'latest/admin_api') diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index 32633e1e68..b9d59da0fd 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/delete_group.html b/latest/admin_api/delete_group.html index ed7944d1e6..05728e5363 100644 --- a/latest/admin_api/delete_group.html +++ b/latest/admin_api/delete_group.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index 264f6aa528..e6de889685 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index 25b0b809cb..ae2edbfdf5 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/purge_history_api.html b/latest/admin_api/purge_history_api.html index 6354fccb22..e30a049b85 100644 --- a/latest/admin_api/purge_history_api.html +++ b/latest/admin_api/purge_history_api.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/register_api.html b/latest/admin_api/register_api.html index a8c7ea4ba8..81f4e9aca4 100644 --- a/latest/admin_api/register_api.html +++ b/latest/admin_api/register_api.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/room_membership.html b/latest/admin_api/room_membership.html index 5a0fc75170..a7fbe1aa53 100644 --- a/latest/admin_api/room_membership.html +++ b/latest/admin_api/room_membership.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index 496ac1297c..d80698c79e 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -99,7 +99,7 @@ @@ -602,34 +602,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
@@ -647,7 +664,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:

    @@ -667,7 +684,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 diff --git a/latest/admin_api/server_notices.html b/latest/admin_api/server_notices.html index 58758ec4ed..80a31a167b 100644 --- a/latest/admin_api/server_notices.html +++ b/latest/admin_api/server_notices.html @@ -99,7 +99,7 @@

    diff --git a/latest/admin_api/statistics.html b/latest/admin_api/statistics.html index 62d8554541..97a80bc442 100644 --- a/latest/admin_api/statistics.html +++ b/latest/admin_api/statistics.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index 8d9575cfb5..fc0b895c87 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/version_api.html b/latest/admin_api/version_api.html index 714c04f2be..9654515f81 100644 --- a/latest/admin_api/version_api.html +++ b/latest/admin_api/version_api.html @@ -99,7 +99,7 @@ -- cgit 1.5.1