public-inbox-purge(1)

1PUBLIC-INBOX-PURGE(1)      public-inbox user manual      PUBLIC-INBOX-PURGE(1)
2
3
4

NAME

6       public-inbox-purge - erase messages from a public inbox and its history
7

SYNOPSIS

9               # requires ~/.public-inbox/config
10               public-inbox-purge --all </path/to/message-to-purge
11
12               # for testing with unconfigured inboxes:
13               public-inbox-purge $INBOX_DIR </path/to/message-to-purge
14

DESCRIPTION

16       public-inbox-purge allows removing entire messages in a given inbox
17       from history.  It is only intended as a last resort, as it will cause
18       discontiguous git history and draw more attention to the sensitive data
19       in mirrors.
20
21       For removing spam, public-inbox-learn(1) is preferable as it preserves
22       contiguous git history.
23
24       For editing sensitive information out of messages, consider
25       public-inbox-edit(1), instead, but keep in mind it still leads to
26       discontiguous git history.
27

OPTIONS

29       --all
30           Purge the message in all inboxes configured in
31           ~/.public-inbox/config.  This is an alternative to specifying
32           individual inboxes directories on the command-line.
33

ENVIRONMENT

35       PI_CONFIG
36               The default config file, normally "~/.public-inbox/config".
37               See public-inbox-config(5)
38

LIMITATIONS

40       Only public-inbox-v2-format(5) inboxes are supported.
41
42       This is safe to run while normal inbox writing tools
43       (public-inbox-mda(1), public-inbox-watch(1), public-inbox-learn(1)) are
44       active.
45
46       Running this in parallel with public-inbox-xcpdb(1) or
47       "public-inbox-index --reindex" can lead to errors or purged data
48       remaining indexed.
49
50       Incremental public-inbox-index(1) (without "--reindex") is fine.
51
52       Keep in mind this is a last resort, as it will be disruptive to anyone
53       using git(1) to mirror the inbox being purged.
54

CONTACT

56       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
57
58       The mail archives are hosted at <https://public-inbox.org/meta/> and
59       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
60

COPYRIGHT

62       Copyright 2019-2021 all contributors <mailto:meta@public-inbox.org>
63
64       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
65