doc(license+readme): updates license and readme
This commit is contained in:
parent
5a4ee21561
commit
2ae8c6cca8
2 changed files with 18 additions and 3 deletions
13
LICENSE
Normal file
13
LICENSE
Normal 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.
|
|
@ -1,5 +1,7 @@
|
|||
# mailout
|
||||
|
||||

|
||||
|
||||
This is a simple binary to handle your self hosted mail notification-sending machines.
|
||||
|
||||
**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
|
||||
|
||||
## 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
|
||||
|
||||
|
@ -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)
|
||||
|
||||
## Requirements
|
||||
* Postgres with a user
|
||||
* A postgresql database with a properly configured user
|
||||
* Optionally an OVH account
|
||||
|
||||
### Dovecot
|
||||
|
@ -66,4 +68,4 @@ providers:
|
|||
endpoint: ovh-eu
|
||||
```
|
||||
|
||||
pointing to your DB and you're good
|
||||
pointing to your DB/OVH account and you're good
|
Loading…
Add table
Reference in a new issue