Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update readme download binaries #58

Merged
merged 1 commit into from
Jun 28, 2024
Merged

chore: update readme download binaries #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ Inhooks listens to HTTP webhooks and saves the messages to Redis. A processing m
- Supports message transformation using JavaScript ECMAScript 5.1
- ... more features planned

## Downloading release binaries
The release binaries are available on the [GitHub releases](https://github.com/didil/inhooks/releases) page.
To download a specific version, adjust then env vars below and run:
```shell
export INHOOKS_VERSION="0.1.9"
export OS="linux"
export ARCH="amd64"
curl -LO https://github.com/didil/inhooks/releases/download/v${INHOOKS_VERSION}/inhooks_${INHOOKS_VERSION}_${OS}_${ARCH}.tar.gz
tar -xvzf inhooks_${INHOOKS_VERSION}_${OS}_${ARCH}.tar.gz
```

## Usage
### Inhooks config
The inhooks config file allows setting up the Source to Sink flows.
Expand Down Expand Up @@ -62,6 +73,12 @@ In case of failures, retries are attempted based on the sink config params.

If the config is modifed, the server must be restarted to load the new config.

### Env vars
Copy the .env examples to init the .env file and update as needed (to set the inhooks config file path, the redis url, the server port, etc).
```shell
cp .env.example .env
```

### Securing webhooks
If you would like to verify your webhooks with HMAC 256, you can use the following configuration:

Expand Down
Loading