update readme for v2.0
This commit is contained in:
parent
4708654ef9
commit
dcd73f59ee
1 changed files with 27 additions and 17 deletions
42
README.md
42
README.md
|
@ -10,7 +10,8 @@ None so far.
|
||||||
[Latest Release Candidate](https://github.com/r-raymond/nixos-mailserver/releases/latest)
|
[Latest Release Candidate](https://github.com/r-raymond/nixos-mailserver/releases/latest)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
### v1.1
|
### v2.0
|
||||||
|
* [x] Multiple Domains
|
||||||
* Postfix MTA
|
* Postfix MTA
|
||||||
- [x] smtp on port 25
|
- [x] smtp on port 25
|
||||||
- [x] submission port 587
|
- [x] submission port 587
|
||||||
|
@ -22,6 +23,7 @@ None so far.
|
||||||
* Certificates
|
* Certificates
|
||||||
- [x] manual certificates
|
- [x] manual certificates
|
||||||
- [x] on the fly creation
|
- [x] on the fly creation
|
||||||
|
- [x] Let's Encrypt
|
||||||
* Spam Filtering
|
* Spam Filtering
|
||||||
- [x] via rspamd
|
- [x] via rspamd
|
||||||
- [x] hard coded sieve script to move spam into Junk folder
|
- [x] hard coded sieve script to move spam into Junk folder
|
||||||
|
@ -33,17 +35,13 @@ None so far.
|
||||||
- [x] declarative user management
|
- [x] declarative user management
|
||||||
- [x] declarative password management
|
- [x] declarative password management
|
||||||
|
|
||||||
|
### In the future
|
||||||
### v1.2
|
|
||||||
* Certificates
|
|
||||||
- [x] Let's Encrypt
|
|
||||||
* Sieves
|
* Sieves
|
||||||
- [ ] Allow user defined sieve scripts
|
- [ ] Allow user defined sieve scripts
|
||||||
* User Aliases
|
* User Aliases
|
||||||
- [ ] More complete alias support
|
- [ ] More complete alias support
|
||||||
|
* DKIM Signing
|
||||||
### v2.0
|
- [ ] Allow a per domain selector
|
||||||
* [ ] Multiple Domains
|
|
||||||
|
|
||||||
### Changelog
|
### Changelog
|
||||||
|
|
||||||
|
@ -51,26 +49,37 @@ None so far.
|
||||||
* Changed structure to Nix Modules
|
* Changed structure to Nix Modules
|
||||||
* Adds Sieve support
|
* Adds Sieve support
|
||||||
|
|
||||||
|
#### v1.1 -> v2.0
|
||||||
|
* rename domain to fqdn, seperate fqdn from domains
|
||||||
|
* multi domain support
|
||||||
|
|
||||||
### How to Deploy
|
### How to Deploy
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
{ config, pkgs, ... }:
|
{ config, pkgs, ... }:
|
||||||
{
|
{
|
||||||
imports = [
|
imports = [
|
||||||
(builtins.fetchTarball "https://github.com/r-raymond/nixos-mailserver/releases/tag/v1.1-rc3")
|
(builtins.fetchTarball "https://github.com/r-raymond/nixos-mailserver/releases/tag/v2.0-rc1")
|
||||||
];
|
];
|
||||||
|
|
||||||
mailserver = {
|
mailserver = {
|
||||||
enable = true;
|
enable = true;
|
||||||
domain = "example.com";
|
fqdn = "mail.example.com";
|
||||||
login_accounts = {
|
domains = [ "example.com" "example2.com" ];
|
||||||
user1 = {
|
loginAccounts = {
|
||||||
name = "test";
|
"user1@example.com" = {
|
||||||
hashedPassword = "$6$Mmmx1U68$Twd8acMxqHoqFyfz3SPz1pzjY/D36gayAdpUTFMvfrHQUwObF3acuLz2GYAGFzsjHLEK/dPIv3pCwj3kZ5T2u.";
|
hashedPassword = "$6$/z4n8AQl6K$kiOkBTWlZfBd7PvF5GsJ8PmPgdZsFGN1jPGZufxxr60PoR0oUsrvzm2oQiflyz5ir9fFJ.d/zKm/NgLXNUsNX/";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
virtualAliases = {
|
virtualAliases = {
|
||||||
admin = "user1";
|
# address = forward address;
|
||||||
|
"info@example.com" = "user1@example.com";
|
||||||
|
"postmaster@example.com" = "user1@example.com";
|
||||||
|
"abuse@example.com" = "user1@example.com";
|
||||||
|
"user1@example2.com" = "user1@example.com";
|
||||||
|
"info@example2.com" = "user1@example.com";
|
||||||
|
"postmaster@example2.com" = "user1@example.com";
|
||||||
|
"abuse@example2.com" = "user1@example.com";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
@ -162,7 +171,7 @@ where `yyyyyyyyyyyy` is the `DKIM` signature
|
||||||
* Pam
|
* Pam
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
* one domain
|
* unlimited domain
|
||||||
* unlimited mail accounts
|
* unlimited mail accounts
|
||||||
* unlimited aliases for every mail account
|
* unlimited aliases for every mail account
|
||||||
* spam and virus checking
|
* spam and virus checking
|
||||||
|
@ -179,6 +188,7 @@ where `yyyyyyyyyyyy` is the `DKIM` signature
|
||||||
|
|
||||||
## Contributors
|
## Contributors
|
||||||
* Special thanks to @Infinisil for the module rewrite
|
* Special thanks to @Infinisil for the module rewrite
|
||||||
|
* Special thanks to @jbboehr for multidomain implementation
|
||||||
* @danbst
|
* @danbst
|
||||||
* @phdoerfler
|
* @phdoerfler
|
||||||
* @eqyiel
|
* @eqyiel
|
||||||
|
|
Loading…
Reference in a new issue