Skynet/misc_nixos-mailserver
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: no longer use tagged release but branch instead in docs

Browse source
This commit is contained in:
Antoine Eiche 2020-10-30 22:19:46 +01:00
parent eba19686fb
commit 843e66864f
2 changed files with 34 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
README.md
View file

@ -74,34 +74,35 @@ See the [mailing list archive](https://www.freelists.org/archive/snm/)
### Quick Start ### Quick Start
```nix ```nix
{ config, pkgs, ... }: { config, pkgs, ... }:
{ let release = "nixos-20.09";
imports = [ in {
(builtins.fetchTarball { imports = [
# Pick a commit from the branch you are interested in (builtins.fetchTarball {
url = "https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/archive/A-COMMIT-ID/nixos-mailserver-A-COMMIT-ID.tar.gz"; url = "https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/archive/${release}/nixos-mailserver-${release}.tar.gz";
# And set its hash # This hash needs to be updated
sha256 = "0000000000000000000000000000000000000000000000000000"; sha256 = "0000000000000000000000000000000000000000000000000000";
}) })
]; ];
mailserver = { mailserver = {
enable = true; enable = true;
fqdn = "mail.example.com"; fqdn = "mail.example.com";
domains = [ "example.com" "example2.com" ]; domains = [ "example.com" "example2.com" ];
loginAccounts = { loginAccounts = {
"user1@example.com" = { "user1@example.com" = {
hashedPassword = "$6$/z4n8AQl6K$kiOkBTWlZfBd7PvF5GsJ8PmPgdZsFGN1jPGZufxxr60PoR0oUsrvzm2oQiflyz5ir9fFJ.d/zKm/NgLXNUsNX/"; # mkpasswd -m sha-512 "super secret password" > /hashed/password/file/location
hashedPasswordFile = "/hashed/password/file/location";
aliases = [ aliases = [
"info@example.com" "info@example.com"
"postmaster@example.com" "postmaster@example.com"
"postmaster@example2.com" "postmaster@example2.com"
]; ];
}; };
}; };
}; };
} }
``` ```
For a complete list of options, see `default.nix`. For a complete list of options, see `default.nix`.

12
docs/quick-start.rst
View file

@ -4,22 +4,24 @@ Quick Start
.. code:: nix .. code:: nix
{ config, pkgs, ... }: { config, pkgs, ... }:
{ let release = "nixos-20.09";
in {
imports = [ imports = [
(builtins.fetchTarball { (builtins.fetchTarball {
url = "https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/archive/v2.2.1/nixos-mailserver-v2.2.1.tar.gz"; url = "https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/archive/${release}/nixos-mailserver-${release}.tar.gz";
sha256 = "03d49v8qnid9g9rha0wg2z6vic06mhp0b049s3whccn1axvs2zzx"; # This hash needs to be updated
sha256 = "0000000000000000000000000000000000000000000000000000";
}) })
]; ];
mailserver = { mailserver = {
enable = true; enable = true;
fqdn = "mail.example.com"; fqdn = "mail.example.com";
domains = [ "example.com" "example2.com" ]; domains = [ "example.com" "example2.com" ];
loginAccounts = { loginAccounts = {
"user1@example.com" = { "user1@example.com" = {
hashedPassword = "$6$/z4n8AQl6K$kiOkBTWlZfBd7PvF5GsJ8PmPgdZsFGN1jPGZufxxr60PoR0oUsrvzm2oQiflyz5ir9fFJ.d/zKm/NgLXNUsNX/"; # mkpasswd -m sha-512 "super secret password" > /hashed/password/file/location
hashedPasswordFile = "/hashed/password/file/location";
aliases = [ aliases = [
"info@example.com" "info@example.com"