Skip to content

A crontab-like service for triggering HTTP Endpoints in a timely manner.

License

Notifications You must be signed in to change notification settings

GCSBOSS/cronenberg

Repository files navigation

A crontab-like service that will send HTTP requests to any endpoints you setup in a timely manner.

Get Started

  1. Install with: npm i -g cronenberg.
  2. Write your config file in the following format:
cook-hen:
  spec: "* * * * *" # Crontab spec
  method: post
  url: http://kitchen/dish
  body: some hen, please # Optional
  headers: # Optional
    Content-Type: text/plain

boil-water:
  spec: "1,30 * * * *"
  method: post
  url: http://kitchen/hot-water

# ...
  1. Run in the terminal with: cronenberg -c path/to/conf.yml.

Get Started with Docker

The official image repository in Docker Hub is gcsboss/cronenberg.

Run like this: docker run -v /path/to/your/conf.yml:/usr/src/app/conf.yml gcsboss/cronenberg

Reporting Bugs

If you have found any problems with this module, please:

  1. Open an issue.
  2. Describe what happened and how.
  3. Also in the issue text, reference the label ~bug.

We will make sure to take a look when time allows us.

Proposing Features

If you wish to get that awesome feature or have some advice for us, please:

  1. Open an issue.
  2. Describe your ideas.
  3. Also in the issue text, reference the label ~proposal.

Contributing

If you have spotted any enhancements to be made and is willing to get your hands dirty about it, fork us and submit your merge request so we can collaborate effectively.