Documentation/flow.txt

   1 # public-inbox data flow
   2 #
   3 # Note: choose either "delivery tools" OR "git mirroring tools"
   4 # for a given inboxdir.  Combining them for the SAME inboxdir
   5 # will cause conflicts.  Of course, different inboxdirs may
   6 # choose different means of getting mail into them.
   7
   8                                                  +--------------------+
   9                                                  |  delivery tools:   |
  10                                                  |  public-inbox-mda  |
  11                                                  | public-inbox-watch |
  12                                                  | public-inbox-learn |
  13                                                  +--------------------+
  14                                                    |
  15                                                    |
  16                                                    v
  17 +----------------------+                         +--------------------+
  18 | git mirroring tools: |  git (clone|fetch) &&   |                    |
  19 |      grok-pull,      |  public-inbox-index     |      inboxdir      |
  20 |   various scripts    | ----------------------> |                    |
  21 +----------------------+                         +--------------------+
  22                                                    |
  23                                                    |
  24                                                    v
  25                                                  +--------------------+
  26                                                  | read-only daemons: |
  27                                                  | public-inbox-httpd |
  28                                                  | public-inbox-imapd |
  29                                                  | public-inbox-nntpd |
  30                                                  +--------------------+
  31
  32 # Copyright 2020-2021 all contributors <meta@public-inbox.org>
  33 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>