From 7de138037f62679e2fefa0549af543412dab0d1a Mon Sep 17 00:00:00 2001
From: Guillaume Girol <symphorien+git@xlumurb.eu>
Date: Fri, 31 Dec 2021 12:00:00 +0000
Subject: [PATCH] docs: add how-to to setup roundcube

---
 docs/add-roundcube.rst | 32 ++++++++++++++++++++++++++++++++
 docs/index.rst         |  1 +
 2 files changed, 33 insertions(+)
 create mode 100644 docs/add-roundcube.rst

diff --git a/docs/add-roundcube.rst b/docs/add-roundcube.rst
new file mode 100644
index 0000000..08e41ed
--- /dev/null
+++ b/docs/add-roundcube.rst
@@ -0,0 +1,32 @@
+Add Roundube, a webmail
+=======================
+
+The NixOS module for roundcube nearly works out of the box with SNM. By
+default, it sets up a nginx virtual host to serve the webmail, other web
+servers may require more work.
+
+.. code:: nix
+
+   { config, pkgs, lib, ... }:
+
+   with lib;
+
+   {
+     services.roundcube = {
+        enable = true;
+        # this is the url of the vhost, not necessarily the same as the fqdn of
+        # the mailserver
+        hostName = "webmail.example.com";
+        extraConfig = ''
+          # starttls needed for authentication, so the fqdn required to match
+          # the certificate
+          $config['smtp_server'] = "tls://${config.mailserver.fqdn}";
+          $config['smtp_user'] = "%u";
+          $config['smtp_pass'] = "%p";
+        '';
+     };
+
+     services.nginx.enable = true;
+
+     networking.firewall.allowedTCPPorts = [ 80 443 ];
+   }
diff --git a/docs/index.rst b/docs/index.rst
index 262c664..b8700ff 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,6 +25,7 @@ Welcome to NixOS Mailserver's documentation!
 
    backup-guide
    add-radicale
+   add-roundcube
    rspamd-tuning
    fts
    flakes