archigo

command module
v0.0.0-...-c592dd7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 20, 2022 License: EUPL-1.2 Imports: 10 Imported by: 0

README

ArchiGO

A maildir to HTML archive generator, written in Go.

Wait, what?

A maildir to HTML archive generator. This means, from a maildir (where emails are stored, like an inbox) an HTML (in the future Gemini and Atom too, probably) is generated, suitable for publishing as a website.

This is similar to what mailing list software does, but instead of handling subscriptions, email reception and a ton of things, it just parses the emails and spits out static HTML to a folder. This program is meant to be ran with something like mbsync (for downloading email, a cronjob (to update archives) and a web server (to serve the output, obviously).

ArchiGO can handle multiple "lists" within a single address. Take for example test@lists.costas.dev (the address I actually use in development). This could be a single address for a single list, but instead you can add aliases to allow multiple lists, so you could host different lists in a single address, such as:

  • test+sometopic@lists.costas.dev
  • test+development@lists.costas.dev
  • test+offtopic@lists.costas.dev

You don't even have to use your own email server, you could host this address anywhere that allows IMAP access (any decent provider should).

Contributing

Any help either as code, documentation or bug reporting is really appreciated. Feel free to have a look to the planned features/fixes in the ticket manager, or send your feedback to the sourcehut mailing list.

Licensing

ArchiGO is released under the European Union Public License version 1.2, as published by the European Commission. Please refer to the COPYING file for the full legal text. You can also read Introduction to the EUPL licence by the European Commission for more information about this license.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL