---------------------------------------
This is for folks who want to setup their own public-inbox instance.
-Clients should use normal git-clone/git-fetch, or NNTP clients
+Clients should use normal git-clone/git-fetch, IMAP or NNTP clients
if they want to import mail into their personal inboxes.
public-inbox is developed on Debian GNU/Linux systems and will
* Git (1.8.0+, 2.6+ for writing v2 inboxes)
* Perl 5.10.1+
-* DBD::SQLite (needed for NNTP, message threading, and v2 inboxes)
+* DBD::SQLite (needed for IMAP, NNTP, message threading, and v2 inboxes)
To accept incoming mail into a public inbox, you'll likely want:
- DBD::SQLite deb: libdbd-sqlite3-perl
pkg: p5-DBD-SQLite
rpm: perl-DBD-SQLite
- (for v2, NNTP, or gzipped mboxes)
+ (for v2, IMAP, NNTP, or gzipped mboxes)
- Search::Xapian deb: libsearch-xapian-perl
pkg: p5-Search-Xapian
rpm: perl-Search-Xapian
- (HTTP search)
+ (HTTP and IMAP search)
- Net::Server deb: libnet-server-perl
pkg: pkg-Net-Server
rpm: perl-Net-Server
- (for HTTP/NNTP background daemons,
+ (for HTTP/IMAP/NNTP background daemons,
not needed as systemd services or
foreground servers)
- Email::Address::XS deb: libemail-address-xs-perl
pkg: pkg-Email-Address-XS
(correct parsing of tricky email
- addresses, phrases and comments)
+ addresses, phrases and comments,
+ required for IMAP)
+
+- Parse::RecDescent deb: libparse-recdescent-perl
+ pkg: p5-Parse-RecDescent
+ rpm: perl-ParseRecDescent
+ (optional, for public-inbox-imapd(1))
+
- Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl
pkg: p5-Plack-Middleware-ReverseProxy
- Linux::Inotify2 deb: liblinux-inotify2-perl
rpm: perl-Linux-Inotify2
- (for public-inbox-watch on Linux)
+ (for public-inbox-watch and -imapd on Linux)
- IO::Compress (::Gzip) deb: perl-modules (or libio-compress-perl)
pkg: perl5
public-inbox implements the sharing of an email inbox via git to
complement or replace traditional mailing lists. Readers may
-read via NNTP, Atom feeds or HTML archives.
+read via NNTP, IMAP, Atom feeds or HTML archives.
public-inbox spawned around three main ideas:
failures.
public-inbox uses the "pull" model. Casual readers may
-follow the list via NNTP, Atom feed or HTML archives.
+follow the list via NNTP, IMAP, Atom feed or HTML archives.
If a reader loses interest, they simply stop following.
* stores email in git, readers may have a complete archive of the inbox
-* Atom feed and NNTP allows casual readers to follow via feed reader
+* Atom feed, IMAP, NNTP allows casual readers to follow via local tools
* uses only well-documented and easy-to-implement data formats
Requirements for reading:
-* any software capable of NNTP or following Atom feeds
+* any software capable of IMAP, NNTP or following Atom feeds
Any basic web browser will do for the HTML archives.
We primarily develop on w3m to maximize accessibility.
tangentially related projects we depend on (e.g. git developers
on git@vger.kernel.org).
-The archives are readable via NNTP or HTTP:
+The archives are readable via IMAP, NNTP or HTTP:
- nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+ nntps://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+ imaps://news.public-inbox.org/inbox.comp.mail.public-inbox.meta.0
https://public-inbox.org/meta/
+AUTH=ANONYMOUS is supported for IMAP, but any username + password works
+
And as Tor hidden services:
http://hjrcffqmbrq6wope.onion/meta/
nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
+ imap://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta.0
You may also clone all messages via git: