---------------------------------------
This is for folks who want to setup their own public-inbox instance.
-Clients should see http://ssoma.public-inbox.org/INSTALL.html instead
+Clients should see https://ssoma.public-inbox.org/INSTALL.html instead
if they want to import mail into their personal inboxes.
TODO: this still needs to be documented better,
make test
make install # root permissions may be needed
-Requirements (server MDA)
--------------------------
+Requirements
+------------
* git
-* SpamAssassin (spamc/spamd)
-* MTA - postfix is recommended
-* lynx (for converting HTML messages to text)
* Perl and several modules: (Debian package name)
- Date::Parse libtimedate-perl
- - Email::Filter libemail-filter-perl
- Email::MIME libemail-mime-perl
- Email::MIME::ContentType libemail-mime-contenttype-perl
- Encode::MIME::Header perl
- - File::Path::Expand libfile-path-expand-perl
- - IPC::Run libipc-run-perl
-Optional modules:
+Optional components:
+
+* MTA - postfix is recommended (for public-inbox-mda)
+* SpamAssassin (spamc/spamd) (for public-inbox-watch/public-inbox-mda)
+
+Optional Perl modules:
- Plack[1] libplack-perl
- - Mail::Thread (2.5+)[1] libmail-thread-perl
- URI::Escape[1] liburi-perl
- - Search::Xapian[3] libsearch-xapian-perl
- - IO::Compress::Gzip[3] libio-compress-perl
+ - Search::Xapian[2][3] libsearch-xapian-perl
+ - IO::Compress::Gzip[3] perl-modules (or libio-compress-perl)
- DBI[3] libdbi-perl
- - DBD::SQLite[3] libdbd-sqlite3-perl
+ - DBD::SQLite[2][3] libdbd-sqlite3-perl
- Danga::Socket[4] libdanga-socket-perl
- - Net::Server[4] libnet-server-perl
+ - Net::Server[5] libnet-server-perl
+ - Filesys::Notify::Simple[6] libfilesys-notify-simple-perl
-[1] - Only required for serving/generating Atom and HTML pages.
-[3] - Optional for HTML web interface and HTTP/NNTP servers
-[4] - Optional for HTTP and NNTP servers
+[1] - Optional, needed for serving/generating Atom and HTML pages
+[2] - Optional, only required for NNTP server
+[3] - Optional, needed for gzipped mbox support over HTTP
+[4] - Optional, needed for bundled HTTP and NNTP servers
+[5] - Optional, needed for standalone daemonization of HTTP+NNTP servers
+[6] - Optional, needed for public-inbox-watch Maildir watcher
When installing Search::Xapian, make sure the underlying Xapian
-is patched against the index corruption bug documented in:
+installation is not affected by an index corruption bug:
https://bugs.debian.org/808610
-For Debian 8.0, this means installing from jessie-backports
-until the fix lands in jessie.
-
-# Ensure the following line is in your apt sources.list(5)
-# (typically /etc/apt/sources.list):
-
-deb http://http.us.debian.org/debian jessie-backports main
-
-Then run:
-
- apt-get update
- apt-get install -t jessie-backports libxapian22
-
-to install the package.
+For Debian 8.x (jessie), this means using Debian 8.5 or later.
public-inbox will never store unregeneratable data in Xapian
or any other search database we might use; Xapian corruption
Copyright
---------
-Copyright 2013-2015 all contributors <meta@public-inbox.org>
-License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
+Copyright 2013-2016 all contributors <meta@public-inbox.org>
+License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>