This list only includes major contributors.
-See history in git (via `git clone https://public-inbox.org/public-inbox')
+See history in git (via `git clone https://public-inbox.org/public-inbox.git')
for a full history of the project.
* Eric Wong <e@80x24.org> (BDFL)
* spamc / spamd - SpamAssassin: http://spamassassin.apache.org/
* report-spam / dc-dlvr - distributed with public-inbox in the scripts/
- directory: git clone https://public-inbox.org/ public-inbox
+ directory: git clone https://public-inbox.org/public-inbox.git
# this is "xml" on FreeBSD and maybe some other distros:
XMLSTARLET = xmlstarlet
-AWK = awk
# same as pod2text
COLUMNS = 76
%.1 %.5 %.7 %.8 : Documentation/%.pod
$(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
-# n.b. not sure if our usage of man(1) is portable or not, so not
-# enabled by default "check" target:
-# check :: check-man
-check_man = @echo CHECK80 $<;COLS=80 $(MAN) ./$^ | \
- $(AWK) 'length>80{print;err=1}END{exit(err)}' >&2
+check :: check-man
+check_man = @echo CHECK80 $<;COLUMNS=80 $(MAN) ./$^ | \
+ $(AWK) '{gsub(/\b./,"")}length>80{print;err=1}END{exit(err)}' >&2
%.1.cols : %.1; $(check_man)
%.5.cols : %.5; $(check_man)
but may be disabled via
L<public-inbox-config(5)/publicinboxmda.spamcheck>
+=head1 OPTIONS
+
+=over 8
+
+=item --no-precheck
+
+By default, public-inbox-mda does some simple checks before
+invoking L<spamc(1)> since it is intended to receive mail before
+it goes to a mailing list.
+
+However, some users prefer to use public-inbox-mda to mirror
+mailing lists. This option exists to support those users.
+
+Using this option, the following prechecks are disabled:
+
+ * multiple Message-IDs
+ * non-existent Message-IDs
+ * Message-IDs longer than 244 characters long
+ * From: header shorter than 3 characters
+ * Subject: header shorter than 2 characters
+ * unusable Date: headers
+ * inbox address specified in To: or Cc: header
+
+=back
+
=head1 ENVIRONMENT
=over 8
=head1 DESCRIPTION
-public-inbox consists of many parts which may be used
+public-inbox consists of many pieces which may be used
independently or in conjunction of each other for:
=over 4
=item 2
-Mirroring mailing lists directly.
+Mirroring mailing lists.
=item 3
-Hosting standalone.
+Hosting standalone inboxes.
=back
you are mirroring and you only need to use two new commands in
addition to common L<git(1)> commands.
- git clone --mirror REMOTE_URL /path/to/repo.git
+Instructions are different depending on whether the inbox
+is L<public-inbox-v1-format(5)> or L<public-inbox-v2-format(5)>.
+See the "Archives are clonable:" part of the WWW interface
+of a given inbox for cloning instructions specific to
+that inbox. The instructions are roughly:
- # The following should create the necessary entry in
- # ~/.public-inbox/config
- public-inbox-init NAME /path/to/repo.git MY_URL LIST_ADDRESS
+ # for v1 inboxes:
+ git clone --mirror URL INBOX_DIR
- # Optional but strongly recommended for hosting HTTP
- # (and required for NNTP)
- # enable search (requires Search::Xapian and DBD::SQLite)
- public-inbox-index /path/to/repo.git
+ # for v2 inboxes (each epoch needs to be cloned):
+ git clone --mirror URL/EPOCH INBOX_DIR/git/EPOCH.git
- # Periodically update the repo with the following commands
- # to update the git repo and index new messages:
- cd /path/to/repo.git && git fetch && public-inbox-index
+ # The following should create the necessary entry in
+ # ~/.public-inbox/config, use "-V2" only for v2 inboxes:
+ public-inbox-init [-V2] NAME INBOX_DIR MY_URL LIST_ADDRESS
-See L</"Hosting public-inboxes"> below for info on how to expose
+ # Optional but strongly recommended for hosting HTTP
+ # (and required for NNTP)
+ # enable overview (requires DBD::SQLite) and, if Search::Xapian is
+ # available, search:
+ public-inbox-index INBOX_DIR
+
+ # Periodically fetch the repo using git-fetch(1)
+ # for v1 inboxes:
+ git --git-dir=INBOX_DIR fetch
+
+ # for v2 (in most cases, only the newest epoch needs to be fetched):
+ git --git-dir=INBOX_DIR/git/EPOCH.git fetch
+
+ # index new messages after fetching:
+ public-inbox-index INBOX_DIR
+
+See L</"Serving public-inboxes"> below for info on how to expose
your mirror to other readers.
-=head2 Mirroring mailing lists directly
+=head2 Mirroring mailing lists
-Mirroring existing mailing lists may be done by any reader
+Mirroring mailing lists may be done by any reader
of a mailing list using L<public-inbox-watch(1)>.
# This will create a new git repository:
- public-inbox-init NAME /path/to/repo.git MY_URL LIST_ADDRESS
+ public-inbox-init -V2 NAME INBOX_DIR MY_URL LIST_ADDRESS
Then, see the L<public-inbox-watch(1)> manual for configuring
-C<watch>, C<watchheader>, and the optional C<spamcheck> and
-C<watchspam> entries.
+C<watch>, C<watchheader>, C<listid> and the optional C<spamcheck>
+and C<watchspam> entries.
You will need to leave L<public-inbox-watch(1)> running to
keep the mailbox up-to-date as messages are delivered to
maintain the indices if they were created by
L<public-inbox-index(1)>
- public-inbox-index /path/to/repo.git
+ public-inbox-index INBOX_DIR
+
+Instead of using L<public-inbox-watch(1)>, using
+L<public-inbox-mda(1)> with the C<--no-precheck> option and
+relying on the C<listid> directive in L<public-inbox-config(5)>
+is also an option.
-=head2 Hosting standalone
+=head2 Hosting standalone inboxes
Using L<public-inbox-init(1)> to initialize the inbox as in the
other methods is recommended. See L<public-inbox-mda(1)> for
more details; but this also requires MTA-specific knowledge.
-=head2 Hosting public-inboxes
+=head2 Serving public-inboxes
Since public-inboxes are git repositories, they may be served to
remote clients via L<git-daemon(1)> as well as specialized HTTP
AGPL source code is available via git:
- git clone https://public-inbox.org/ public-inbox
- git clone git://repo.or.cz/public-inbox
+ git clone https://public-inbox.org/public-inbox.git
+ git clone https://repo.or.cz/public-inbox.git
torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox
See below for contact info.
use warnings;
use PublicInbox::Hval qw(ascii_html);
our $TOR_URL = 'https://www.torproject.org/';
-our $CODE_URL = 'https://public-inbox.org/';
-our $PROJECT = 'public-inbox';
+our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
# noop for HTTP.pm (and any other PSGI servers)
sub close {}
sub code_footer ($) {
my ($env) = @_;
my $u = PublicInbox::Hval::prurl($env, $CODE_URL);
- qq(AGPL code for this site: git clone <a\nhref="$u">$u</a> $PROJECT)
+ qq(AGPL code for this site: git clone <a\nhref="$u">$u</a>)
}
sub _html_end {
# Mail delivery agent for public-inbox, run from your MTA upon mail delivery
use strict;
use warnings;
-my $usage = 'public-inbox-mda < rfc2822_message';
+my $usage = 'public-inbox-mda [OPTIONS] < rfc2822_message';
+my $precheck = grep(/\A--no-precheck\z/, @ARGV) ? 0 : 1;
my ($ems, $emm);
sub do_exit {
$dst = PublicInbox::InboxWritable->new($dst);
# pre-check, MDA has stricter rules than an importer might;
-do_exit(0) unless PublicInbox::MDA->precheck($simple, $dst->{address});
+if ($precheck && !PublicInbox::MDA->precheck($simple, $dst->{address})) {
+ do_exit(0);
+}
$simple = undef;
my $spam_ok;
if ($spamc) {
my $path = mid2path($mid);
my $msg = `git --git-dir=$maindir cat-file blob HEAD:$path`;
like($msg, qr/\Q$list_id\E/, 'delivered message w/ List-ID matches');
+
+ # try a message w/o precheck
+ $simple = Email::Simple->new(<<EOF);
+To: You <you\@example.com>
+List-Id: <$list_id>
+
+this message would not be accepted without --no-precheck
+EOF
+ $in = $simple->as_string;
+ my ($out, $err) = ('', '');
+ IPC::Run::run([$mda, '--no-precheck'], \$in, \$out, \$err);
+ is($?, 0, 'mda OK with List-Id match and --no-precheck');
+ my $cur = `git --git-dir=$maindir diff HEAD~1..HEAD`;
+ like($cur, qr/this message would not be accepted without --no-precheck/,
+ '--no-precheck delivered message anyways');
}
done_testing();