https://github.com/khaaz/discord-githook
Lightweight API that routes github and gitlab webhook requests to Discord
https://github.com/khaaz/discord-githook
discord discord-webhooks github github-webhooks gitlab gitlab-webhook router
Last synced: 3 months ago
JSON representation
Lightweight API that routes github and gitlab webhook requests to Discord
- Host: GitHub
- URL: https://github.com/khaaz/discord-githook
- Owner: Khaaz
- License: mit
- Created: 2018-08-22T19:27:49.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-12-10T20:35:39.000Z (over 2 years ago)
- Last Synced: 2023-10-24T10:38:23.964Z (over 1 year ago)
- Topics: discord, discord-webhooks, github, github-webhooks, gitlab, gitlab-webhook, router
- Language: JavaScript
- Homepage:
- Size: 312 KB
- Stars: 9
- Watchers: 1
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord-GitHook
Manage all your GitHub / GitLab webhooks with one URL.
This lightweight API allows you to route GitHub and GitLab webhook requests to Discord. It allows auto parsing of gitlab webhook to a discord format, easy management of multiple webhooks, setting up multiple network!
## Features
- Gitlab webhooks parsing to discord format.
- Same format for both GitHub and GitLab to keep consistency.
- Routing all GitHub and GitLab request to one URL.
- Transfer request to all discord webhooks configured.
- Multiple networks to allow using the same Discord-githook instance
- Authorisation and signature verification.
- Full Rate-limit handling (discord webhooks).
- IP banning and verification, IP auto-banning for repeated unauthorized requests.
- Cool logging.
It allows you to forward GitHub and GitLab requests to multiple Discord webhooks. As you guessed it, this API will act as the POSTman in delivering the requests. It also auto-bans IP addresses on repeated access if the request is unauthorized.
## Precautions
1) It is highly recommended to protect this endpoint with signature verification to prevent unauthorized access to your API. More info about creating a secure secret with a high entropy could be found [here](https://developer.github.com/webhooks/securing/).
It is important to note that gitlab doesn't encript the auth token which is directly passed as is in the headers. Github in contrary, does encrypt the secret token.
2) The content type should be set to `application/json` when the GitHub webhook is being created, or it will cause unintended issues as Discord can't parse any other content-type.
3) Although this API supports handling requests from the baseURL, we recommend you to use the allocated path of the webhook. For example, use the path `/github` if you're using this API for managing GitHub requests and `/gitlab` when using this API for managing GitLab requests.
## Instructions on setting it up
1) Copy paste the [template/config.template.json](https://github.com/Khaazz/GitH-Discord-HookRouter/template/config-template.json) in [configs/config.json](https://github.com/Khaazz/Git-Discord-HookRouter/configs/).
```json
{
"port": "3000",
"authorizationGithub": "Secret key",
"authorizationGitlab": "Secret key",
"blacklisted": ["ip", "ip"],
"networks": [
{
"name": "networkname",
"authorizationGithub": "Secret key",
"authorizationGitlab": "Secret key"
}
]
}
```
2) If you want to secure your API using the GitHub/Gitlab webhook secret, just set either `authorizationGithub` or `authorizationGitlab` to the appropriate value.
Theses value being let as empty string will count as no auth setup.
Important:
- If you want to have network specific auth, you can setup `authorizationGithub` or `authorizationGitlab` in the network object (see config example above).
- Letting these as empty string will disable auth for this network.
- Removing these will make the network use the global auth.
3) You can manually blacklist IP addresses by adding those to the `blacklisted` property. The API will automatically refuse connections from those IP addresses.
3) Copy paste the [template/webhooks.template.json](https://github.com/Khaazz/Git-Discord-HookRouter/template/webhooks-template.json) in [configs/webhooks.json](https://github.com/Khaazz/Git-Discord-HookRouter/configs/).
```json
[
{
"name": "webhook",
"id": "webhookID",
"token": "webhookToken",
"networks": ["networkname"]
}
]
```
The webhooks config contains the array of all webhooks you want to manage.
Provide a name, webhook's id, and token and you are good to go.
You need to specify wich network this webhook belongs too. Fill up the `networks` array with all the networks this webhook belongs to.
If you don't provide the `networks` property or let the array empty, the webhook will automatically be part of the default network.
5) You need to specify the network you are using like this: `{baseURL}/{network}/{provider}`.
`{baseURL}` is replaced with the url to which your API is reachable.
`{network}` is the network name you want this webhook to send request to.
`{provider}` is the webhook provider. It is either `github` or `gitlab`.
When setting up the webhook in GitHub, copy the url to access this API and append `/github` at the end of the path (after the `/network`). Don't forget to change the content type to `application/json` and provide a secret token if you are going to use one. Same goes for setting up GitLab webhooks.
6) Start this API by executing `node src/app.js` in the console. [PM2 script](https://github.com/Khaazz/Git-Discord-HookRouter/scripts/start.js) is located in the scripts folder which could be used if you want to use PM2.
Alternatively, you can use `npm start` or `npm pm2start`.
7) If you want to quickly host this API, you could use ngrok; which is available [here](https://ngrok.com/).
### Contributions
Feel free to contribute to this project by opening Pull-Request or Issues.
Contributions are always welcome.
### Honorable mentions
Huge thanks to [Santhosh-Annamalai](https://github.com/Santhosh-Annamalai) for being helpful when building this API.