Browse Source

Add information of how to use to README

master
Matei-Alexandru Gardus 8 months ago
parent
commit
56dc89240a
No known key found for this signature in database
1 changed files with 26 additions and 1 deletions
  1. 26
    1
      README.md

+ 26
- 1
README.md View File

@@ -3,4 +3,29 @@
3 3
 GitHookParser is a nifty server written in Go that can take a GitHub webhook, parse it according to configuration, and redirect it to another POST endpoint.
4 4
 
5 5
 Primarily, this can be used to manage multiple webhooks for GitHub repos on the fly and send them all to a push notification service defined by the user,
6
-such as [Pushover](https://pushover.net/).
6
+such as [Pushover](https://pushover.net/). Currently, this is the only notification service supported.
7
+
8
+## Getting started
9
+
10
+To install GitHookParser, simply
11
+
12
+```
13
+go get -u -v github.com/stormfirefox1/GitHookParser
14
+```
15
+
16
+By default, a configuration file is needed under *$HOME/.config/git-hook-parser/config.yml*. If there is a file there, it will read any environment variables
17
+from the respective file. You will need to set, at minimum:
18
+
19
+- REDIRECT_URL
20
+- API_KEY
21
+- USER_TOKEN
22
+
23
+After creating the configuration file, run the compiled binary, either by `go install` it or by running `go build` and moving the binary to your directory of choice.
24
+
25
+Then, point GitHub's webhook to:
26
+
27
+```
28
+http://example.com:80/github-hook
29
+```
30
+
31
+and watch the magic happen.

Loading…
Cancel
Save