Skip to content

WIP: Describe installation on Debian #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

WIP: Describe installation on Debian #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down