Skip to content

Commit 0aa9143

Browse files
Update documentation for tootctl self-destruct
Fixes #1593
1 parent 481d645 commit 0aa9143

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

content/en/admin/tootctl.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,22 @@ RAILS_ENV=production bin/tootctl help
3030

3131
### `tootctl self-destruct` {#self-destruct}
3232

33-
Erase this server from the federation by broadcasting account Delete activities to all known other servers. This allows a "clean exit" from running a Mastodon server, as it leaves next to no cache behind on other servers. This command is always interactive and requires confirmation twice.
33+
Erase this server from the federation by broadcasting account `Delete` activities to all known other servers. This allows a "clean exit" from running a Mastodon server, as it leaves next to no cache behind on other servers. This command is always interactive and requires confirmation twice.
34+
35+
Prior to Mastodon 4.3.0, deletion jobs are enqueued immediately when running this command. Since Mastodon 4.3.0, this command will instead print out instructions to switch the server to self-destruct mode, which is responsible for sending the `Delete` activities. When a server is in self-destruct mode, it will also allow its users to log in and download their data, but it will not allow them to perform any other action. Calling `tootctl self-destruct` again on a server in self-destruct mode will print information on the progress of the self-destruction process.
3436

3537
No local data is actually deleted because emptying the database or deleting the entire VPS is faster. If you run this command and then continue to operate the instance anyway, then there will be a state mismatch that might lead to glitches and issues with federation.
3638

3739
{{< hint style="danger" >}}
3840
**Make sure you know exactly what you are doing before running this command.** This operation is NOT reversible, and it can take a long time. The server will be in a BROKEN STATE after this command finishes. A running Sidekiq process is required, so do not shut down the server until the queues are fully cleared.
3941
{{< /hint >}}
4042

41-
`--dry-run`
42-
: Print expected results only, without performing any actions.
43+
`--dry-run` {{%removed%}}
44+
: Print expected results only, without performing any actions. Removed in 4.3.0
4345

4446
**Version history:**\
45-
2.8.0 - added
47+
2.8.0 - added\
48+
4.3.0 - removed `--dry-run`, introduced self-destruct mode
4649

4750

4851
---

0 commit comments

Comments
 (0)