ethstats-client/README.md

64 lines
1.9 KiB
Markdown
Raw Normal View History

2015-02-12 23:30:12 +01:00
Ethereum Network Intelligence API
2015-02-11 23:21:10 +01:00
============
2015-02-25 22:28:34 +01:00
[![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url]
2015-02-11 23:21:10 +01:00
2015-02-26 22:02:13 +01:00
This is the backend service which runs along with the node for tracking the ethereum network status, fetches information through the JSON-RPC and connects through WebSockets to [eth-netstats](https://github.com/cubedro/eth-netstats) and feed information constantly.
## Prerequisite
2015-02-26 22:09:23 +01:00
* cpp-ethereum
2015-02-26 22:02:13 +01:00
* node
* npm
2015-02-26 22:09:23 +01:00
2015-02-26 22:02:13 +01:00
## Installation on Ubuntu
2015-02-26 22:11:18 +01:00
Fetch and run the build shell. This will install everything you need: latest cpp-ethereum - CLI (develop branch), node.js, npm, pm2.
2015-02-11 23:21:10 +01:00
```
2015-02-12 23:35:22 +01:00
curl https://raw.githubusercontent.com/cubedro/eth-net-intelligence-api/master/bin/build.sh | sh
2015-02-25 22:16:04 +01:00
```
2015-02-26 22:09:23 +01:00
## Configuration
2015-02-26 22:45:24 +01:00
Configure the app modifying [processes.json](/eth-net-intelligence-api/blob/master/processes.json). Note that you have to modify the backup processes.json file located in `./bin/processes.json` (to allow you to set your env vars without being rewritten when updating).
2015-02-26 22:09:23 +01:00
```
2015-02-26 22:10:04 +01:00
"env":
{
"NODE_ENV" : "production", // tell the client we're in production environment
"RPC_HOST" : "localhost", // eth JSON-RPC host
"RPC_PORT" : "8080", // eth JSON-RPC port
2015-03-04 22:02:00 +01:00
"ETH_IMPLEMENTATION" : "cpp", // eth implementation: "cpp" or "go"
2015-03-19 14:32:07 +01:00
"INSTANCE_NAME" : "",
2015-02-26 22:10:04 +01:00
"WS_SERVER" : "", // path to eth-netstats WebSockets api server
2015-02-26 22:45:24 +01:00
"WS_SECRET" : "", // WebSockets api server secret used for login
2015-02-26 22:10:04 +01:00
}
2015-02-26 22:09:23 +01:00
```
2015-02-26 22:45:24 +01:00
## Run
Run it using pm2:
```
cd ~/bin
pm2 start processes.json
```
2015-02-26 22:47:56 +01:00
## Updating
To update the API client use the following commands:
```
pm2 kill
cd ~/bin/www
git pull
sudo npm update
sudo npm install
cd ..
pm2 start processes.json
```
2015-02-25 22:28:34 +01:00
[travis-image]: https://travis-ci.org/cubedro/eth-net-intelligence-api.svg
[travis-url]: https://travis-ci.org/cubedro/eth-net-intelligence-api
[dep-image]: https://david-dm.org/cubedro/eth-net-intelligence-api.svg
[dep-url]: https://david-dm.org/cubedro/eth-net-intelligence-api