diff --git a/README.md b/README.md index 534a06e..66080a0 100644 --- a/README.md +++ b/README.md @@ -63,16 +63,24 @@ That will run the current default versions of Aquarius, Brizo, Pleuston and Keep Options that set the versions (Docker image tags) of Aquarius, Brizo, Keeper Contracts and Pleuston: -| Option | Aquarius | Brizo | Keeper | Pleuston | -| ---------- | -------- | --------- | -------- | -------- | -| (Default) | `v0.2.9` | `v0.3.10` | `v0.9.7` | `v0.4.0` | -| `--latest` | `latest` | `latest` | `latest` | `latest` | +| 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` | Default is always a combination of component versions which are considered stable. 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 (`AQUARIUS_VERSION`, `BRIZO_VERSION`, `KEEPER_VERSION` or `PLEUSTON_VERSION`) before calling `start_ocean.sh`. For example: +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` +- `KEEPER_VERSION` +- `PLEUSTON_VERSION` +- `FAUCET_VERSION` + +For example: ```bash export BRIZO_VERSION=v0.2.1 @@ -91,6 +99,7 @@ Other `start_ocean.sh` options: | `--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-ganache-node` | Runs a local `ganache` node. | @@ -168,6 +177,14 @@ By default it will start three containers. This Building Block can be disabled b | `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](https://github.com/oceanprotocol/faucet) | + ## Spree Network If you run the `./start_ocean.sh` script with the `--local-spree-node` option (please see [Keeper Node](#keeper-node) section of this document for more details), diff --git a/compose-files/faucet.yml b/compose-files/faucet.yml new file mode 100644 index 0000000..4a2d5c1 --- /dev/null +++ b/compose-files/faucet.yml @@ -0,0 +1,22 @@ +version: '3' +services: + mongodb: + image: mongo:4 + ports: + - 27017:27017 + networks: + backend: + ipv4_address: 172.15.0.20 + + faucet: + image: oceanprotocol/faucet:$FAUCET_VERSION + ports: + - 3001:3001 + networks: + backend: + ipv4_address: 172.15.0.21 + depends_on: + - mongodb + environment: + NODE_ENV: 'production' + MONGO_URL: 'mongodb://mongodb:27017/faucetdbtest' diff --git a/start_ocean.sh b/start_ocean.sh index 5ec6781..46182ab 100755 --- a/start_ocean.sh +++ b/start_ocean.sh @@ -14,9 +14,10 @@ COMPOSE_DIR="${DIR}/compose-files" # Default versions of Aquarius, Brizo, Keeper Contracts and Pleuston export AQUARIUS_VERSION=${AQUARIUS_VERSION:-v0.3.4} -export BRIZO_VERSION=${BRIZO_VERSION:-v0.3.13} +export BRIZO_VERSION=${BRIZO_VERSION:-v0.3.14} export KEEPER_VERSION=${KEEPER_VERSION:-v0.10.3} export PLEUSTON_VERSION=${PLEUSTON_VERSION:-v0.4.2} +export FAUCET_VERSION=${FAUCET_VERSION:-v0.2.4} export PARITY_IMAGE='parity/parity:v2.3.3' @@ -142,6 +143,7 @@ COMPOSE_FILES+=" -f ${COMPOSE_DIR}/pleuston.yml" COMPOSE_FILES+=" -f ${COMPOSE_DIR}/aquarius_elasticsearch.yml" COMPOSE_FILES+=" -f ${COMPOSE_DIR}/brizo.yml" COMPOSE_FILES+=" -f ${COMPOSE_DIR}/secret_store.yml" +COMPOSE_FILES+=" -f ${COMPOSE_DIR}/faucet.yml" DOCKER_COMPOSE_EXTRA_OPTS="${DOCKER_COMPOSE_EXTRA_OPTS:-}" @@ -163,6 +165,7 @@ while :; do export BRIZO_VERSION="latest" export KEEPER_VERSION="latest" export PLEUSTON_VERSION="latest" + export FAUCET_VERSION="latest" printf $COLOR_Y'Switched to latest components...\n\n'$COLOR_RESET ;; --force-pull) @@ -188,6 +191,10 @@ while :; do COMPOSE_FILES="${COMPOSE_FILES/ -f ${COMPOSE_DIR}\/secret_store.yml/}" printf $COLOR_Y'Starting without Secret Store...\n\n'$COLOR_RESET ;; + --no-faucet) + COMPOSE_FILES="${COMPOSE_FILES/ -f ${COMPOSE_DIR}\/faucet.yml/}" + printf $COLOR_Y'Starting without Faucet...\n\n'$COLOR_RESET + ;; ################################################# # Only Secret Store @@ -304,6 +311,7 @@ while :; do docker network rm ${PROJECT_NAME}_secretstore || true docker volume rm ${PROJECT_NAME}_keeper-node || true docker volume rm ${PROJECT_NAME}_secret-store || true + docker volume rm ${PROJECT_NAME}_faucet || true read -p "Are you sure you want to delete $KEEPER_ARTIFACTS_FOLDER? " -n 1 -r echo if [[ $REPLY =~ ^[Yy]$ ]]