X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fdesign_notes.txt;h=71f6b77a6a8db89b0b4ea0864cb92b0b8fb85c93;hb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;hp=9666664cf9c94cf95e43236e5824882e710e3522;hpb=394558721dd0c27f71fc6605c009ea07d37ccee8;p=public-inbox.git diff --git a/Documentation/design_notes.txt b/Documentation/design_notes.txt index 9666664c..71f6b77a 100644 --- a/Documentation/design_notes.txt +++ b/Documentation/design_notes.txt @@ -1,8 +1,9 @@ -Design notes ------------- +public-inbox design notes +------------------------- Challenges to running normal mailing lists ------------------------------------------ + 1) spam 2) bounce processing of invalid/bad email addresses 3) processing subscribe/unsubscribe requests @@ -26,9 +27,7 @@ Use existing infrastructure * Existing spam filtering on an SMTP server is also effective on public-inbox. -* readers may continue using use their choice of mail clients and - mailbox formats, only learning a few commands of the ssoma(1) tool - is required. +* Readers may continue using use their choice of NNTP and mail clients. * Atom is a reasonable feed format for casual readers and is supported by a variety of feed readers. @@ -40,7 +39,7 @@ Why email? developers and users of Free Software should not rely on proprietary tools or services. -* Existing infrastrucuture, tools, and user familarity. +* Existing infrastructure, tools, and user familiarity. There is already a large variety of tools, clients, and email providers available. There are also many resources for users to run their own SMTP server on a domain they control. @@ -53,9 +52,12 @@ Why email? There is no need to ask the NSA for backups of your mail archives :) * git, one of the most widely-used version control systems, includes many - tools for for email: git-format-patch(1), git-send-email(1), git-am(1). - Furthermore, the development of git itself is based on the git mailing - list. + tools for for email, including: git-format-patch(1), git-send-email(1), + git-am(1), git-imap-send(1). Furthermore, the development of git itself + is based on the git mailing list: https://public-inbox.org/git/ + (or + http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/git/ + for Tor users) * Email is already the de-facto form of communication in many Free Software communities.. @@ -70,15 +72,33 @@ Why git? * git is distributed and robust while being both fast and space-efficient with text data. NNTP was considered, but does not support delta-compression and places no guarantees on data/transport - integrity. However, an NNTP gateway (read-only?) is possible. + integrity. However, a read-only NNTP gateway is implemented. -* As of 2014, git is widely used and known to nearly all Free Software +* As of 2016, git is widely used and known to nearly all Free Software developers. For non-developers it is packaged for all major GNU/Linux and *BSD distributions. NNTP is not as widely-used nowadays. +Why perl 5? +----------- + +* Perl 5 is widely available on modern *nix systems with good a history + of backwards and forward compatibility. + +* git and SpamAssassin both use it, so it should be one less thing for + admins to install and waste disk space with. + +* Distributing compiled binaries has higher costs for storage/cache + space is required for each architecture. Having a runnable, + source-only distribution means any user already has access to all + of our source. + Laziness -------- +* Stick to dependencies available in Debian main, this should make it + easier for potential users to install, and easier for distro + maintainers to pick up. + * A list server being turned into an SMTP spam relay and being blacklisted while an admin is asleep is scary. Sidestep that entirely by having clients pull. @@ -98,12 +118,11 @@ Laziness * Avoids bikeshedding about web UI decisions, GUI-lovers can write their own GUI-friendly interfaces (HTML or native) based on public archives. - Maybe one day integrated MUAs will feature a built-in git protocol support! Web notes --------- -* Getting users to install/run ssoma (or any new tool) is difficult. +* Getting users to install/run any new tool is difficult. The web views must be easily read/cache/mirror-able. * There may also be a significant number of webmail users without @@ -112,10 +131,25 @@ Web notes * Expose Message-ID in web views to encourage replies from drive-by contributors. -* Raw text endpoint allows users to write client-side JS endpoints +* Raw text endpoint allows users to write client-side endpoints without hosting the data themselves (or on a different server). +What sucks about public-inbox +----------------------------- + +* Lack of push notification. On the other hand, feeds seem popular. + +* some (mostly GUI) mail clients cannot set In-Reply-To headers + properly without the original message. + +Scalability notes +----------------- + +See the public-inbox-v2-format(5) manpage for all the scalability +problems solved. + Copyright --------- -Copyright 2013, Eric Wong and all contributors. -License: AGPLv3 or later + +Copyright 2013-2021 all contributors +License: AGPL-3.0+