Skip to content
🐳 Docker Compose files for the full Ocean Protocol stack
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Added codeowners Dec 12, 2018
compose-files
networks
.banner add docs to script banner, remove unused images folder Nov 27, 2018
.gitignore Ignore barge log May 6, 2019
LICENSE Initial commit Apr 26, 2018
README.md Update README.md May 21, 2019
Welcome_to_Ocean_Protocol.png Update 'Welcome to Ocean Protocol' screenshot Apr 5, 2019
brizo.env
cors-proxy.conf secret store api cors proxy Nov 16, 2018
kovan_acl_contract_addresses.txt
nile_acl_contract_addresses.txt Updated acl_contract addresses Feb 8, 2019
start_ocean.sh Add option to run a `duero` node. May 9, 2019

README.md

banner

barge

🐳 Docker Compose files for the full Ocean Protocol stack. It's called "barge" because barges carry containers on the water.


πŸ²πŸ¦‘ THERE BE DRAGONS AND SQUIDS. This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue. πŸ¦‘πŸ²


Table of Contents


Prerequisites

You need to have the newest versions of:

  • Linux or macOS. Windows is not currently supported. If you are on Windows, we recommend running Barge inside a Linux VM. Another option might be to use the Windows Subsystem for Linux (WSL).
  • Docker
  • Docker Compose
  • If you want to use Azure Storage with Brizo (and you might not), then you must edit the file brizo.env to have your Azure credentials. To learn how to get those credentials, see our tutorial to Set up Azure Storage.

Get Started

It's overkill, but to be sure that you use exactly the Docker images and volumes you want, you can start by pruning all the Docker things in your system:

docker system prune --all --volumes

