🐳 Docker Compose files for the full Ocean Protocol stack
Clone or download
aaitor Merge pull request #106 from oceanprotocol/fix/files_owner
Pass UID and GID to keeper-contracts
Latest commit caa1190 Jan 23, 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:

To run as a publisher: Brizo configuration must be set with valid Azure account credentials. This is done in the file brizo.env. Follow our tutorial Set up Azure Storage to learn how to get those credentials.

Get Started

Bring up an instance of the whole Ocean Protocol network stack with the ./start_ocean.sh script:

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

./start_ocean.sh

screen shot 2018-10-10 at 12 20 48


This will bring up the stable versions of all components, referring to their respective master branches.

To get the latest versions of all components, referring to their develop branches, pass the argument --latest:

./start_ocean.sh --latest

After getting everything running, you can open the Pleuston Frontend application in your browser:

http://localhost:3000

Script Options

The ./start_ocean.sh script provides the following options:

Option Description
--latest latest means to use the latest develop branches whereas stable means to use the last stable releases.
--force-pull Force pulling the latest revision of the used docker images.
--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.
--local-ganache-node Runs a local ganache node.
--local-spree-node Runs a node of the local spree network.
--local-nile-node Runs a node of the nile network 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.
--purge Removes the containers, volumes, artifact folder and networks used by the script.

Docker Building Blocks

Ocean compose 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 with the ./start_ocean.sh script.

Pleuston

By default it will start one container. 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. 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:

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 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.
nile Runs an instance of the nile network and connects to the Nile testnet. See Nile Network for details.
kovan Runs an instance of the kovan network and connects to the Kovan testnet.

Secret Store

By default it will start three container. 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 A 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 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 Password Balance
0x00bd138abd70e2f00903268f3db08f2d25677c9e node0 10000000111000111000111000
0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0 secret 100000000
0xa99d43d86a0758d5632313b8fa3972b6088a21bb secret 100000000

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.

Nile Network

Please see Nile Testnet for details.

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.