Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
allgamescoindev committed Sep 8, 2018
1 parent 86e8604 commit cd1fb3d
Showing 1 changed file with 25 additions and 5 deletions.
30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Sentinel is implemented as a Python application that binds to a local version 0.

This guide covers installing Sentinel onto an existing Masternode in Ubuntu 14.04 / 16.04.

## Installation
## 1. Installation - Linux

### 1. Install Prerequisites
### 1.1. Install Prerequisites

Make sure Python version 2.7.x or above is installed:

Expand All @@ -25,15 +25,15 @@ Make sure the local AllGamesCoin daemon running is at least version 0.2.0 (20000

$ allgamescoin-cli getinfo | grep version

### 2. Install Sentinel
### 1.2. Install Sentinel

Clone the Sentinel repo and install Python dependencies.

$ git clone https://github.com/allgamescoindev/sentinel.git && cd sentinel
$ virtualenv ./venv
$ ./venv/bin/pip install -r requirements.txt

### 3. Set up Cron
### 1.3. Set up Cron

Set up a crontab entry to call Sentinel every minute:

Expand All @@ -43,14 +43,34 @@ In the crontab editor, add the lines below, replacing '/home/YOURUSERNAME/sentin

* * * * * cd /home/YOURUSERNAME/sentinel && ./venv/bin/python bin/sentinel.py >/dev/null 2>&1

### 4. Test the Configuration
### 1.4. Test the Configuration

Test the config by running 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 allgamescoind and the installation is complete

## Installation - Windows

### 1.1. Install Prerequisites

Download and install Python 2.7 https://www.python.org/

Open CMD

pip install pyinstaller

### 1.2. build

Download https://github.com/allgamescoindev/sentinel.git

Go to the unzipped folder

pip install -r requirements.txt

pyinstaller --onefile --paths=lib/ ./bin/sentinel.py

## Configuration

An alternative (non-default) path to the `allgamescoin.conf` file can be specified in `sentinel.conf`:
Expand Down

0 comments on commit cd1fb3d

Please sign in to comment.