An all-powerful toolset for Scriv.
Sentinel is an autonomous agent for persisting, processing and automating Scriv v.1.0 (Dash v.12.1) governance objects and tasks.
Sentinel is implemented as a Python application that binds to a local version scrivd instance on each Scriv Masternode.
This guide covers installing Sentinel onto an existing Masternode in Ubuntu 14.04 / 16.04.
Make sure Python version 2.7.x or above is installed:
python --version
Update system packages and ensure virtualenv is installed:
$ sudo apt-get update
$ sudo apt-get -y install virtualenv
Make sure the local Scriv daemon running is at least version 1.0.0 (100000)
$ scriv-cli getinfo | grep version
Clone the Sentinel repo and install Python dependencies.
$ git clone https://github.com/scrivnetwork/sentinel.git && cd sentinel
$ virtualenv ./venv
$ ./venv/bin/pip install -r requirements.txt
Test the config by runnings all tests from the sentinel folder you cloned into
$ ./venv/bin/py.test ./test
With all tests passing and crontab setup, Sentinel will stay in sync with scrivd and the installation is complete Run the sentinel once. It may pause for up to 30 seconds before returning. There should be no output in a normal return
$ ./venv/bin/python bin/sentinel.py
Adjust access rights to the sentinel database
$ chmod -R 755 database
Set up a crontab entry to call Sentinel every minute:
$ crontab -e
In the crontab editor, add the lines below, replacing '/home/YOURUSERNAME/sentinel' to the path where you cloned sentinel to:
* * * * * cd /home/YOURUSERNAME/sentinel && ./venv/bin/python bin/sentinel.py >> sentinel.log 2>&1
An alternative (non-default) path to the scriv.conf
file can be specified in sentinel.conf
:
scriv_conf=/path/to/scriv.conf
To view debug output, set the SENTINEL_DEBUG
environment variable to anything non-zero, then run the script manually:
$ SENTINEL_DEBUG=1 ./venv/bin/python bin/sentinel.py
Released under the MIT license, under the same terms as ScrivCore itself. See LICENSE for more info.