Skip to content

Latest commit

 

History

History

sentinel

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
tests/unit
tests/unit
 
 
.eslintrc
.eslintrc
 
 
.npmignore
.npmignore
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 
docker-entrypoint.sh
docker-entrypoint.sh
 
 
nyc.config.js
nyc.config.js
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
server.js
server.js
 
 

README.md

Install

Get node deps with npm ci.

Run

node server.js

Debug mode:

node server.js debug

Overview

Sentinel listens to the CouchDB changes feed and runs a set of transitions on a given database change. It also manages scheduled tasks like message schedules.

Settings

Export a COUCH_URL env variable so sentinel knows what database to use. e.g.

export COUCH_URL='http:https://myadminuser:myadminpass@localhost:5984/medic'

Throughout this document we will be referring to ddoc. Here we mean the currently deployed _design/medic ddoc from the medic app.

Default settings values are in defaults.js. On initial start, and when there are changes to the ddoc, sentinel reads ddoc.app_settings to determine configuration.

By default all transitions are disabled, to enable a transition modify the transitions property on ddoc.app_settings.

Additional documentation