Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dougestey committed Jul 28, 2018
1 parent 8988cf0 commit d41b779
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,22 @@ A WebSocket-compatible kill & fleet tracker for EVE Online, built [on Sails.js](

- Install Node >= 8
- Install Yarn
- Install and [configure](config/redis.js) Redis
- Install and [configure](config/datastores.js) a database (PostgreSQL preferred)
- Install and [configure](config/jobs.js) Redis

The app will refuse to run without a valid root-level `.env` - see the [example file.](.env.example)

## Boot ##

For first run you're going to want to set `BOOTSTRAP_DB` to `true` (above).

$ cd sentinel
$ yarn
$ node app.js

And now you're listening for kills and saving them to the DB in real time. RedisQ will remember who you are for up to 3 hours if you go offline, otherwise you're considered a new listener.

Provided it's not firewalled, a frontend to the job queue will be available at http://YOUR_URL:6564.
Provided it's not firewalled, a frontend to the job queue will be available at http://YOUR_URL:6574.

If you're going to leave this thing running permanently, you should run it `NODE_ENV=production` (i.e. `npm start`).

## Support ##

Expand Down

0 comments on commit d41b779

Please sign in to comment.