about summary refs log tree commit homepage
path: root/Documentation/flow.txt
diff options
context:
space:
mode:
authorEric Wong <e@yhbt.net>2020-02-05 22:03:46 -0600
committerEric Wong <e@yhbt.net>2020-02-06 19:10:55 +0000
commit6864cdba2bb65069d15d26e0b9af6ade8edd0ec3 (patch)
tree2bbd43abf32de646a71a633b75fbef450f1b2f71 /Documentation/flow.txt
parent314079846791633be4c59932c7eefa6b242cb2ca (diff)
downloadpublic-inbox-6864cdba2bb65069d15d26e0b9af6ade8edd0ec3.tar.gz
Maybe this can make it easier for new and potential
users to understand what's going on.
Diffstat (limited to 'Documentation/flow.txt')
-rw-r--r--Documentation/flow.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/Documentation/flow.txt b/Documentation/flow.txt
new file mode 100644
index 00000000..ac3459e4
--- /dev/null
+++ b/Documentation/flow.txt
@@ -0,0 +1,32 @@
+# public-inbox data flow
+#
+# Note: choose either "delivery tools" OR "git mirroring tools"
+# for a given inboxdir.  Combining them for the SAME inboxdir
+# will cause conflicts.  Of course, different inboxdirs may
+# choose different means of getting mail into them.
+
+                                                 +--------------------+
+                                                 |  delivery tools:   |
+                                                 |  public-inbox-mda  |
+                                                 | public-inbox-watch |
+                                                 | public-inbox-learn |
+                                                 +--------------------+
+                                                   |
+                                                   |
+                                                   v
++----------------------+                         +--------------------+
+| git mirroring tools: |  git (clone|fetch) &&   |                    |
+|      grok-pull,      |  public-inbox-index     |      inboxdir      |
+|   various scripts    | ----------------------> |                    |
++----------------------+                         +--------------------+
+                                                   |
+                                                   |
+                                                   v
+                                                 +--------------------+
+                                                 | read-only daemons: |
+                                                 | public-inbox-httpd |
+                                                 | public-inbox-nntpd |
+                                                 +--------------------+
+
+# Copyright 2020 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>