barge

🐳 Docker Compose files for the full Ocean Protocol stack.

---

• Prerequisites
• Get Started
• Options
  • Component Versions
  • All Options
• Docker Building Blocks
  • Commons
  • Aquarius
  • Brizo
  • Events Handler
  • Keeper Node
  • Secret Store
  • Faucet
  • Agent
  • Dashboard
• Spree Network
  • Spree Mnemonic
• Contributing
• License

---

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

If you're new to Barge, it's best to start with the defaults:

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

./start_ocean.sh

That will run the current default versions of Aquarius, Brizo, Events Handler, Commons, Keeper Contracts, and Faucet. It will also run a local Spree network (i.e. --local-spree-node).

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

docker system prune --all --volumes

Options

The startup script comes with a set of options for customizing various things.

Component Versions

The default versions are always a combination of component versions which are considered stable.

Aquarius	Brizo	Events Handler	Keeper	Commons	Faucet	Agent
v1.0.5	v0.8.1	v0.4.4	v0.13.2	v2.1.0	v0.3.2	latest

You can use the --latest option to pull the most recent Docker images for all components, which are always tagged as latest in Docker. The latest Docker image tag derives from the default main branch of the component's Git repo.

You can override the Docker image tag used for a particular component by setting its associated environment variable before calling start_ocean.sh:

• AQUARIUS_VERSION
• BRIZO_VERSION
• EVENTS_HANDLER_VERSION
• KEEPER_VERSION
• COMMONS_CLIENT_VERSION
• COMMONS_SERVER_VERSION
• FAUCET_VERSION
• AGENT_VERSION

For example:

export BRIZO_VERSION=v0.8.1
./start_ocean.sh

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

If you use the --latest option, then the latest Docker images will be used regardless of whether you set any environment variables beforehand.

All Options

Option	Description
--latest	Pull Docker images tagged with latest.
--no-commons	Start up Ocean without the commons Building Block. Helpful for development on commons.
--no-aquarius	Start up Ocean without the aquarius Building Block.
--no-brizo	Start up Ocean without the brizo Building Block.
--no-events-handler	Start up Ocean without the events-handler Building Block.
--no-secret-store	Start up Ocean without the secret-store Building Block.
--no-faucet	Start up Ocean without the faucet Building Block.
--no-acl-contract	Disables the configuration of secret store's ACL contract address
--no-dashboard	Start up Ocean without the dashboard Building Block.
--no-agent	Start up Ocean without the agent Building Block.
--mongodb	Start up Ocean with MongoDB as DB engine for Aquarius instead of Elasticsearch.
--local-ganache-node	Runs a local ganache node.
--local-spree-node	Runs a node of the local spree network. This is the default.
--local-spree-no-deploy	Runs a node of the local spree network, without contract deployment.
--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-pacific-node	Runs a local parity node and connects the node to the pacific network (official Ocean network
--reuse-ganache-database	Configures a running ganache node to use a persistent database.
--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.
--exposeip	Binds the components to that specific ip. Exemple: ./start_ocean.sh --exposeip 192.168.0.1

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.

Commons

By default it will start two containers (client & server). If Commons is running, you can open the Commons Frontend application in your browser:

http://localhost:3000

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

Hostname	External Port	Internal URL	Local URL	Description
commons-client	3000	http://commons-client:3000	http://localhost:3000	Commons Client
commons-server	4000	http://commons-server:4000	http://locahost:4000	Commons Server

Aquarius

By default it will start two containers (one for Aquarius and one for its database engine). By default, Barge will use Elasticsearch for its database engine. You can use the --mongodb option to use MongoDB 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
elasticsearch				The Elasticsearch used by Aquarius
mongodb				The 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

Events Handler

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

Hostname	External Port	Internal URL	Local URL	Description
events-handler				Events-handler

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.
pacific	Runs a local node of the Pacific Network and connects to the Pacific network.

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

Faucet

By default it will start two containers, one for Faucet server and one for its database (MongoDB). This Building Block can be disabled by setting the --no-faucet flag.

Hostname	External Port	Internal URL	Local URL	Description
faucet	3001	http://faucet:3001	http://localhost:3001	Faucet

By default the Faucet allows requests every 24hrs. To disable the timespan check you can pass FAUCET_TIMESPAN=0 as environment variable before starting the script.

Agent

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

Hostname	External Port	Internal URL	Local URL	Description
agent	4040	http://agent:4040	http://agent:4040	Agent

Dashboard

This will start a portainer dashboard with the following admin credentials and connects to the local docker host. This Building Block can be disabled by setting the --no-dashboard flag.

• User: admin
• Password: oceanprotocol

Hostname	External Port	Internal URL	Local URL	Description
dashboard	9000	http://dashboard:9000	http://localhost:9000	Portainer

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 PROVIDER_ADDRESS, PROVIDER_PASSWORD and PROVIDER_KEYFILE in start_ocean.sh. This account will is used in brizo and events-handler as the provider account which is important for processing the service agreements flow. The PROVIDER_KEYFILE must be placed in the accounts folder and must match the ethereum address from PROVIDER_ADDRESS. The PROVIDER_ADDRESS is also set in commons instance so that published assets get assigned the correct provider address.

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 2019 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.