hugo-mx-gateway/docs/deployment-on-docker.md

30 lines
992 B
Markdown
Raw Normal View History

2022-04-29 11:17:22 +02:00
# Deploying hugo-mx-gateway on Docker
2022-04-30 12:04:36 +02:00
As described in the below procedure, an instance of `hugo-mx-gateway` can be quickly started on any machine running Docker.
2022-04-29 11:17:22 +02:00
2022-04-30 12:04:36 +02:00
First review the [configuration variables](./configuration-variables.md).
2022-04-29 11:17:22 +02:00
2022-04-30 12:04:36 +02:00
Then apply the following command while setting the configuration variables appropriately:
2022-04-29 11:17:22 +02:00
```
docker run -d \
--publish 8080:8080 \
--name 'hugo-mx-gateway' \
-e SMTP_SERVER_ADDR="smtp.example.com:465" \
-e SMTP_VERITY_CERT=true \
-e SMTP_CLIENT_USERNAME="postmaster@example.com" \
-e SMTP_CLIENT_PASSWORD="postmasterSecretPassWord" \
-e CONTACT_REPLY_EMAIL="noreply@example.com" \
-e CONTACT_REPLY_BCC_EMAIL="contact@example.com" \
-e DEMO_URL="https://demo.example.com/" \
-e ALLOWED_ORIGINS="127.0.0.1,example.com" \
rchakode/hugo-mx-gateway
```
2022-04-30 12:04:36 +02:00
Check that the container is up and functionning.
2022-04-29 11:17:22 +02:00
```
curl http://127.0.0.1:8080/
```
The output in case of success shall be `{"status": "ok"}`.