user/dev discussion of public-inbox itself
 help / color / Atom feed
From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Cc: Danh Doan <congdanhqx@gmail.com>,
	Daniel Borkmann <daniel@iogearbox.net>,
	Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
	Leah Neukirchen <leah@vuxu.org>
Subject: [PATCH] doc: add clients.txt
Date: Mon, 27 Apr 2020 20:57:08 +0000
Message-ID: <20200427205708.2540-1-e@yhbt.net> (raw)

Since some client tools exist for dealing with public-inbox
specifically, it seems like a good idea to list some of them.

Cc: Danh Doan <congdanhqx@gmail.com>
Cc: Daniel Borkmann <daniel@iogearbox.net>
Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Cc: Leah Neukirchen <leah@vuxu.org>
---
 Documentation/clients.txt | 34 ++++++++++++++++++++++++++++++++++
 MANIFEST                  |  1 +
 2 files changed, 35 insertions(+)
 create mode 100644 Documentation/clients.txt

diff --git a/Documentation/clients.txt b/Documentation/clients.txt
new file mode 100644
index 00000000..d2ac7561
--- /dev/null
+++ b/Documentation/clients.txt
@@ -0,0 +1,34 @@
+clients and tools related to public-inbox
+-----------------------------------------
+
+While public-inbox exposes NNTP and gzipped mboxrd over HTTP,
+some public-inbox-specific/aware tools have sprung up.
+
+Below is a non-exhaustive list of them.  Feel free to send
+additions, corrections and discussions to meta@public-inbox.org
+Discussions will be visible from our own public-inbox instance:
+https://public-inbox.org/meta/
+
+Disclaimer: public-inbox itself comes with no warranty or
+guarantees; so don't treat any of these links as endorsements,
+either.
+
+* l2md - Maildir importer using C + libgit2
+  https://git.kernel.org/pub/scm/linux/kernel/git/dborkman/l2md.git
+
+* impibe - Perl script to import v1 or v2 to Maildir
+  https://public-inbox.org/meta/87v9m0l8t1.fsf@vuxu.org/
+
+* kernel.org helpers, including get-lore-mbox and sendmail-pi-feed
+  https://git.kernel.org/pub/scm/linux/kernel/git/mricon/korg-helpers.git
+
+* grokmirror - git mirroring tool (not public-inbox-specific)
+  https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git
+
+* ssoma - v1 only, abandoned in favor of NNTP
+  https://80x24.org/ssoma.git
+
+There's also a bunch of random scripts in the scripts/ directory
+of our source tree at:
+
+	git clone https://public-inbox.org/public-inbox.git
diff --git a/MANIFEST b/MANIFEST
index e3e0f2a8..90a05d33 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -9,6 +9,7 @@ Documentation/RelNotes/v1.2.0.eml
 Documentation/RelNotes/v1.3.0.eml
 Documentation/RelNotes/v1.4.0.eml
 Documentation/RelNotes/v1.5.0.eml
+Documentation/clients.txt
 Documentation/dc-dlvr-spam-flow.txt
 Documentation/design_notes.txt
 Documentation/design_www.txt

             reply index

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-27 20:57 Eric Wong [this message]
2020-04-27 21:10 ` Konstantin Ryabitsev
2020-04-27 21:30   ` Eric Wong
2020-04-27 21:10 ` Leah Neukirchen
2020-04-27 21:14 ` Daniel Borkmann
2020-04-27 22:21 ` [PATCH v2] " Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200427205708.2540-1-e@yhbt.net \
    --to=e@yhbt.net \
    --cc=congdanhqx@gmail.com \
    --cc=daniel@iogearbox.net \
    --cc=konstantin@linuxfoundation.org \
    --cc=leah@vuxu.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

Archives are clonable:
	git clone --mirror http://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

Example config snippet for mirrors

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git