An open API service indexing awesome lists of open source software.

https://github.com/rchakode/hugo-mx-gateway

:mailbox_with_no_mail: Contact/demo form handler for static websites with spam protection. Deploy on Kubernetes, Google Compute Engine, or Docker. Built for Hugo and other static site generators.
https://github.com/rchakode/hugo-mx-gateway

contact-form docker google-app-engine hugo hugo-site kubernetes rest-api static-site

Last synced: 5 months ago
JSON representation

:mailbox_with_no_mail: Contact/demo form handler for static websites with spam protection. Deploy on Kubernetes, Google Compute Engine, or Docker. Built for Hugo and other static site generators.

Awesome Lists containing this project

README

          

![logo-thumbnail](hugo-mx-gateway-thumbnail.png)

![Apache License](https://img.shields.io/github/license/rchakode/hugo-mx-gateway.svg?label=License&style=for-the-badge)
[![GitHub Actions Status](https://img.shields.io/github/actions/workflow/status/rchakode/hugo-mx-gateway/build.yml?logo=GitHub&style=for-the-badge)](https://github.com/rchakode/hugo-mx-gateway/actions)
![Docker pulls](https://raster.shields.io/docker/pulls/rchakode/hugo-mx-gateway.png?label=Docker%20Pulls&style=for-the-badge)

---

- [Overview](#overview)
- [Getting Started](#getting-started)
- [License & Copyrights](#license--copyrights)
- [Support & Contributions](#support--contributions)

# Overview
Did you ever experience building a static website (e.g. using [Hugo](https://gohugo.io/)) then got stuck when coming the time to add a contact/demo request form?

You're at the right place.

`hugo-mx-gateway` provides a RESTful API that adds the dynamicity required to handle contact/demo requests for your static websites. It's a simple, yet a powerful tool built for this only-designated purpose.

![](hugo-mx-gateway-architecture-overview.png)

## Key Benefits

- **Lightweight & Purpose-built** — A single Go binary designed specifically for contact and demo request forms
- **Security-first** — Built-in CORS validation, honeypot spam protection, and optional reCAPTCHA support
- **Flexible Deployment** — Quick Start on Docker, Kubernetes (via Helm), Google App Engine, or any cloud VM
- **Simple Configuration** — All settings via environment variables, no config files needed

# Getting Started
The following resources will enable you to deploy and get started with hugo-mx-gateway.

* [Deployment on Kubernetes](./docs/deployment-on-kubernetes.md)
* [Deployment on Google Compute Engine](./docs/deployment-on-google-compute-engine.md)
* [Deployment on Docker](./docs/deployment-on-docker.md)
* [Configuration Variables](./docs/configuration-variables.md)
* [Sample contact form for Hugo](./docs/sample-contact-form-for-hugo.md)
* [Design Fundamentals](./docs/design-fundamentals.md)

# License & Copyrights
This tool (code and documentation) is licensed under the terms of Apache 2.0 License. Read the [LICENSE](LICENSE) file for more details on the license terms.

The tool may include third-party libraries provided with their own licenses and copyrights, but always compatible with the Apache 2.0 License terms of use.

# Support & Contributions
We encourage feedback and do make our best to handle any troubles you may encounter when using this tool.

Here is the link to submit issues: https://github.com/rchakode/hugo-mx-gateway/issues.

New ideas are welcomed, please open an issue to submit your idea if you have any one.

Contributions are accepted subject that the code and documentation be released under the terms of Apache 2.0 License.

To contribute bug patches or new features, please use the Github Pull Request model.