diff --git a/docs/server/source/quickstart.md b/docs/server/source/quickstart.md index e066a046..79144b72 100644 --- a/docs/server/source/quickstart.md +++ b/docs/server/source/quickstart.md @@ -1,72 +1,70 @@ # Quickstart -This page has instructions to set up a single stand-alone BigchainDB node for learning or experimenting. Instructions for other cases are [elsewhere](introduction.html). We will assume you're using Ubuntu 16.04 or similar. You can also try, [running BigchainDB with Docker](appendices/run-with-docker.html). + -A. Install MongoDB as the database backend. (There are other options but you can ignore them for now.) +## Try BigchainDB -[Install MongoDB Server 3.4+](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/) +Create a BigchainDB transaction and post it to a BigchainDB network in 20 seconds or less: -B. To run MongoDB with default database path i.e. /data/db, open a Terminal and run the following command: -```text -$ sudo mkdir -p /data/db -``` +
+ Try BigchainDB Now +
-C. Assign rwx(read/write/execute) permissions to the user for default database directory: -```text -$ sudo chmod -R 700 /data/db -``` +## Develop an App -D. Run MongoDB (but do not close this terminal): -```text -$ sudo mongod --replSet=bigchain-rs -``` +To develop an app that talks to a BigchainDB network, you'll want a test network to test it against. IPDB is the Interplanetary Database. The IPDB Test Network is a free-to-use, publicly-available BigchainDB network that you can test against. -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: -```text -$ sudo apt-get update -$ sudo apt-get install libffi-dev libssl-dev -``` +
+ Get started with IPDB +
-F. Get the latest version of pip and setuptools: -```text -$ sudo apt-get install python3-pip -$ sudo pip3 install --upgrade pip setuptools -``` +Regardless of which BigchainDB network you use, you'll probably use one of the [BigchainDB drivers or tools](https://www.bigchaindb.com/getstarted/#drivers). -G. Install the `bigchaindb` Python package from PyPI: -```text -$ sudo pip3 install bigchaindb -``` +## Help Develop BigchainDB Server -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: -```text -$ sudo pip3 install [packageName]==[packageVersion] +To help develop BigchainDB Server (the core software in each BigchainDB node), read the [CONTRIBUTING.md file](https://github.com/bigchaindb/bigchaindb/blob/master/CONTRIBUTING.md). It includes instructions for deploying and testing a single BigchainDB node, and multi-node clusters. -OR +## Old Quickstart -$ sudo pip3 install [packageName] --upgrade -``` - -H. Configure BigchainDB Server: -```text -$ bigchaindb -y configure mongodb -``` - -I. Run BigchainDB Server: -```text -$ bigchaindb start -``` - -J. Verify BigchainDB Server setup by visiting the BigchainDB Root URL in your browser: - -[http://127.0.0.1:9984/](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)](https://docs.bigchaindb.com/projects/py-driver/en/latest/quickstart.html) +If you want something like the old Quickstart page, i.e. some command-line instructions to set up and run a BigchainDB node, then go to the [bigchaindb/bigchaindb repository on GitHub](https://github.com/bigchaindb/bigchaindb) and check out the stack.sh file in the pkg/scripts/ directory. Note that it uses functions defined in the functions-common file in that directory.