Yet another GitHub/GitLab Webhook listener, built with rifling.
-
Use
cargo:cargo install trigger
-
Download binary from GitHub release, and move it to your
PATH.
Commandline help:
trigger --helpStart the program
trigger "<path to config file>"Trigger's configurations are in YAML format.
Example:
# Sample config
settings:
host: 0.0.0.0:4567 # Host address trigger is going to listen
secret: "secret" # Secret used to authenticate payload (Optional)
print_commands: false # Print command or not (Optional, default: false)
capture_output: false # Capture output of the commands (Optional, default: false)
exit_on_error: true # Exit on error in commands (Optional, default: false)
events:
common: |
set -e;
PAYLOAD='{payload}';
function get_prop {
echo $(echo ${PAYLOAD} | jq $1 | tr -d '"');
}
SENDER=$(get_prop '.sender.login');
SENDER_ID=$(get_prop '.sender.id');
all: echo "This command will be executed in all the events, the current event is {event}";
push: echo "User \"{SENDER}\" with ID \"{SENDER_ID}\" pushed to this repository";
watch: |
ACTION=$(get_prop '.action');
echo "GitHub user \"${SENDER}\" with ID \"${SENDER_ID}\" ${ACTION} watching this repository";
else: echo "\"${SENDER}\" with ID \"${SENDER_ID}\" sent {event} event";- Secret is not required, but it's strongly recommended.
- Commands in
events.commonwill be executed before the actual event. - Commands in
events.allwill be executed in all - All available events are listed here and here.
- Note: Events from GitLab need to be reformatted as replacing
" "(whitespaces) with"_"(underscore) and make sure it's in lower case.- e.g.
Push Hookin GitLab's documentation will bepush_hookin trigger's configuration.
- e.g.
- Note: Events from GitLab need to be reformatted as replacing
- Commands in
events.elsewill be executed when no matching event defined. - Placeholder
{payload}in commands will be replaced with unparsed payload.- Please use single quotation mark to wrap around it.
- It is possible to use jq to parse it if needed.
- Other placeholders (if not included in the delivery, they will be replaced with
unknown):{id}will be replaced with ID of the event(UUID).{event}will be replaced with type of the event.{signature}will be replaced with signature of the payload.{request_body}will be replaced with body of the request.
It is also recommended to use it with a reverse proxy, such as nginx:
location /hook {
proxy_pass http://0.0.0.0:9999/;
}Systemd unit (trigger.service):
[Unit]
Description=Yet another GitHub Webhook listener
After=network-online.target
[Service]
Type=simple
WorkingDirectory=/path/to/your/config/
ExecStart=/path/to/trigger /path/to/your/config/file.yaml
Restart=always
RestartSec=3
[Install]
WantedBy=multi-user.target
# ｓｙ
# ｓｔｅ
# ｍｄ
This software is distributed under the terms of MIT license, for more details, please consult LICENSE file.
Trigger uses pretty_env_logger and log to log.
Trigger uses yaml-rust to parse configurations.
Trigger uses hyper to create web server.
Trigger uses run_script to run shell code.