hookd
v1.0.0
Published
hookd is an extremely simple Node JS tool that allows you to easily create HTTP endpoints, which you can use to execute pre-configured commands.
Downloads
8
Readme
hookd
hookd is an extremely simple Node.js tool that allows you to easily create HTTP endpoints, which you can use to execute pre-configured commands.
- Multiple endpoints
- Basic-auth
- Push notifications via pushover.net
Installation
hookd is installed and managed via npm, the Node.js package manager. Before you get started you'll need to make sure Node.js is installed.
npm install -g hookd
Configuration
hookd uses a JSON configuration file to define endpoints. Check out config.json.default to see the available options and expected format.
Usage
Specify a port and config file and you're good to go!
hookd -p 4000 -c /home/user/config.json
Contributing
Contributions are welcome :+1:
- Fork it
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request! :smile:
Todo
- Refactor/tidy code, add comments
- Add support for HTTPS endpoints