poanetwork
/
eth-net-intelligence-api
mirror of https://github.com/poanetwork/eth-net-intelligence-api.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
12 Commits 2 Branches 0 Tags 63 KiB
JavaScript 79.8%
Shell 13.7%
Dockerfile 6.5%
Go to file
phahulin f4d30aa024
Merge pull request #2 from PeterTheOne/patch-1 
fixed initialization of websocket
 		2019-09-09 17:10:57 +03:00
bin Initial commit 2017-07-06 14:10:00 +03:00
lib Merge pull request #2 from PeterTheOne/patch-1 2019-09-09 17:10:57 +03:00
.gitignore Initial commit 2017-07-06 14:10:00 +03:00
.travis.yml Initial commit 2017-07-06 14:10:00 +03:00
Dockerfile Initial commit 2017-07-06 14:10:00 +03:00
LICENSE Initial commit 2017-07-06 14:10:00 +03:00
README.md Initial commit 2017-07-06 14:10:00 +03:00
app.js Initial commit 2017-07-06 14:10:00 +03:00
app.json.example Initial commit 2017-07-06 14:10:00 +03:00
package.json Update package.json 2017-08-07 12:19:37 +03:00
processes-ec2.json Initial commit 2017-07-06 14:10:00 +03:00

README.md

Ethereum Network Intelligence API

Build Status dependency status

This is the backend service which runs along with ethereum and tracks the network status, fetches information through JSON-RPC and connects through WebSockets to eth-netstats to feed information. For full install instructions please read the wiki.

Prerequisite

  • eth, geth or pyethapp
  • node
  • npm

Installation on an Ubuntu EC2 Instance

Fetch and run the build shell. This will install everything you need: latest ethereum - CLI from develop branch (you can choose between eth or geth), node.js, npm & pm2.

bash <(curl https://raw.githubusercontent.com/cubedro/eth-net-intelligence-api/master/bin/build.sh)

Installation as docker container (optional)

There is a Dockerfile in the root directory of the repository. Please read through the header of said file for instructions on how to build/run/setup. Configuration instructions below still apply.

Configuration

Configure the app modifying 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).

"env":
	{
		"NODE_ENV"        : "production", // tell the client we're in production environment
		"RPC_HOST"        : "localhost", // eth JSON-RPC host
		"RPC_PORT"        : "8545", // eth JSON-RPC port
		"LISTENING_PORT"  : "30303", // eth listening port (only used for display)
		"INSTANCE_NAME"   : "", // whatever you wish to name your node
		"CONTACT_DETAILS" : "", // add your contact details here if you wish (email/skype)
		"WS_SERVER"       : "wss://rpc.ethstats.net", // path to eth-netstats WebSockets api server
		"WS_SECRET"       : "see http://forum.ethereum.org/discussion/2112/how-to-add-yourself-to-the-stats-dashboard-its-not-automatic", // WebSockets api server secret used for login
		"VERBOSITY"       : 2 // Set the verbosity (0 = silent, 1 = error, warn, 2 = error, warn, info, success, 3 = all logs)
	}

Run

Run it using pm2:

cd ~/bin
pm2 start processes.json

Updating

To update the API client use the following command:

~/bin/www/bin/update.sh

It will stop the current netstats client processes, automatically detect your ethereum implementation and version, update it to the latest develop build, update netstats client and reload the processes.