Skip to content

Commit

Permalink
Merge pull request #27 from penguineer/repo-maintenance
Browse files Browse the repository at this point in the history
🔧 Repository maintenance
  • Loading branch information
penguineer authored May 26, 2023
2 parents ca86e07 + 2225734 commit 849af72
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 37 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
github: [penguineer]
ko_fi: penguineer
6 changes: 4 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ on:
jobs:
build:
name: "Release"
runs-on: ubuntu-18.04
runs-on: ubuntu-latest
steps:
- name: "Check-out"
uses: actions/checkout@v1
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: "Generate release changelog"
id: generate-release-changelog
uses: heinrichreimer/github-changelog-generator-action@v2.3
Expand Down
28 changes: 0 additions & 28 deletions .github/workflows/tweet-release.yml

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2022 Stefan Haun and contributors
Copyright 2022-2023 Stefan Haun and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ It should be not too hard to convert this into a Lambda Function or a similar on

### Run with Docker

With the configuration stored in a file `.env`, the daemon can be started as follows:
With the configuration stored in a file `.env`, the daemon can be started as follows:

```bash
docker run --rm \
Expand Down Expand Up @@ -74,7 +74,7 @@ The `FORM_EMAIL_CHECK` decides how the e-mail field is handled:
### HTML Form

Please have a look at the [example form](example/example-form.html) on how to embed the service into a static
website. The `{{ ... }}` sections mark where values need to be entered by your backend or templating engine.
website. The `{{ ... }}` sections mark where values need to be entered by your backend or templating engine.
Service and form are tested with [Jekyll](https://jekyllrb.com/).
If you change field names, please also adapt the service configuration accordingly.

Expand All @@ -100,22 +100,22 @@ The [reCAPTCHA example form](example/example-form-recaptcha.html) shows a client
Please be aware that this will send data to Google!
Only the minimal amount of data is sent, i.e. excluding the IP address, yet this needs to be mentioned in any GDPR declaration.

To disable this feature, just leave the `RECAPTCHA_SECRET` unset or empty.
To disable this feature, just leave the `RECAPTCHA_SECRET` unset or empty.


### Health endpoint

The daemon features a health endpoint to check if all components are up and running.
While a certain amount of resilience is built into the handlers, an overall check routine using the Docker
health checks has been established.
health checks has been established.
The endpoint works similar to health endpoints expected for Microservices, e.g. in a Kubernetes runtime environment:
* HTTP status 200 is returned when the service is considered healthy.
* HTTP status 500 is returned when the service is considered unhealthy.
* Additional information can be found in the return message. Please refer to the [OAS3](src/OAS3.yml) for details.

The [Dockerfile](Dockerfile) sets the container up for a health check every 10s, otherwise sticks to the Docker defaults.

To expose the health endpoint, route port 8080 to a port that is suitable for the deployment environment.
To expose the health endpoint, route port 8080 to a port that is suitable for the deployment environment.


## Maintainers
Expand All @@ -136,4 +136,4 @@ If possible, please stick to the following guidelines:

## License

[MIT](LICENSE.txt) © 2022 Stefan Haun and contributors
[MIT](LICENSE.txt) © 2022-2023 Stefan Haun and contributors

0 comments on commit 849af72

Please sign in to comment.