https://github.com/famedly/hookd

https://github.com/famedly/hookd

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/famedly/hookd
• Owner: famedly
• License: agpl-3.0
• Created: 2023-07-07T15:00:27.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-22T12:50:04.000Z (4 months ago)
• Last Synced: 2024-07-22T15:14:46.479Z (4 months ago)
• Language: Rust
• Size: 104 KB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# hookd

A simple webhook daemon that supports multiple hooks, passing env vars and

reading stdout/stderr. Similar to

[microhookd](https://github.com/the-maldridge/microhookd) and

[webhook](https://github.com/adnanh/webhook).

## Installation

Use the package manager [cargo](https://doc.rust-lang.org/cargo/) to install hookd.

```bash

cargo install hookd

```

## Usage

Create a config file in `~/.config/hookd/config.yaml` based on the `config.sample.yaml` in this repo.

### Healthcheck for Docker container

The service API implements the `/health` check for the Docker containers.

*IMPORTANT*: In order the Docker container to be able to perform the check, the image MUST provide the `curl` tool. If changing or updating the base image's version, please ensure the `curl` availability!

````BASH

curl -s http://localhost:9320/health || exit 1

````

S. [Dockerfile](./Dockerfile) for details.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[AGPL-3.0-only](https://choosealicense.com/licenses/agpl-3.0/)