https://github.com/klipitkas/hooktail
🐉 A golang server that manages github webhook deployments.
https://github.com/klipitkas/hooktail
github github-hooks go golang http-server webhook webserver
Last synced: 10 months ago
JSON representation
🐉 A golang server that manages github webhook deployments.
- Host: GitHub
- URL: https://github.com/klipitkas/hooktail
- Owner: klipitkas
- License: unlicense
- Created: 2019-10-17T15:32:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-29T13:30:45.000Z (over 5 years ago)
- Last Synced: 2025-01-21T07:11:20.630Z (about 1 year ago)
- Topics: github, github-hooks, go, golang, http-server, webhook, webserver
- Language: Go
- Homepage:
- Size: 34.2 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hooktail
[](https://www.codefactor.io/repository/github/klipitkas/hooktail)
---
Hooktail is an HTTP server written in Go that can be used for github webhook
deployments.
## REQUIREMENTS
- [Go](https://golang.org/) >= **1.13**
## CONFIGURATION
Copy the sample configuration file and edit as per your liking:
```
cp config.example.yml config.yml
```
The available configuration is listed in the **config.example.yml** file.
## RUN THE TESTS
You can run all the available unit tests using the command below:
```
go test -v ./...
```
## BUILD & RUN
You can build and run the server using the following commands:
```
go build && sudo ./hooktail
```
**NOTE:** **sudo** is required in order to be able to run a deployment as a
specific user.
In order to specify a custom configuration file (other than **config.yml**)
you can use the following flag:
```
sudo ./hooktail -config
```
## TLS / SSL SUPPORT
Since **Hooktail** only supports HTTP, it cannot handle SSL termination. In
order to handle SSL termination you need a reverse proxy such as:
- [Nginx](https://www.nginx.com)
- [Haproxy](https://www.haproxy.org)