Skip to content

Commit

Permalink
Edited README links
Browse files Browse the repository at this point in the history
  • Loading branch information
Khaaz committed Aug 26, 2018
1 parent cb97609 commit db04467
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It allows you to send requests to multiple Discord webhooks which is sent from G
4) 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 manging GitLab requests.

## Instructions on setting it up!
1) Copy paste the [config.template.json](https://github.com/Khaazz/GitHub-Discord-HookRouter/template/config-template.json) in [configs/config.json](https://github.com/Khaazz/GitHub-Discord-HookRouter/configs/).
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/).
```js
{
"port": "3000",
Expand All @@ -25,7 +25,7 @@ It allows you to send requests to multiple Discord webhooks which is sent from G

3) You can manually blacklist IP addresses by adding those to the `blacklisted` property. The API will automatically refuse connections from those IP addresses.

4) Copy paste the [webhooks.template.json](https://github.com/Khaazz/GitHub-Discord-HookRouter/template/webhooks-template.json) in [configs/webhooks.json](https://github.com/Khaazz/GitHub-Discord-HookRouter/configs/).
4) 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/).
```js
[
{
Expand All @@ -40,7 +40,7 @@ Provide a name, webhook's id, and token and you are good to go.

5) When setting up the webhook in github, copy the url to access this API with the path as `/github`. 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/GitHub-Discord-HookRouter/scripts/start.js) is located in the scripts folder which could be used if you want to use PM2.
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/).
Expand Down

0 comments on commit db04467

Please sign in to comment.