crabmail

Static HTML email archive viewer in Rust
git clone git://git.alexwennerberg.com/crabmail
Log | Files | Refs | README | LICENSE

README.md (1991B)


      1 # 🦀Crabmail🦀
      2 
      3 [self-hosted](https://git.alexwennerberg.com/crabmail/) / [github mirror](https://github.com/alexwennerberg/crabmail)
      4 
      5 A static mail HTML archive for the 21st century, written in Rust. Includes
      6 helpful "modern" features that existing solutions lack, like:
      7 
      8 * Responsive UI
      9 * Single-page threads
     10 * Working mailto: links
     11 * Thread-based Atom feeds
     12 
     13 Not implemented yet / designed:
     14 * Attachment handling?
     15 * Gemini support
     16 
     17 EMAIL FOREVER!
     18 
     19 [lists.flounder.online demo](https://lists.flounder.online)
     20 
     21 ## Installation and usage
     22 
     23 To use crabmail to host your own public inbox archive-first mailing list, check out [Self-hosted Public Inbox in 2022](https://alex.flounder.online/tech/howtolist.gmi)
     24 
     25 To install:
     26 ```
     27 git clone git://git.alexwennerberg.com/crabmail/
     28 cd crabmail && cargo install --path .
     29 ```
     30 
     31 Copy `crabmail.conf` and set the variables as needed.
     32 
     33 Get a maildir folder, for example, via `mbsync`. Crabmail will create sub-lists
     34 for each folder inside this maildir.
     35 
     36 Run crabmail [maildir root] -c [config-file.conf].
     37 
     38 For more thorough documentation, run `man doc/crabmail.1`. You can also move
     39 these wherever your docs manpages may live
     40 
     41 If you want to use an mbox file (for example, to mirror another archive), use
     42 [mblaze](https://github.com/leahneukirchen/mblaze) to import it into a maildir.
     43 Mblaze also has some tools that you may find supplementary to crabmail.
     44 
     45 Open `site/index.html` in a web browser 
     46 
     47 ## Contributing 
     48 
     49 For patches, use `git-send-email` or `git-format-patch`
     50 to send a patch to the [crabmail public inbox](https://lists.flounder.online/crabmail/)
     51 
     52 `git-format-patch` is preferred for non-trivial or multi-commit changes
     53 
     54 ## Etc
     55 
     56 Crabmail is AGPLv3 licenses, but some files are licensed under 0BSD or other
     57 more permissive licenses. I call this out when I can.
     58 
     59 For a similar project, check out [bubger](https://git.causal.agency/bubger/about/)
     60 
     61 Consider supporting me and my projects on [patreon](https://www.patreon.com/alexwennerberg)