diff --git a/README.md b/README.md index ec0c7f8..519e342 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ SNM branch corresponding to your NixOS version. ## Features -* [x] Continous Integration Testing +* [x] Continuous Integration Testing * [x] Multiple Domains * Postfix * [x] SMTP on port 25 diff --git a/default.nix b/default.nix index 6e12d26..f1f50bb 100644 --- a/default.nix +++ b/default.nix @@ -336,7 +336,7 @@ in default = "${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt"; defaultText = literalMD "see [source](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/blob/master/default.nix)"; description = '' - Certifificate trust anchors used to verify the LDAP server certificate. + Certificate trust anchors used to verify the LDAP server certificate. ''; }; @@ -948,10 +948,11 @@ in ]; default = "rsa"; description = '' - The key type used for generating DKIM keys. ED25519 was introduced in RFC6376 (2018). + The key type used for generating DKIM keys. Ed25519 support was + introduced in RFC6376 (2018). :::{warning} - ED25519 DKIM keys are currently not recommended for primary use, as + Ed25519 DKIM keys are currently not recommended for primary use, as various DKIM validators out there lack support and consider the keypair invalid. ::: diff --git a/docs/backup-guide.rst b/docs/backup-guide.rst index 67d08d0..71b6ff4 100644 --- a/docs/backup-guide.rst +++ b/docs/backup-guide.rst @@ -12,7 +12,7 @@ anything works, as it is simply a folder with plenty of files in it. If your backup solution does not preserve the owner of the files don’t forget to ``chown`` them to ``virtualMail:virtualMail`` if you copy them back (or whatever you specified as ``vmailUserName``, and -``vmailGoupName``). +``vmailGroupName``). If you enabled ``enableManageSieve`` then you also may want to backup ``/var/sieve`` or whatever you have specified as ``sieveDirectory``. diff --git a/docs/fts.rst b/docs/fts.rst index bb2fe88..40a3261 100644 --- a/docs/fts.rst +++ b/docs/fts.rst @@ -48,7 +48,7 @@ recommended to move indices in a different location, such as When the value of the ``indexDir`` option is changed, all dovecot indices needs to be recreated: clients would need to resynchronize. -Indexation itself is rather resouces intensive, in CPU, and for emails with +Indexation itself is rather resource intensive, in CPU, and for emails with large headers, in memory as well. Initial indexation of existing emails can take hours. If the indexer worker is killed or segfaults during indexation, it can be that it tried to allocate more memory than allowed. You can increase the memory diff --git a/docs/howto-develop.rst b/docs/howto-develop.rst index 700f9d0..dec8943 100644 --- a/docs/howto-develop.rst +++ b/docs/howto-develop.rst @@ -38,8 +38,8 @@ You can then run the testsuite via $ nix flake check -L -Since Nix doesn't garantee your machine have enough resources to run -all test VMs in parallel, some tests can fail. You would then haev to +Since Nix doesn't guarantee your machine have enough resources to run +all test VMs in parallel, some tests can fail. You would then have to run tests manually. For instance: :: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 4b81711..b7b988b 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -35,14 +35,14 @@ NixOS 25.11 1024 bit keys should not be considered valid any longer. - IMAP access over port ``143/tcp`` is now default disabled in line with `RFC 8314 4.1`_. Use IMAP over implicit TLS on port ``993/tcp`` - instead. If you still require this feature you can reenable it using + instead. If you still require this feature you can re-enable it using ``mailserver.enableImap``, but it is scheduled for removal after the 25.11 release. - SMTP server and client now support and prefer a hybrid key exchange (X25519MLKEM768) - SMTP access over STARTTLS on port ``587/tcp`` is now default disabled in line - with `RFC 8314 3.3`_. If you still require this feature you can renable it using - ``mailserver.enableSubmission``. + with `RFC 8314 3.3`_. If you still require this feature you can re-enable it + using ``mailserver.enableSubmission``. - DMARC reports are now sent with the ``noreply-dmarc`` localpart from the system domain. - DANE and MTA-STS are now validated for outgoing SMTP connections using diff --git a/docs/rspamd-tuning.rst b/docs/rspamd-tuning.rst index bada5e8..6706db6 100644 --- a/docs/rspamd-tuning.rst +++ b/docs/rspamd-tuning.rst @@ -94,7 +94,7 @@ With an nginx reverse-proxy If you have a secured nginx reverse proxy set on the host, you can use it to expose the socket. **Keep in mind the UI is unsecured by default, you need to setup an authentication scheme**, for -exemple with `basic auth `_: +example with `basic auth `_: .. code:: nix diff --git a/flake.nix b/flake.nix index f24f852..6b3ef24 100644 --- a/flake.nix +++ b/flake.nix @@ -155,7 +155,7 @@ markdownlint = { enable = true; settings.configuration = { - # Max line length, doesn't seem to correclty account for lines containing links + # Max line length, doesn't seem to correctly account for lines containing links # https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md MD013 = false; }; diff --git a/mail-server/dovecot.nix b/mail-server/dovecot.nix index d3d0722..c757005 100644 --- a/mail-server/dovecot.nix +++ b/mail-server/dovecot.nix @@ -145,7 +145,7 @@ let lib.filterAttrs (_: v: v ? "specialUse" && v.specialUse == "Junk") cfg.mailboxes ); junkMailboxNumber = builtins.length junkMailboxes; - # The assertion garantees there is exactly one Junk mailbox. + # The assertion guarantees there is exactly one Junk mailbox. junkMailboxName = if junkMailboxNumber == 1 then builtins.elemAt junkMailboxes 0 else ""; mkLdapSearchScope = @@ -206,7 +206,7 @@ in }; }; - # for sieve-test. Shelling it in on demand usually doesnt' work, as it reads + # for sieve-test. Shelling it in on demand usually doesn't work, as it reads # the global config and tries to open shared libraries configured in there, # which are usually not compatible. environment.systemPackages = [ diff --git a/tests/external.nix b/tests/external.nix index bf9e0a8..21503ba 100644 --- a/tests/external.nix +++ b/tests/external.nix @@ -430,9 +430,9 @@ # fetchmail returns EXIT_CODE 0 when it retrieves mail client.succeed("fetchmail --nosslcertck -v") - with subtest("catchAlls"): + with subtest("domain catch-all"): client.execute("rm ~/mail/*") - # send email from chuck to non exsitent account + # send email from chuck to non-existent account client.succeed( "msmtp -a test3 --tls=on --tls-certcheck=off --auth=on lol@example.com < /etc/root/email2 >&2" ) @@ -447,7 +447,7 @@ ) server.wait_until_fails('[ "$(postqueue -p)" != "Mail queue is empty" ]') # fetchmail returns EXIT_CODE 1 when no new mail - # if this succeeds, it means that user1 recieved the mail that was intended for chuck. + # if this succeeds, it means that user1 received the mail that was intended for chuck. client.fail("fetchmail --nosslcertck -v") with subtest("extraVirtualAliases"): diff --git a/tests/ldap.nix b/tests/ldap.nix index 9cff68f..c150567 100644 --- a/tests/ldap.nix +++ b/tests/ldap.nix @@ -135,7 +135,7 @@ in # This function retrieves the ldap table file from a postconf # command. - # A key lookup is achived and the returned value is compared + # A key lookup is achieved and the returned value is compared # to the expected value. def test_lookup(postconf_cmdline, key, expected): conf = machine.succeed(postconf_cmdline).rstrip()