@lanternfly/imogen NPM

Imogen

Imogen is a Node based job scheduler build on top of Node Schedule.

Getting Started

Install the package @lanternfly/imogen globally using npm install -g @lanternfly/imogen.
Create a configuration file. See the Configuration section for more details.
Run imogen --config=<path to config file> to run the job scheduler.

Configuration

Sample Configuration File

{
  "database": {
    "path": "imogen.db"
  },
  "jobs": [
    {
      "name": "job-1",
      "time": "* * * * * *",
      "command": "ls"
    }
  ],
  "server": {
    "enabled": true,
    "bindHostname": "localhost",
    "bindPort": 16061
  }
}

Configuration API

A configuration is a json file with the following fields:

Field	Type	Description	Is Required?	Default
`database.path`	String	This is the path to the SQLite database file. If no path is provided a file titled `imogen.db` will be created in the working directory.	No	`imogen.db`
`jobs`			Yes
`jobs[#].name`	String	The name of the job. The name can only contain letters, numbers, dashes, and underscores.	Yes
`jobs[#].time`	String	This is a cron style string specifying when the job will run. See this for more details.	Yes
`jobs[#].timeZone`	String	One of the timezone specified in here.	No	`Etc/UTC`
`jobs[#].command`	String	The system command which should be run on each job execution.	Yes
`jobs[#].overlap`	Boolean	Flag for whether multiple instances of job can be executed at once. If `true`, multiple instances can run concurrently. If `false`, the next job will not be run until the previous instance has been completed.	No	`true`
`server.enabled`	Boolean		No	`false`
`server.bindHostname`	String		No	`localhost`
`server.bindPort`	Integer		No	`16061`