README updated
This commit is contained in:
parent
835612da4e
commit
e251a269fa
30
README.md
30
README.md
|
@ -3,13 +3,13 @@
|
|||
Insight is an open-source bitcoin blockchain explorer with complete REST
|
||||
and websocket APIs. Insight runs in NodeJS, and uses AngularJS for the
|
||||
front-end and LevelDB for storage.
|
||||
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* Node.js v0.10.x - Download and Install [Node.js](http://www.nodejs.org/download/).
|
||||
You can also follow [this gist](https://gist.github.com/isaacs/579814)
|
||||
for a quick and easy way to install Node.js and npm. If you use Ubuntu:
|
||||
* Node.js v0.10.x - Download and Install [Node.js](http://www.nodejs.org/download/).
|
||||
You can also follow [this gist](https://gist.github.com/isaacs/579814)
|
||||
for a quick and easy way to install Node.js and npm. If you use Ubuntu:
|
||||
|
||||
```git clone git@github.com:joyent/node.git && cd node && git checkout v0.10.24 && ./configure && make && make install```
|
||||
|
||||
|
@ -20,7 +20,7 @@ bitcoin directory (usually ~/.bitcoin).
|
|||
|
||||
### Tools
|
||||
* NPM - Node.js package manager, should be installed when you install node.js.
|
||||
* Grunt - Download and Install [Grunt](http://gruntjs.com). You can do this by running:
|
||||
* Grunt - Download and Install [Grunt](http://gruntjs.com). You can do this by running:
|
||||
```
|
||||
npm install -g grunt-cli
|
||||
```
|
||||
|
@ -42,7 +42,7 @@ $ npm install -g bower
|
|||
Use [Grunt](https://github.com/gruntjs/grunt-cli) to start the server:
|
||||
|
||||
$ grunt
|
||||
|
||||
|
||||
Then open a browser and go to:
|
||||
|
||||
http://localhost:3000
|
||||
|
@ -60,11 +60,11 @@ grunt test
|
|||
|
||||
|
||||
## DB storage requirement
|
||||
|
||||
To store the blockchain and address related information, Insight uses LevelDB. Two DBs are created: txs and blocks. By default these are
|
||||
stored on <insight root>/db (this can be changed on config/config.js).
|
||||
|
||||
As of February 2014, storing the blockchain takes ~31Gb of disk space on levelDB,
|
||||
To store the blockchain and address related information, Insight uses LevelDB. Two DBs are created: txs and blocks. By default these are
|
||||
stored on <insight root>/db (this can be changed on config/config.js).
|
||||
|
||||
As of February 2014, storing the blockchain takes ~31Gb of disk space on levelDB,
|
||||
and Insight needs ~7hrs to complete the syncronization process.
|
||||
|
||||
## Syncing old blockchain data
|
||||
|
@ -73,7 +73,7 @@ and Insight needs ~7hrs to complete the syncronization process.
|
|||
LevelDB):
|
||||
|
||||
Create folders:
|
||||
|
||||
|
||||
$ mkdir -p db/blocks
|
||||
$ utils/sync.js -S
|
||||
|
||||
|
@ -176,10 +176,10 @@ There is a bitcoind configuration sample at:
|
|||
|
||||
If you want to use a external bitcoind server set the following environment variables:
|
||||
```
|
||||
BITCOIND_HOST
|
||||
BITCOIND_HOST
|
||||
BITCOIND_PORT # RPC Bitcoind Port
|
||||
BITCOIND_P2P_PORT # P2P Bitcoind Port
|
||||
BITCOIND_USER
|
||||
BITCOIND_P2P_PORT # P2P Bitcoind Port
|
||||
BITCOIND_USER
|
||||
BITCOIND_PASS
|
||||
BITCOIND_DATADIR # bitcoind datadir for livenet, or datadir/testnet3 for testnet
|
||||
INSIGHT_NETWORK [= 'livenet' | 'testnet']
|
||||
|
@ -187,7 +187,7 @@ If you want to use a external bitcoind server set the following environment vari
|
|||
|
||||
Make sure that bitcoind is configured to accept incomming connections using 'rpcallowip' decribed in https://en.bitcoin.it/wiki/Running_Bitcoin. Alternatively change config/env/$NODE_ENV.js
|
||||
|
||||
In case the network is changed, mongoDB database need to be deleted. This can be performed running:
|
||||
In case the network is changed, levelDB database need to be deleted. This can be performed running:
|
||||
```
|
||||
util/sync.js -D
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue