From 46a4f263a7fd75514cf0756e80a43b89fd87e50c Mon Sep 17 00:00:00 2001 From: Dominik George Date: Thu, 28 Apr 2022 21:08:40 +0200 Subject: [PATCH] Describe installation on Debian --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 2e0b9a8..aaf067b 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,19 @@ An instance of `hugo-mx-gateway` can be quickly started on any machine running D ``` The output in case of success shall be `{"status": "ok"}`. +## Deployment on Debian + +On Debian systems starting from Debian 12 (bookworm), and Debian 11 (bullseye) with backports, `hugo-mx-gateway` can be installed from apt. + +* Install the package from apt + ``` + apt install hugo-mx-gateway + ``` +* Set [configuration variables](#configuration-variables) in `/etc/default/hugo-mx-gateway` +* Control the service using `systemctl` + +On Debian, the service by default only listens on localhost, and the default port is set to `8576` in order do decrease the danger of port clashes. You can either reconfigure this by setting the `HOST` and `PORT` variables, or you can add a reverse proxy in front of the gateway. + # Use the built-in form for Hugo The file `./samples/hugo-partial-contact-form.html` contains a sample HTML form for Hugo. It can be used for both contact and demo requests.