public-inbox (server-side) installation
---------------------------------------
+
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,
also see the scripts/ and sa_config/ directories in the source tree
Requirements (server MDA)
-------------------------
+
* git
-* ssoma - http://ssoma.public-inbox.org/INSTALL.html
* 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::Address libemail-address-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:
- - CGI[1] perl-modules[2]
+ - Plack[1] libplack-perl
- Mail::Thread (2.5+)[1] libmail-thread-perl
- URI::Escape[1] liburi-perl
- - XML::Atom::SimpleFeed[1] libxml-atom-simplefeed-perl
- Search::Xapian[3] libsearch-xapian-perl
- IO::Compress::Gzip[3] libio-compress-perl
+ - DBI[3] libdbi-perl
+ - DBD::SQLite[3] libdbd-sqlite3-perl
+ - Danga::Socket[4] libdanga-socket-perl
+ - Net::Server[4] libnet-server-perl
[1] - Only required for serving/generating Atom and HTML pages.
-[2] - Keep in mind this will be split into a separate Debian package
- when CGI.pm is dropped from the Perl standard library.
- Plack/PSGI and mod_perl2 are both supported.
-[3] - Optional for HTML web interface
+[3] - Optional for HTML web interface and HTTP/NNTP servers
+[4] - Optional for HTTP and NNTP servers
+
+When installing Search::Xapian, make sure the underlying Xapian
+is patched against the index corruption bug documented in:
+
+ 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.
+
+public-inbox will never store unregeneratable data in Xapian
+or any other search database we might use; Xapian corruption
+will not destroy critical data.
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>