A mailing list server in ruby. Easy to setup.
Go to file
Arthur POULET dc5950efc6 Fix date format for better mail compliance 2022-11-23 20:33:12 +01:00
bin add a db_console 2022-11-20 10:44:43 +01:00
deploy Add some infos for deploying service 2022-11-18 19:26:24 +01:00
lib Fix date format for better mail compliance 2022-11-23 20:33:12 +01:00
.gitignore Implement HELP 2022-11-19 11:26:37 +01:00
Gemfile Implement HELP 2022-11-19 11:26:37 +01:00
Gemfile.lock Implement HELP 2022-11-19 11:26:37 +01:00
README.md Add contribute readme 2022-11-20 11:04:29 +01:00
empty.env Add a few more configuration var 2022-11-18 17:51:08 +01:00

README.md

mailinglist.rb

Features

  • Receive new message and send it
  • Have a database of mailinglists with name and users
  • Web interface to access archives
  • ACL to restrict interactions with the system
  • Install documentation
  • Systemd service
  • AUR package
  • Configuration for everything
  • Robust codebase for extensibility
  • Robust network (handle network loss etc.)
  • Inbox cleanup
  • Moderation toolbox and email validation before distribution

Deploy from sources

  • Note there is a sample of systemd service you may use for your server in /deploy/

Download

git clone https://git.sceptique.eu/Sceptique/mailinglist.rb --depth 1
cd mailinglist.rb

Install dependencies

System dependencies: ruby 3.1.2, sqlite3

bundle install

Configure

Copy and fill all the env variables in .env

cp empty.env .env
edit .env

Setup the database

bin/db_migrate

Start

You may test it with

bin/distributor

Dev & play localy

After deploying it, there are some tools:

  • bin/db_seed to generate some data

Contributing

via Gitea

  1. Fork it (https://git.sceptique.eu/Sceptique/mailinglistrb)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

via emails

Checkout git-send-mail tutorial https://git-send-email.io/

  1. Clone it (https://git.sceptique.eu/Sceptique/mailinglistrb)
  2. Subscribe to the mailinglist to send your patch mailto:list.mailinglistrb@sceptique.eu?subject=subscribe (don't send your patch in this email)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Send your email to mailto:list.mailinglistrb@sceptique.eu after you are validated by modo