bigchaindb/docs/server/source/quickstart.md
michielmulders 21142f1ea0 Update quickstart.md with minor details
At point D, you start the mongo shell which is listening on port 27017 for incoming connections from BDB.
At point E, you don't mention to open a new terminal because you want to keep the mongo shell alive (or run it in background with addition of '&', however I prefer to see the mongo output). Being stupid me, I shut down the terminal which resulted in not being able to start BDB.

Beside that, I added a verification step to make sure that BDB server is running correctly.
2017-07-20 22:56:36 +02:00

2.4 KiB

Quickstart

This page has instructions to set up a single stand-alone BigchainDB node for learning or experimenting. Instructions for other cases are elsewhere. We will assume you're using Ubuntu 16.04 or similar. If you're not using Linux, then you might try running BigchainDB with Docker.

A. Install MongoDB as the database backend. (There are other options but you can ignore them for now.)

Install MongoDB Server 3.4+

B. To run MongoDB with default database path i.e. /data/db, open a Terminal and run the following command:

$ sudo mkdir -p /data/db

C. Assign rwx(read/write/execute) permissions to the user for default database directory:

$ sudo chmod -R 700 /data/db

D. Run MongoDB (do not close this terminal):

$ sudo mongod --replSet=bigchain-rs

E. Ubuntu 16.04 already has Python 3.5, so you don't need to install it, but you do need to install some other things within a new terminal:

$ sudo apt-get update
$ sudo apt-get install g++ python3-dev libffi-dev build-essential libssl-dev

F. Get the latest version of pip and setuptools:

$ sudo apt-get install python3-pip
$ sudo pip3 install --upgrade pip setuptools

G. Install the bigchaindb Python package from PyPI:

$ sudo pip3 install bigchaindb

In case you are having problems with installation or package/module versioning, please upgrade the relevant packages on your host by running one the following commands:

$ sudo pip3 install [packageName]==[packageVersion]

OR

$ sudo pip3 install [packageName] --upgrade

H. Configure BigchainDB Server:

$ bigchaindb -y configure mongodb

I. Run BigchainDB Server:

$ bigchaindb start

J. Verify BigchainDB Server setup by visiting the BigchainDB Root Url in your browser (if not changed during installation):

$ http://127.0.0.1:9984/

A correctly installed installation will show you a JSON object with information about the API, docs, version and your public key.

You now have a running BigchainDB Server and can post transactions to it. One way to do that is to use the BigchainDB Python Driver.

Install the BigchainDB Python Driver (link)