(An alternative would be to add the options --purge and --force-pull in your call to the start_ocean.sh script below but that's not as sure as the above command.)

If you're new to Barge, it's best to do something like:

git clone git@github.com:oceanprotocol/barge.git
cd barge

./start_ocean.sh

with no --latest or --stable option. That will run the current default versions of Aquarius, Brizo, Pleuston and Keeper Contracts (listed in the table below). It will also run a local Spree network (i.e. --local-spree-node).

Welcome to Ocean Protocol

Script Options

Options that set the versions (Docker image tags) of Aquarius, Brizo, Keeper Contracts and Pleuston:

Option Aquarius Brizo Keeper Pleuston
--latest latest latest latest latest
--stable stable stable stable stable
(Default) v0.2.2 v0.3.1 v0.9.0 v0.3.0

Note: The latest Docker image tag derives from the develop branch of the component's Git repo and the stable Docker image tag derives from the master branch.

You can override the Docker image tag used for a particular component by setting its associated environment variable (AQUARIUS_VERSION, BRIZO_VERSION, KEEPER_VERSION or PLEUSTON_VERSION) before calling start_ocean.sh. For example:

export BRIZO_VERSION=v0.2.1
./start_ocean.sh

will use the default Docker image tags for Aquarius, Keeper Contracts and Pleuston, but v0.2.1 for Brizo.

Other start_ocean.sh options:

Option Description
--no-pleuston Start up Ocean without the pleuston Building Block. Helpful for development on pleuston.
--no-aquarius Start up Ocean without the aquarius Building Block.
--no-brizo Start up Ocean without the brizo Building Block.
--no-secret-store Start up Ocean without the secret-store Building Block.
--elasticsearch Start up Ocean with ElasticSearch as DB engine for Aquarius instead of MongoDB.
--local-ganache-node Runs a local ganache node.
--local-spree-node Runs a node of the local spree network. This is the default.
--local-duero-node Runs a local parity node and connects the node to the duero network.
--local-nile-node Runs a local parity node and connects the node to the nile network.
--local-kovan-node Runs a light node of the kovan network and connects the node to the kovan network.
--reuse-ganache-database Configures a running ganache node to use a persistent database.
--acl-contract Configures secret-store acl_contract option to enable secret-store authorization.
--force-pull Force pulling the latest revision of the used Docker images.
--purge Removes the Docker containers, volumes, artifact folder and networks used by the script.

Docker Building Blocks

Barge consists of a set of building blocks that can be combined to form a local test environment. By default all building blocks will be started by the start_ocean.sh script.

Pleuston

By default it will start one container. If Pleuston is running, you can open the Pleuston Frontend application in your browser:

http://localhost:3000

This Building Block can be disabled by setting the --no-pleuston flag.

Hostname External Port Internal Url Local Url Description
pleuston 3000 http://pleuston:3000 http://localhost:3000 Pleuston

Aquarius

By default it will start two containers (one for aquarius and one for its database engine). By default Barge will use MongoDB as DB Engine. You can use option --elasticsearch to use ElasticSearch instead. This Building Block can be disabled by setting the --no-aquarius flag.

Hostname External Port Internal Url Local Url Description
aquarius 5000 http://aquarius:5000 http://localhost:5000 Aquarius
mongodb MongoDB used by Aquarius

Brizo

By default it will start one container. This Building Block can be disabled by setting the --no-brizo flag.

Hostname External Port Internal Url Local Url Description
brizo 8030 http://brizo:8030 http://localhost:8030 Brizo

Keeper Node

Controlled by the --local-*-node config switches will start a container keeper-node that uses port 8545 to expose an rpc endpoint to the Ethereum Protocol. You can find a detailed explanation of how to use this in the script options section of this document.

Hostname External Port Internal Url Local Url Description
keeper-node 8545 http://keeper-node:8545 http://localhost:8545 An Ethereum RPC node

This node can be one of the following types (with the default being spree):

Node Description
ganache Runs a local ganache-cli node that is not persistent by default. The contracts from the desired keeper-contracts version will be deployed upon launch of this node.
spree This is the default. Runs a local node of the Spree Network. See Spree Network for details. The contracts from the desired keeper-contracts version will be deployed upon launch of this node.
duero Runs a local node of the Duero Network and connects to the Duero Testnet.
nile Runs a local node of the Nile Network and connects to the Nile Testnet.
kovan Runs a local node of the Kovan Network and connects to the Kovan Testnet.

Secret Store

By default it will start three containers. This Building Block can be disabled by setting the --no-secret-store flag.

Hostname External Ports Internal URL Local URL Description
secret-store 12000, 32771 http://secret-store:12000 http://localhost:12000 An instance of the Ocean Secret Store
secret-store-cors-proxy 12001 http://secret-store-cors-proxy:12001 http://localhost:12001 An NGINX proxy to enable CORS on the secret store
secret-store-signing-node 9545 http://secret-store-signing-node:9545 http://localhost:9545 A Parity Ethereum node to sign messages for the secret store and to decrypt and encrypt

Spree Network

If you run the ./start_ocean.sh script with the --local-spree-node option (please see Keeper Node section of this document for more details), you will have available a keeper node in the local and private Spree Network with the following accounts enabled:

Account Type Password/Key Balance
0x00Bd138aBD70e2F00903268F3Db08f2D25677C9e key node0 1000000000 Ether
0x068Ed00cF0441e4829D9784fCBe7b9e26D4BD8d0 key secret 1000000000 Ether
0xA99D43d86A0758d5632313b8fA3972B6088A21BB key secret 1000000000 Ether
0xe2DD09d719Da89e5a3D0F2549c7E24566e947260 mnemonic info here 1000000000 Ether
0xBE5449a6A97aD46c8558A3356267Ee5D2731ab5e mnemonic info here 1000000000 Ether
0xA78deb2Fa79463945C247991075E2a0e98Ba7A09 mnemonic info here 1000000000 Ether
0x02354A1F160A3fd7ac8b02ee91F04104440B28E7 mnemonic info here 1000000000 Ether
0xe17D2A07EFD5b112F4d675ea2d122ddb145d117B mnemonic info here 1000000000 Ether
0xA32C84D2B44C041F3a56afC07a33f8AC5BF1A071 mnemonic info here 1000000000 Ether
0xFF3fE9eb218EAe9ae1eF9cC6C4db238B770B65CC mnemonic info here 1000000000 Ether
0x529043886F21D9bc1AE0feDb751e34265a246e47 mnemonic info here 1000000000 Ether
0xe08A1dAe983BC701D05E492DB80e0144f8f4b909 mnemonic info here 1000000000 Ether
0xbcE5A3468386C64507D30136685A99cFD5603135 mnemonic info here 1000000000 Ether

Use one of the above accounts to populate PARITY_ADDRESS and PARITY_PASSWORD in brizo.env file to avoid account locked issues from the keeper contracts.

Spree Mnemonic

The accounts from type mnemonic can be access with this seedphrase:

taxi music thumb unique chat sand crew more leg another off lamp

Contributing

See the page titled "Ways to Contribute" in the Ocean Protocol documentation.

License

Copyright 2018 Ocean Protocol Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
You can’t perform that action at this time.