Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

[refactor docs]: Remove cloud9 deployment guide

Browse Source 
- Remove deprecated guides
- Address comments
This commit is contained in:
muawiakh 2017-10-04 11:21:34 +02:00
parent a9625e0e62
commit f1ba935476
5 changed files with 67 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/server/source/dev-and-test/index.rst
View File

@ -5,7 +5,8 @@ Develop & Test BigchainDB Server
:maxdepth: 1
setup-run-node
running-all-tests
setup-bdb-host
setup-bdb-docker
setup-bdb-cloud9
../appendices/run-with-vagrant
../appendices/run-with-ansible
running-all-tests

5
docs/server/source/dev-and-test/setup-bdb-cloud9.md
View File

@ -1,5 +0,0 @@
## Set up BigchainDB node on Cloud9
Ian Worrall of [Encrypted Labs](http://www.encryptedlabs.com/) wrote a document (PDF) explaining how to set up a BigchainDB (Server) dev machine on Cloud9:
[Download that document from GitHub](https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/docs/server/source/_static/cloud9.pdf)

68
docs/server/source/dev-and-test/setup-bdb-docker.md
View File

@ -1,4 +1,4 @@
## Set up BigchainDB node using Docker
# Set Up BigchainDB Node Using Docker
You need to have recent versions of [Docker](https://docs.docker.com/engine/installation/)
and (Docker) [Compose](https://docs.docker.com/compose/install/).
@ -8,8 +8,38 @@ Build the images:
```bash
docker-compose build
```
## Docker with MongoDB
### Docker with RethinkDB
Start MongoDB:
```bash
docker-compose up -d mdb
```
MongoDB should now be up and running. You can check the port binding for the
MongoDB driver port using:
```bash
$ docker-compose port mdb 27017
```
Start a BigchainDB node:
```bash
docker-compose up -d bdb
```
You can monitor the logs:
```bash
docker-compose logs -f bdb
```
If you wish to run the tests:
```bash
docker-compose run --rm bdb py.test -v --database-backend=mongodb
```
## Docker with RethinkDB
**Note**: If you're upgrading BigchainDB and have previously already built the images, you may need
to rebuild them after the upgrade to install any new dependencies.
@ -44,39 +74,7 @@ If you wish to run the tests:
docker-compose -f docker-compose.rdb.yml run --rm bdb-rdb pytest -v -n auto
```
### Docker with MongoDB
Start MongoDB:
```bash
docker-compose up -d mdb
```
MongoDB should now be up and running. You can check the port binding for the
MongoDB driver port using:
```bash
$ docker-compose port mdb 27017
```
Start a BigchainDB node:
```bash
docker-compose up -d bdb
```
You can monitor the logs:
```bash
docker-compose logs -f bdb
```
If you wish to run the tests:
```bash
docker-compose run --rm bdb py.test -v --database-backend=mongodb
```
### Accessing the HTTP API
## Accessing the HTTP API
You can do quick check to make sure that the BigchainDB server API is operational:

58
docs/server/source/dev-and-test/setup-bdb-host.md
View File

@ -1,34 +1,6 @@
#### Set up BigchainDB node on Local Dev Machine
# Set Up BigchainDB Node on Local Dev Machine
### With RethinkDB
Create a default BigchainDB config file (in `$HOME/.bigchaindb`):
```text
$ bigchaindb -y configure rethinkdb
```
Note: [The BigchainDB CLI](../server-reference/bigchaindb-cli.html) and the [BigchainDB Configuration Settings](../server-reference/configuration.html) are documented elsewhere. (Click the links.)
Start RethinkDB using:
```text
$ rethinkdb
```
You can verify that RethinkDB is running by opening the RethinkDB web interface in your web browser. It should be at http://localhost:8080/
<!-- Don't hyperlink http://localhost:8080/ because Sphinx will fail when you do "make linkcheck" -->
To run BigchainDB Server, do:
```text
$ bigchaindb start
```
You can [run all the unit tests](running-unit-tests.html) to test your installation.
The BigchainDB [CONTRIBUTING.md file](https://github.com/bigchaindb/bigchaindb/blob/master/CONTRIBUTING.md) has more details about how to contribute.
### With MongoDB
## With MongoDB
Create a default BigchainDB config file (in `$HOME/.bigchaindb`):
```text
@ -55,4 +27,30 @@ $ bigchaindb start
You can [run all the unit tests](running-unit-tests.html) to test your installation.
The BigchainDB [CONTRIBUTING.md file](https://github.com/bigchaindb/bigchaindb/blob/master/CONTRIBUTING.md) has more details about how to contribute.
## With RethinkDB
Create a default BigchainDB config file (in `$HOME/.bigchaindb`):
```text
$ bigchaindb -y configure rethinkdb
```
Note: [The BigchainDB CLI](../server-reference/bigchaindb-cli.html) and the [BigchainDB Configuration Settings](../server-reference/configuration.html) are documented elsewhere. (Click the links.)
Start RethinkDB using:
```text
$ rethinkdb
```
You can verify that RethinkDB is running by opening the RethinkDB web interface in your web browser. It should be at http://localhost:8080/
<!-- Don't hyperlink http://localhost:8080/ because Sphinx will fail when you do "make linkcheck" -->
To run BigchainDB Server, do:
```text
$ bigchaindb start
```
You can [run all the unit tests](running-all-tests.html) to test your installation.
The BigchainDB [CONTRIBUTING.md file](https://github.com/bigchaindb/bigchaindb/blob/master/CONTRIBUTING.md) has more details about how to contribute.

5
docs/server/source/dev-and-test/setup-run-node.md
View File

@ -2,7 +2,7 @@
This page explains how to set up a minimal local BigchainDB node for development and testing purposes.
The BigchainDB core dev team develops BigchainDB on recent CentOS Fedora and Ubuntu distributions, so we recommend you use one of those. BigchainDB Server doesn't work on Windows and Mac OS X (unless you use a VM or containers).
The BigchainDB core dev team develops BigchainDB on recent Ubuntu, Fedora and CentOS distributions, so we recommend you use one of those. BigchainDB Server doesn't work on Windows and Mac OS X (unless you use a VM or containers).
Read through the BigchainDB [CONTRIBUTING.md file](https://github.com/bigchaindb/bigchaindb/blob/master/CONTRIBUTING.md). It outlines the steps to setup a machine for developing and testing BigchainDB.
@ -12,4 +12,5 @@ You can set up a stand-alone BigchainDB node using one of the following guides:
- [Using a Local Dev Machine and Docker](setup-bdb-docker.html)
- [Using Vagrant](../appendices/run-with-vagrant.html)
- [Using Ansible](../appendices/run-with-ansible.html)
- [Using a Dev Machine on Cloud9](setup-bdb-cloud9.html)
You can [run all the unit tests](running-all-tests.html) to test your installation.