
* Reorganized docs * Fixed internal links in basic usage * fixed the docker-compose command and volume for docs * fixed docs tests * fix travis docs test * tox ini file * fixed readme localhost links * edited tox and test docs to previous state * Fix tests errors related to docs reorganization Signed-off-by: David Dashyan <mail@davie.li> * Added ansible script installation option Signed-off-by: Lana Ivina <lana@ipdb.io> * Added ansible script to network setup guide Signed-off-by: Lana Ivina <lana@ipdb.io> * Hid the non-working button for now. Signed-off: Lana Ivina <lana@ipdb.io> * Try now button Co-authored-by: David Dashyan <mail@davie.li>
3.2 KiB
Run BigchainDB with all-in-one Docker
For those who like using Docker and wish to experiment with BigchainDB in
non-production environments, we currently maintain a BigchainDB all-in-one
Docker image and a
Dockerfile-all-in-one
that can be used to build an image for bigchaindb
.
This image contains all the services required for a BigchainDB node i.e.
- BigchainDB Server
- MongoDB
- Tendermint
Note: NOT for Production Use: This is an single node opinionated image not well suited for a network deployment. This image is to help quick deployment for early adopters, for a more standard approach please refer to one of our deployment guides:
Prerequisite(s)
Pull and Run the Image from Docker Hub
With Docker installed, you can proceed as follows.
In a terminal shell, pull the latest version of the BigchainDB all-in-one Docker image using:
$ docker pull bigchaindb/bigchaindb:all-in-one
$ docker run \
--detach \
--name bigchaindb \
--publish 9984:9984 \
--publish 9985:9985 \
--publish 27017:27017 \
--publish 26657:26657 \
--volume $HOME/bigchaindb_docker/mongodb/data/db:/data/db \
--volume $HOME/bigchaindb_docker/mongodb/data/configdb:/data/configdb \
--volume $HOME/bigchaindb_docker/tendermint:/tendermint \
bigchaindb/bigchaindb:all-in-one
Let's analyze that command:
docker run
tells Docker to run some image--detach
run the container in the backgroundpublish 9984:9984
map the host port9984
to the container port9984
(the BigchainDB API server)9985
BigchainDB Websocket server27017
Default port for MongoDB26657
Tendermint RPC server
--volume "$HOME/bigchaindb_docker/mongodb:/data"
map the host directory$HOME/bigchaindb_docker/mongodb
to the container directory/data
; this allows us to have the data persisted on the host machine, you can read more in the official Docker documentation$HOME/bigchaindb_docker/tendermint:/tendermint
to persist Tendermint data.
bigchaindb/bigchaindb:all-in-one
the image to use. All the options after the container name are passed on to the entrypoint inside the container.
Verify
$ docker ps | grep bigchaindb
Send your first transaction using BigchainDB drivers.
Building Your Own Image
Assuming you have Docker installed, you would proceed as follows.
In a terminal shell:
git clone git@github.com:bigchaindb/bigchaindb.git
cd bigchaindb/
Build the Docker image:
docker build --file Dockerfile-all-in-one --tag <tag/name:latest> .
Now you can use your own image to run BigchainDB all-in-one container.