mirror of
https://github.com/oceanprotocol/barge.git
synced 2024-12-02 05:57:21 +01:00
readme updates
This commit is contained in:
parent
1a5f9129f5
commit
c307739c9b
GPG Key ID:
606EEEF3C479A91F
74
README.md
74
README.md
@ -2,28 +2,26 @@
|
||||
|
||||
<h1 align="center">barge</h1>
|
||||
|
||||
🐳 Docker Compose files for the full Ocean Protocol stack. It's called "barge" because barges carry containers on the water.
|
||||
> 🐳 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](https://github.com/oceanprotocol/docker-images/issues). 🦑🐲**
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Get Started](#get-started)
|
||||
- [Script Options](#script-options)
|
||||
- [Docker Building Blocks](#docker-building-blocks)
|
||||
- [Pleuston](#pleuston)
|
||||
- [Aquarius](#aquarius)
|
||||
- [Brizo](#brizo)
|
||||
- [Keeper Node](#keeper-node)
|
||||
- [Secret Store](#secret-store)
|
||||
- [Spree Network](#spree-network)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Prerequisites](#Prerequisites)
|
||||
- [Get Started](#Get-Started)
|
||||
- [Options](#Options)
|
||||
- [Component Versions](#Component-Versions)
|
||||
- [All Options](#All-Options)
|
||||
- [Docker Building Blocks](#Docker-Building-Blocks)
|
||||
- [Pleuston](#Pleuston)
|
||||
- [Aquarius](#Aquarius)
|
||||
- [Brizo](#Brizo)
|
||||
- [Keeper Node](#Keeper-Node)
|
||||
- [Secret Store](#Secret-Store)
|
||||
- [Faucet](#Faucet)
|
||||
- [Spree Network](#Spree-Network)
|
||||
- [Spree Mnemonic](#Spree-Mnemonic)
|
||||
- [Contributing](#Contributing)
|
||||
- [License](#License)
|
||||
|
||||
---
|
||||
|
||||
@ -38,14 +36,6 @@ You need to have the newest versions of:
|
||||
|
||||
## Get Started
|
||||
|
||||
It's overkill, but to be _sure_ that you use exactly the Docker images and volumes you want, you can start by pruning all the Docker things in your system:
|
||||
|
||||
```bash
|
||||
docker system prune --all --volumes
|
||||
```
|
||||
|
||||
(An alternative would be to add the options `--purge` and `--force-pull` in your call to the `start_ocean.sh` script below but that's not as sure as the above command.)
|
||||
|
||||
If you're new to Barge, it's best to do something like:
|
||||
|
||||
```bash
|
||||
@ -55,22 +45,29 @@ cd barge
|
||||
./start_ocean.sh
|
||||
```
|
||||
|
||||
That will run the current default versions of Aquarius, Brizo, Pleuston and Keeper Contracts (listed in the table below). It will also run a local Spree network (i.e. `--local-spree-node`).
|
||||
That will run the current default versions of Aquarius, Brizo, Pleuston, Keeper Contracts, and Faucet. It will also run a local Spree network (i.e. `--local-spree-node`).
|
||||
|
||||
<img width="486" alt="Welcome to Ocean Protocol" src="Welcome_to_Ocean_Protocol.png">
|
||||
|
||||
## Script Options
|
||||
It's overkill, but to be _sure_ that you use exactly the Docker images and volumes you want, you can start by pruning all the Docker things in your system:
|
||||
|
||||
Options that set the versions (Docker image tags) of Aquarius, Brizo, Keeper Contracts and Pleuston:
|
||||
```bash
|
||||
docker system prune --all --volumes
|
||||
```
|
||||
|
||||
| Option | Aquarius | Brizo | Keeper | Pleuston | Faucet |
|
||||
| ---------- | -------- | --------- | -------- | -------- | -------- |
|
||||
| (Default) | `v0.3.4` | `v0.3.14` | `v0.10.3` | `v0.4.2` | `v0.2.4` |
|
||||
| `--latest` | `latest` | `latest` | `latest` | `latest` | `latest` |
|
||||
## Options
|
||||
|
||||
Default is always a combination of component versions which are considered stable.
|
||||
The startup script comes with a set of options for customizing variou things.
|
||||
|
||||
The `latest` Docker image tag derives from the `develop` branch of the component's Git repo.
|
||||
### Component Versions
|
||||
|
||||
The default versions are always a combination of component versions which are considered stable.
|
||||
|
||||
| Aquarius | Brizo | Keeper | Pleuston | Faucet |
|
||||
| -------- | --------- | -------- | -------- | -------- |
|
||||
| `v0.3.4` | `v0.3.14` | `v0.10.3` | `v0.4.2` | `v0.2.4` |
|
||||
|
||||
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 `develop` 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`:
|
||||
|
||||
@ -91,17 +88,18 @@ will use the default Docker image tags for Aquarius, Keeper Contracts and Pleust
|
||||
|
||||
Note: If you use the `--latest` option, then the `latest` Docker images will be used _regardless of whether you set any environment variables beforehand._
|
||||
|
||||
Other `start_ocean.sh` options:
|
||||
### All Options
|
||||
|
||||
| Option | Description |
|
||||
| -------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `--latest` | Pull Docker images tagged with `latest`. |
|
||||
| `--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. |
|
||||
| `--no-faucet` | Start up Ocean without the `faucet` Building Block. |
|
||||
| `--mongodb` | Start up Ocean with MongoDB as DB engine for Aquarius instead of Elasticsearch. |
|
||||
| `--local-pacific-node | Runs a local parity node and connects the node to the `pacific` network (official Ocean network |
|
||||
| `--local-pacific-node` | Runs a local parity node and connects the node to the `pacific` network (official Ocean network |
|
||||
| `--local-ganache-node` | Runs a local `ganache` node. |
|
||||
| `--local-spree-node` | Runs a node of the local `spree` network. This is the default. |
|
||||
| `--local-duero-node` | Runs a local parity node and connects the node to the `duero` network. |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user