added config in readme.md
This commit is contained in:
parent
cf20937a70
commit
ff4d50559c
20
README.md
20
README.md
@ -5,19 +5,21 @@ Ethereum Network Intelligence API
|
||||
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
|
||||
* cpp-ethereum
|
||||
* node
|
||||
* npm
|
||||
* cpp-ethereum
|
||||
|
||||
|
||||
## Installation on Ubuntu
|
||||
|
||||
Fetch and run the build shell.
|
||||
Fetch and run the build shell. This will install everything you need: latest eth CLI (develop branch), node.js, npm, pm2.
|
||||
|
||||
```
|
||||
curl https://raw.githubusercontent.com/cubedro/eth-net-intelligence-api/master/bin/build.sh | sh
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
Run it using pm2:
|
||||
|
||||
```
|
||||
@ -25,6 +27,20 @@ cd ~/bin/www
|
||||
pm2 start processes.json
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Configure the app in [processes.json](/eth-net-intelligence-api/blob/master/processes.json)
|
||||
|
||||
```
|
||||
"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
|
||||
"WS_SERVER" : "", // path to eth-netstats WebSockets api server
|
||||
}
|
||||
```
|
||||
|
||||
[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
|
||||
|
Loading…
Reference in New Issue
Block a user