thomas/mailout
1
0
Fork 0
Code Issues Pull requests Projects Releases 3 Packages Wiki Activity Actions

doc(license+readme): updates license and readme

Browse source
This commit is contained in:
Thomas Maurice 2024-02-12 17:31:40 +01:00
parent 5a4ee21561
commit 2ae8c6cca8
Signed by: thomas
GPG key ID: 1D577F50583032A6
2 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
LICENSE Normal file
View file

@ -0,0 +1,13 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.

8
README.md
View file

@ -1,5 +1,7 @@
# mailout # mailout
![wtfpl](http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-2.png)
This is a simple binary to handle your self hosted mail notification-sending machines. This is a simple binary to handle your self hosted mail notification-sending machines.
**this is not intended for human users** **this is not intended for human users**
@ -16,7 +18,7 @@ The plan is basically:
* you have a view to expose the relevant key to use for opendkim * you have a view to expose the relevant key to use for opendkim
## Warning ## Warning
I halfed assed that shit on an afternoon to suit my own needs, improvements will follow. I halfed assed that shit on an afternoon to suit my own needs, improvements will follow, or not.
## Features ## Features
@ -30,7 +32,7 @@ I halfed assed that shit on an afternoon to suit my own needs, improvements will
* Unpublish them to a DNS provider (currently only OVH) * Unpublish them to a DNS provider (currently only OVH)
## Requirements ## Requirements
* Postgres with a user * A postgresql database with a properly configured user
* Optionally an OVH account * Optionally an OVH account
### Dovecot ### Dovecot
@ -66,4 +68,4 @@ providers:
endpoint: ovh-eu endpoint: ovh-eu
``` ```
pointing to your DB and you're good pointing to your DB/OVH account and you're good