Arthur POULET dc5950efc6 | ||
---|---|---|
bin | ||
deploy | ||
lib | ||
.gitignore | ||
Gemfile | ||
Gemfile.lock | ||
README.md | ||
empty.env |
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
- Fork it (https://git.sceptique.eu/Sceptique/mailinglistrb)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
via emails
Checkout git-send-mail tutorial https://git-send-email.io/
- Clone it (https://git.sceptique.eu/Sceptique/mailinglistrb)
- Subscribe to the mailinglist to send your patch mailto:list.mailinglistrb@sceptique.eu?subject=subscribe (don't send your patch in this email)
- Commit your changes (
git commit -am 'Add some feature'
) - Send your email to mailto:list.mailinglistrb@sceptique.eu after you are validated by modo