X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=README;h=26e0b69514df24567cf366468e852f0daad2053b;hp=e8555aa31ba844fcba7ac73b9726cb39c3f023a3;hb=4db4bfa2c9178b315d2ac09cff794a4476ba1f6e;hpb=34329921385d2489c2ea94eab73a6ad567863565 diff --git a/README b/README index e8555aa3..26e0b695 100644 --- a/README +++ b/README @@ -22,33 +22,31 @@ to run their own instances with minimal overhead. Implementation -------------- -public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements -no policy of its own. By storing (and optionally) exposing an inbox -via git, it is fast and efficient to host and mirror public-inboxes. +public-inbox stores mail in a git repository keyed by Message-ID +as documented in: https://ssoma.public-inbox.org/ssoma_repository.txt -Traditional mailing lists use the "push" model. For readers, this -requires commitment to subscribe and effort to unsubscribe. New readers -may also have difficulty following existing discussions if archives do -not expose Message-ID headers for responses. List server admins may be -burdened with delivery failures. +By storing (and optionally) exposing an inbox via git, it is +fast and efficient to host and mirror public-inboxes. -public-inbox uses the "pull" model. Casual readers may also follow -the list via NNTP, Atom feed or HTML archives. +Traditional mailing lists use the "push" model. For readers, +that requires commitment to subscribe and effort to unsubscribe. +New readers may also have difficulty following existing +discussions if archives do not expose Message-ID and References +headers. List server admins are also burdened with delivery +failures. -Users of the ssoma[1] command-line tool may import mail into an mbox, -Maildir, or IMAP folder from git repositories periodically. +public-inbox uses the "pull" model. Casual readers may also +follow the list via NNTP, Atom feed or HTML archives. If a reader loses interest, they simply stop syncing. Since we use git, mirrors are easy-to-setup, and lists are -easy-to-relocate to different mail addresses without losing/splitting -archives. +easy-to-relocate to different mail addresses without losing +or splitting archives. _Anybody_ may also setup a delivery-only mailing list server to replay a public-inbox git archive to subscribers via SMTP. -[1] https://ssoma.public-inbox.org/ - Features -------- @@ -87,9 +85,11 @@ See https://public-inbox.org/INSTALL Hacking ------- -Source code is available via git: +AGPL source code is available via git: - git clone git://80x24.org/public-inbox + git clone https://public-inbox.org/ public-inbox + git clone git://repo.or.cz/public-inbox + torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox See below for contact info. @@ -113,9 +113,15 @@ The archives are readable via NNTP or HTTP: nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta https://public-inbox.org/meta/ +And as Tor hidden services: + + http://hjrcffqmbrq6wope.onion/meta/ + nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta + You may also clone all messages via git: git clone --mirror https://public-inbox.org/meta/ + torsocks git clone --mirror http://hjrcffqmbrq6wope.onion/meta/ Or pass the same git repository URL for ssoma using the instructions at: @@ -133,10 +139,10 @@ See https://public-inbox.org/dc-dlvr-spam-flow.html for more info. Content Filtering ----------------- -To discourage phishing, web bugs (tracking), viruses and other nuisances, -only plain-text content is allowed and non-text content is stripped. -This saves I/O bandwidth and storage, which is important as -entire mail archives are shared between clients. +To discourage phishing, trackers, exploits and other nuisances, +only plain-text emails are allowed and HTML is rejected. +This improves accessibility, and saves bandwidth and storage +as mail is archived forever. As of the 2010s, successful online social networks and forums are the ones which heavily restrict users formatting options; so public-inbox @@ -145,7 +151,7 @@ aims to preserve the focus on content, and not presentation. Copyright --------- -Copyright 2013-2016 all contributors +Copyright 2013-2018 all contributors License: AGPL-3.0+ This program is free software: you can redistribute it and/or modify