mirror of
https://github.com/oceanprotocol/barge.git
synced 2024-11-22 17:50:13 +01:00
119 lines
4.8 KiB
Markdown
119 lines
4.8 KiB
Markdown
[](https://oceanprotocol.com)
|
|
|
|
<h1 align="center">docker-images</h1>
|
|
|
|
> 🐳 Docker compose and tools running the complete Ocean Protocol network stack.
|
|
> [oceanprotocol.com](https://oceanprotocol.com)
|
|
|
|
---
|
|
|
|
**🐲🦑 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](https://github.com/oceanprotocol/docker-images/issues). 🦑🐲**
|
|
|
|
---
|
|
|
|
## Table of Contents
|
|
|
|
* [Prerequisites](#prerequisites)
|
|
* [Get Started](#get-started)
|
|
* [Ocean Protocol components](#ocean-protocol-components)
|
|
- [Versions](#versions)
|
|
* [Contributing](#contributing)
|
|
* [License](#license)
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
You need to have the newest versions available of both:
|
|
|
|
* [Docker](https://www.docker.com/get-started)
|
|
* [Docker Compose](https://docs.docker.com/compose/)
|
|
|
|
## Get Started
|
|
|
|
Then bring up an instance of the whole Ocean Protocol network stack with:
|
|
|
|
```bash
|
|
git clone git@github.com:oceanprotocol/docker-images.git
|
|
cd docker-images/
|
|
|
|
./start_ocean.sh
|
|
|
|
```
|
|
|
|
Or
|
|
|
|
```bash
|
|
git clone git@github.com:oceanprotocol/docker-images.git
|
|
cd docker-images/
|
|
|
|
docker-compose --project-name=ocean up
|
|
```
|
|
|
|
After getting everything running, you can open the **Pleuston Frontend** application in your browser:
|
|
|
|
```
|
|
http://localhost:3000
|
|
```
|
|
|
|
## Ocean Protocol components
|
|
|
|
The Ocean Docker compose starts the following components:
|
|
|
|
* [🦄 pleuston](https://github.com/oceanprotocol/pleuston). Frontend listening on port `3000`.
|
|
* [🐋 provider](https://github.com/oceanprotocol/provider). Backend listening on port `5000`.
|
|
* [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts). RPC client listening on port `8545`.
|
|
|
|
|
|
|
|
### 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"
|
|
* 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
|
|
* `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
|
|
|
|
We use GitHub as a means for maintaining and tracking issues and source code development.
|
|
|
|
If you would like to contribute, please fork this repository, do work in a feature branch, and finally open a pull request for maintainers to review your changes.
|
|
|
|
Ocean Protocol uses [C4 Standard process](https://github.com/unprotocols/rfc/blob/master/1/README.md) to manage changes in the source code. Find here more details about [Ocean C4 OEP](https://github.com/oceanprotocol/OEPs/tree/master/1).
|
|
|
|
## 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.
|
|
```
|