How to Use Jobber
Version 1.41.31.21.1

Section prefs

This section sets general preferences for how Jobber runs this user’s jobs. At this time, there is only one valid field.

Section jobs

This section defines the user’s jobs.

As stated above, this section must contain a YAML file that defines a sequence of mappings. Each mapping in this sequence defines a job.

The fields of a job definition:

Time Strings

Field time specifies the schedule at which a job is run, in a manner similar to how cron jobs’ schedules are specified: with a space-separated list of up to six specifiers, each one of which constrains a different component of time (second, minute, hour, etc.). Schematically:

sec min hour month_day month week_day

A job is scheduled thus: it will run at any time that satisfies all of the specifiers sec, min, hour, and month and one of the specifiers month_day and week_day.

Each specifier can take one of the following forms: (“a”, “b”, “c”, and “n” are placeholders for arbitrary numerals.)

The specifiers have different permitted values for the placeholders in the specifier forms:

Error-handling

Some terms: When Jobber runs a job and that job exits with a non-0 status, we call that a job error. When Jobber stops scheduling runs of a job due to one or more job errors, we call that a job failure.

In the onError field in the job’s definition, you can control what Jobber does after a job error by picking one of these values:

If you would like Jobber to notify you when a job errors or fails, first set notifyOnError or notifyOnFailure to true in the job’s definition in the Jobber file.

Then, write a notify program — a program that does whatever logic you want done after an error or failure. Set the notifyProgram field in the prefs section of the Jobber file to the path to your notify program.

When Jobber calls your notify program, it will write to stdin a JSON document like this:

{  
   "job":{  
      "command":"/home/dylan/some_program",
      "name":"MyHourlyJob",
      "notifyOnError":true,
      "notifyOnFailure":false,
      "onError":"Stop",
      "status":"Failed",
      "time":"0 0 * * * *"
   },
   "startTime":"May 29 15:25:10 2017",
   "stderr":"Some errors\n",
   "stderr_base64":false,
   "stdout":"Quotes: \"adf\"\n",
   "stdout_base64":false,
   "succeeded":false,
   "user":"dylan"
}

The fields in the job object are from the job’s definition, except for status , which contains Good , Backoff , or Failed .

stdout (respectively, stderr ) contains whatever the job wrote to stdout (stderr). If stdout_base64 contains true , then the job wrote only UTF-8 bytes to stdout (stderr), and stdout ( stderr ) contains a string with those bytes; otherwise, there were some non-UTF-8 bytes and stdout ( stderr ) contains a Base64 encoding of the output.