1
0
mirror of https://github.com/oceanprotocol/barge.git synced 2024-10-31 23:55:18 +01:00
🐳 Docker Compose files for the full Ocean Protocol stack
Go to file
Troy McConaghy 80d0bf93b0
not specifying network == --local-spree-node (#136)
* not specifying network == --local-spree-node

* Clean local artifacts when deploying contracts

* In clean_local_contracts, rm *.development.json
2019-04-03 09:26:06 +02:00
.github Added codeowners 2018-12-12 17:23:16 +01:00
compose-files Fix bug starting barge without parity 2019-04-01 14:58:50 +02:00
networks Resets secret store config on startup 2019-03-28 17:07:20 -05:00
.banner add docs to script banner, remove unused images folder 2018-11-27 12:27:01 +01:00
.gitignore Resets secret store config on startup 2019-03-28 17:07:20 -05:00
brizo.env Fix bug starting barge without parity 2019-04-01 14:58:50 +02:00
cors-proxy.conf secret store api cors proxy 2018-11-16 16:37:58 +01:00
kovan_acl_contract_addresses.txt Updated acl_contract addresses 2019-02-08 16:14:36 +01:00
LICENSE Initial commit 2018-04-26 16:40:15 +01:00
nile_acl_contract_addresses.txt Updated acl_contract addresses 2019-02-08 16:14:36 +01:00
README.md Change default network from nile to spree 2019-03-26 09:27:49 +01:00
start_ocean.sh not specifying network == --local-spree-node (#136) 2019-04-03 09:26:06 +02:00

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 (including a local Spree network) 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.
--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-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 (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 intead. 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.
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.