diff --git a/README.md b/README.md index 73a8956..b165b24 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ * [Prerequisites](#prerequisites) * [Get Started](#get-started) * [Ocean Protocol components](#ocean-protocol-components) - - [Versions](#versions) * [Contributing](#contributing) * [License](#license) @@ -38,16 +37,14 @@ git clone git@github.com:oceanprotocol/docker-images.git cd docker-images/ ./start_ocean.sh - ``` -Or +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`: ```bash -git clone git@github.com:oceanprotocol/docker-images.git -cd docker-images/ - -docker-compose --project-name=ocean up +./start_ocean.sh --latest ``` After getting everything running, you can open the **Pleuston Frontend** application in your browser: @@ -66,29 +63,20 @@ The Ocean Docker compose starts the following components: ![Ocean Protocol Components](doc/img/ocean-components@2x.png) -### Versions - -The version of the Ocean components can be configured setting the environment variable `OCEAN_VERSION`. By default `master` branch runs the latest stable version release, and `develop` branch runs the code generated in the `master` branch of the Ocean components. If you want to run the component's code of `develop` branch: - -```bash -export OCEAN_VERSION=latest -docker-compose --project-name=ocean up -``` - ### Options The keeper-contracts component runs with ganache by default and every run will produce and deploy new instances of the keeper contracts. Ganache can be run with a specific database path by setting the env var `REUSE_DATABASE` to "true". By default, the ganache database will be setup in the cwd. The following env vars enable some customization: + * DEPLOY_CONTRACTS: skip deploying smart contracts by setting this to "false", in this case `REUSE_DATABASE` should be set to True in the previous run when using ganache -* KEEPER_NETWORK_NAME: set to one of "ganache" (default), "kovan", or "ocean_poa_net_local" +* KEEPER_NETWORK_NAME: set to one of "ganache" (default), "kovan", or "ocean_poa_net_local" * ARTIFACTS_FOLDER: this is where the deployed smart contracts abi files will be available. This can be pointed at any path you like. When running a separate pleuston instance, it may be necessary to copy the abi files from this artifacts folder to the @oceanprotocol/keeper-contracts/artifacts folder in pleuston -A subset of the components can be run by modifying the docker-compose file directly or by using one -of the other pre-built compose files: -* `docker-compose-no-pleuston.yml` runs all components without the pleuston. This is useful for developing/debugging -the front-end app. So first the docker compose container can be started then pleuston can be started separately from source. You can also use `./start_ocean.sh --no-pleuston` to do this +A subset of the components can be run by modifying the docker-compose file directly or by using one of the other pre-built compose files: + +* `docker-compose-no-pleuston.yml` runs all components without the pleuston. This is useful for developing/debugging the front-end app. So first the docker compose container can be started then pleuston can be started separately from source. You can also use `./start_ocean.sh --no-pleuston` to do this * `docker-compose-local-parity-node.yml` is similar to the above with no pleuston, but runs a local parity POA node instead of ganache-cli. You can also use `./start_ocean.sh --local-parity-node` instead ## Contributing