F5KCK
/
hugo-mx-gateway
Archived
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: updated code formating

This commit is contained in:
Rodrigue Chakode 2022-02-01 09:28:03 +01:00 committed by GitHub
parent 84b65f1e4d
commit 477643b58e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -80,9 +80,10 @@ This requires to have an active GCP account and [Google Cloud SDK](https://cloud
* Check that `hugo-mx-gateway` is up and working * Check that `hugo-mx-gateway` is up and working
``` ```
curl https://PROJECT-ID.REGION.r.appspot.com/ curl https://PROJECT-ID.REGION.r.appspot.com/
{"status": "ok"}
``` ```
Replace `PROJECT-ID` with the GCP project ID, and `REGION` with the deployment region. Replace `PROJECT-ID` with the GCP project ID, and `REGION` with the deployment region.*
The output in case of success shall be `{"status": "ok"}`.
## Deployment on a Kubernetes cluster ## Deployment on a Kubernetes cluster
There is a [Helm chart](./helm/) to ease the deployment on Kubernetes clusters. There is a [Helm chart](./helm/) to ease the deployment on Kubernetes clusters.
@ -105,9 +106,11 @@ Proceed with the deployment as follows:
``` ```
kubectl -n hugo-mx-gateway port-forward service/hugo-mx-gateway 8080:80 kubectl -n hugo-mx-gateway port-forward service/hugo-mx-gateway 8080:80
curl http://127.0.0.1:8080/ curl http://127.0.0.1:8080/
{"status": "ok"}
``` ```
The output in case of success shall be `{"status": "ok"}`.
## Deployment on Docker ## Deployment on Docker
An instance of `hugo-mx-gateway` can be quickly started on any machine running Docker. An instance of `hugo-mx-gateway` can be quickly started on any machine running Docker.
@ -116,7 +119,7 @@ An instance of `hugo-mx-gateway` can be quickly started on any machine running D
* Then apply the following command: * Then apply the following command:
``` ```
$ docker run -d \ docker run -d \
--publish 8080:8080 \ --publish 8080:8080 \
--name 'hugo-mx-gateway' \ --name 'hugo-mx-gateway' \
-e SMTP_SERVER_ADDR="smtp.example.com:465" \ -e SMTP_SERVER_ADDR="smtp.example.com:465" \
@ -134,8 +137,8 @@ An instance of `hugo-mx-gateway` can be quickly started on any machine running D
``` ```
curl http://127.0.0.1:8080/ curl http://127.0.0.1:8080/
{"status": "ok"}
``` ```
The output in case of success shall be `{"status": "ok"}`.
# Use the built-in form for Hugo # 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. 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.