diff --git a/README.md b/README.md index 3ea3494..d9d6a36 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ - [Keeper Node](#keeper-node) - [Secret Store](#secret-store) - [Faucet](#faucet) + - [Dashboard](#dashboard) - [Spree Network](#spree-network) - [Spree Mnemonic](#spree-mnemonic) - [Contributing](#contributing) @@ -102,6 +103,7 @@ will use the default Docker image tags for Aquarius, Keeper Contracts and Common | `--no-events-handler` | Start up Ocean without the `events-handler` Building Block. | | `--no-secret-store` | Start up Ocean without the `secret-store` Building Block. | | `--no-faucet` | Start up Ocean without the `faucet` Building Block. | +| `--no-dashboard` | Start up Ocean without the `dashboard` 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. | @@ -197,6 +199,17 @@ By default it will start two containers, one for Faucet server and one for its d By default the Faucet allows requests every 24hrs. To disable the timespan check you can pass `FAUCET_TIMESPAN=0` as environment variable before starting the script. +### Dashboard + +This will start a `portainer` dashboard with the following admin credentials and connects to the local docker host. This Building Block can be disabled by setting the `--no-dashboard` flag. + +- User: `admin` +- Password: `oceanprotocol` + +| Hostname | External Port | Internal URL | Local URL | Description | +| ----------- | ------------- | --------------------- | --------------------- | --------------------------------------------------- | +| `dashboard` | `9000` | http://dashboard:9000 | http://localhost:9000 | [Portainer](https://github.com/portainer/portainer) | + ## 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/dashboard.yml b/compose-files/dashboard.yml new file mode 100644 index 0000000..fd36dad --- /dev/null +++ b/compose-files/dashboard.yml @@ -0,0 +1,15 @@ +version: '3' +services: + dashboard: + image: portainer/portainer + command: + --admin-password '$$2y$$05$$wk5y6Xr1Y5TQkhUcH1.HNunnCoV6Z//735W7o8l31LxMqVCpg6b6G' + --host 'unix:///var/run/docker.sock' + --logo 'https://raw.githubusercontent.com/oceanprotocol/art/master/logo/logo.png' + networks: + backend: + ipv4_address: 172.15.0.25 + volumes: + - /var/run/docker.sock:/var/run/docker.sock + ports: + - 9000:9000 \ No newline at end of file diff --git a/start_ocean.sh b/start_ocean.sh index 29a6854..b8c56e9 100755 --- a/start_ocean.sh +++ b/start_ocean.sh @@ -189,6 +189,7 @@ check_if_owned_by_root show_banner COMPOSE_FILES="" +COMPOSE_FILES+=" -f ${COMPOSE_DIR}/dashboard.yml" COMPOSE_FILES+=" -f ${COMPOSE_DIR}/keeper_contracts.yml" COMPOSE_FILES+=" -f ${COMPOSE_DIR}/network_volumes.yml" COMPOSE_FILES+=" -f ${COMPOSE_DIR}/commons.yml" @@ -238,11 +239,10 @@ while :; do ################################################# # Exclude switches ################################################# - --no-commons) - COMPOSE_FILES="${COMPOSE_FILES/ -f ${COMPOSE_DIR}\/commons.yml/}" + --no-commons) + COMPOSE_FILES="${COMPOSE_FILES/ -f ${COMPOSE_DIR}\/commons.yml/}" printf $COLOR_Y'Starting without Commons...\n\n'$COLOR_RESET ;; - --no-events-handler) COMPOSE_FILES="${COMPOSE_FILES/ -f ${COMPOSE_DIR}\/events_handler.yml/}" printf $COLOR_Y'Starting without Events Handler...\n\n'$COLOR_RESET @@ -263,6 +263,10 @@ while :; do COMPOSE_FILES="${COMPOSE_FILES/ -f ${COMPOSE_DIR}\/faucet.yml/}" printf $COLOR_Y'Starting without Faucet...\n\n'$COLOR_RESET ;; + --no-dashboard) + COMPOSE_FILES="${COMPOSE_FILES/ -f ${COMPOSE_DIR}\/dashboard.yml/}" + printf $COLOR_Y'Starting without Dashboard ...\n\n'$COLOR_RESET + ;; ################################################# # Only Secret Store