marrub
/
UNATCORelay
1
0
Fork 0
Code Issues Releases Activity

Create README.md

master
Marrub 2016-10-29 03:10:56 -04:00 committed by GitHub
parent e6dfea6392
commit b858280b9d
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# UNATCORelay
UNATCORelay is a Node server that you can use to route GitHub messages to Discord channels via webhooks.
UNATCORelay works per-channel (hook) and accepts any messages as long as they are validated as coming from GitHub.
This may be a bit awkward for some but I am a busy man and this suits my needs, so please do use the issue tracker
and pull requests if you need features added.
## Environment Configuration
- `PORT`: Port to host on. Required.
- `WEBHOOK_URI`: URI for the webhook to send to. Required.
- `GITHUB_SECRET`: Secret key for validating requests. Not required, but *heavily recommended*.
- `VHOST`: Virtual host to respond from. Recommended if you use your own subdomain.
### Example
`WEBHOOK_URI='https://canary.discordapp.com/api/webhooks/whatever' GITHUB_SECRET='whatever' VHOST='whatever.wherever.com' PORT=6666 npm run start`