1.0.0 • Published 10 years ago

hookd v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
10 years ago

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:

  1. Fork it
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request! :smile:

Todo

  • Refactor/tidy code, add comments
  • Add support for HTTPS endpoints