www: introduce www_folder config item

fix #529

Author: missytake

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## untagged
 
+- Make www upload path configurable
+  ([#618](https://github.com/chatmail/relay/pull/618))
+
 - Allow custom nginx config files
   ([#617](https://github.com/chatmail/relay/pull/617))
 

README.md

@@ -257,7 +257,16 @@ This starts a local live development cycle for chatmail web pages:
 
 #### Custom web pages
 
-If you want to include other pages,
+You can skip uploading a web page
+by setting `www_folder=disabled` in `chatmail.ini`.
+
+If you want to manage your web pages outside this git repository,
+you can set `www_folder` in `chatmail.ini` to a custom directory.
+`cmdeploy run` will upload it as the server's home page,
+and if it contains a `src/index.md` file,
+will build it with hugo.
+
+If you want to include existing web pages,
 they need their separate nginx config
 under `/etc/nginx/sites-enabled/`.
 Note that they need to listen on port 8443 instead of 443.

chatmaild/src/chatmaild/config.py

@@ -33,6 +33,7 @@ def __init__(self, inipath, params):
         self.password_min_length = int(params["password_min_length"])
         self.passthrough_senders = params["passthrough_senders"].split()
         self.passthrough_recipients = params["passthrough_recipients"].split()
+        self.www_folder = params.get("www_folder")
         self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
         self.filtermail_smtp_port_incoming = int(
             params["filtermail_smtp_port_incoming"]

cmdeploy/src/cmdeploy/__init__.py

@@ -11,7 +11,7 @@
 from pathlib import Path
 
 from chatmaild.config import Config, read_config
-from pyinfra import facts, host
+from pyinfra import facts, host, logger
 from pyinfra.api import FactBase
 from pyinfra.facts.files import File
 from pyinfra.facts.server import Sysctl
@@ -737,12 +737,24 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
         packages=["fcgiwrap"],
     )
 
-    www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
-
-    build_dir = www_path.joinpath("build")
-    src_dir = www_path.joinpath("src")
-    build_webpages(src_dir, build_dir, config)
-    files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
+    reporoot = importlib.resources.files(__package__).joinpath("../../../").resolve()
+    www_path = Path(config.www_folder)
+    # if www_folder was not set, use default directory
+    if not config.www_folder:
+        www_path = reporoot.joinpath("www")
+    # if www_folder was set to a non-existing folder, skip upload
+    if not www_path.is_dir():
+        logger.warning("Building web pages is disabled in chatmail.ini, skipping")
+    else:
+        build_dir = www_path.joinpath("build")
+        src_dir = www_path.joinpath("src")
+        # if www_folder is a hugo page, build it
+        if src_dir.joinpath("index.md").is_file():
+            build_webpages(src_dir, build_dir, config)
+        # if it is not a hugo page, upload it as is
+        else:
+            build_dir = www_path
+        files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
 
     _install_remote_venv_with_chatmaild(config)
     debug = False

cmdeploy/src/cmdeploy/www.py

@@ -3,6 +3,7 @@
 import time
 import traceback
 import webbrowser
+from pathlib import Path
 
 import markdown
 from chatmaild.config import read_config
@@ -106,7 +107,9 @@ def main():
     config = read_config(inipath)
     config.webdev = True
     assert config.mail_domain
-    www_path = reporoot.joinpath("www")
+    www_path = Path(config.www_folder)
+    if not config.www_folder:
+        www_path = reporoot.joinpath("www")
     src_path = www_path.joinpath("src")
     stats = None
     build_dir = www_path.joinpath("build")