diff --git a/docs/source/installing-server.md b/docs/source/installing-server.md index 1e6b786b..18c62d1e 100644 --- a/docs/source/installing-server.md +++ b/docs/source/installing-server.md @@ -10,7 +10,6 @@ Windows users may get the best results [running BigchainDB Server in a VM with V (BigchainDB clients should run on a much larger array of operating systems.) -Note: In this section, we sometimes refer to BigchainDB Server as "BigchainDB." ## Install and Run RethinkDB Server @@ -25,9 +24,9 @@ $ rethinkdb If you don't already have it, then you should [install Python 3.4+](https://www.python.org/downloads/) (maybe in a virtual environment, so it doesn't conflict with other Python projects you're working on). -## Install BigchainDB +## Install BigchainDB Server -BigchainDB has some OS-level dependencies. In particular, you need to install the OS-level dependencies for the Python **cryptography** package. Instructions for installing those dependencies on your OS can be found in the [cryptography package documentation](https://cryptography.io/en/latest/installation/). +BigchainDB Server has some OS-level dependencies. In particular, you need to install the OS-level dependencies for the Python **cryptography** package. Instructions for installing those dependencies on your OS can be found in the [cryptography package documentation](https://cryptography.io/en/latest/installation/). On Ubuntu 14.04, we found that the following was enough: ```text @@ -43,11 +42,11 @@ $ sudo dnf install libffi-devel gcc-c++ redhat-rpm-config python3-devel openssl- (If you're using a version of Fedora before version 22, you may have to use `yum` instead of `dnf`.) -With OS-level dependencies installed, you can install BigchainDB with `pip` or from source. +With OS-level dependencies installed, you can install BigchainDB Server with `pip` or from source. ### How to Install BigchainDB with `pip` -BigchainDB is distributed as a Python package on PyPI so you can install it using `pip`. First, make sure you have a version of `pip` installed for Python 3.4+: +BigchainDB (i.e. both the Server and the officially-supported drivers) is distributed as a Python package on PyPI so you can install it using `pip`. First, make sure you have a version of `pip` installed for Python 3.4+: ```text $ pip -V ``` @@ -59,19 +58,19 @@ $ sudo easy_install3 pip ``` (Note: Using `sudo apt-get python3-pip` also installs a Python 3 version of `pip` (named `pip3`) but we found it installed a very old version and there were issues with updating it.) -Once you have a version of `pip` associated with Python 3.4+, then you can install BigchainDB using: +Once you have a version of `pip` associated with Python 3.4+, then you can install BigchainDB Server (and officially-supported BigchainDB drivers) using: ```text sudo pip install bigchaindb ``` (or maybe `sudo pip3 install bigchaindb` or `sudo pip3.4 install bigchaindb`. The `sudo` may not be necessary.) -Note: You can use `pip` to upgrade bigchaindb to the latest version using `sudo pip install --upgrade bigchaindb` +Note: You can use `pip` to upgrade the `bigchaindb` package to the latest version using `sudo pip install --upgrade bigchaindb` ### How to Install BigchainDB from Source -BigchainDB is in its early stages and being actively developed on its [GitHub repository](https://github.com/bigchaindb/bigchaindb). Contributions are highly appreciated. +BigchainDB (i.e. both the Server and the officially-supported drivers) is in its early stages and being actively developed on its [GitHub repository](https://github.com/bigchaindb/bigchaindb). Contributions are highly appreciated. If you want to help with development, then you'll want to install BigchainDB from source. Here's how. -Clone the public repository: +First, clone the public repository: ```text $ git clone git@github.com:bigchaindb/bigchaindb.git ``` @@ -86,9 +85,9 @@ $ python setup.py install One of our community members ([@Mec-Is](https://github.com/Mec-iS)) wrote [a page about how to install BigchainDB on a VM with Vagrant](https://gist.github.com/Mec-iS/b84758397f1b21f21700). -## Run BigchainDB +## Run BigchainDB Server -Once you've installed BigchainDB, you can run it. First make sure you have RethinkDB running: +Once you've installed BigchainDB Server, you can run it. First make sure you have RethinkDB running: ```text $ rethinkdb ``` @@ -98,21 +97,16 @@ Then open a different terminal and run: $ bigchaindb start ``` -During its first run, BigchainDB takes care of configuring a single node environment. +During its first run, BigchainDB Server takes care of configuring a single node environment. ## Run BigchainDB with Docker **NOT for Production Use** -For those who like using Docker and wish to experiment with BigchainDB in -non-production environments, we currently maintain a `dockerfile` that can be -used to build an image for `bigchaindb`, along with a `docker-compose.yml` file -to manage a "standalone node", consisting mainly of two containers: one for -RethinkDB, and another for BigchainDB. +For those who like using Docker and wish to experiment with BigchainDB in non-production environments, we currently maintain a `dockerfile` that can be used to build an image for `bigchaindb`, along with a `docker-compose.yml` file to manage a "standalone node", consisting mainly of two containers: one for RethinkDB, and another for BigchainDB. -Assuming you have `docker` and `docker-compose` installed, you would proceed as -follows. +Assuming you have `docker` and `docker-compose` installed, you would proceed as follows. In a terminal shell: ```text @@ -144,7 +138,4 @@ If you're on Linux, you can probably view the RethinkDB dashboard at: [http://localhost:58080/](http://localhost:58080/) -If that doesn't work, then replace `localhost` -with the IP or hostname of the machine running the Docker engine. -If you are running docker-machine (e.g.: on Mac OS X) this will be the -IP of the Docker machine (`docker-machine ip machine_name`). +If that doesn't work, then replace `localhost` with the IP or hostname of the machine running the Docker engine. If you are running docker-machine (e.g.: on Mac OS X) this will be the IP of the Docker machine (`docker-machine ip machine_name`).