From 87c99e090ca2afb1756b83b8cf5ddd2483787913 Mon Sep 17 00:00:00 2001 From: Andrew Gross Date: Mon, 28 Oct 2019 22:12:02 -0600 Subject: [PATCH] link docker instructions to doc website --- docker/README.md | 78 ++---------------------------------------------- 1 file changed, 3 insertions(+), 75 deletions(-) diff --git a/docker/README.md b/docker/README.md index ba3458883d..03df272c4a 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,77 +1,5 @@ -# BlockScout Docker integration +# BlockScout Docker Integration -For now this integration is not production ready. It made only for local usage only ! - -## How to use ? -First of all, blockscout requires `PostgreSQL` server for working. -It will be provided by starting script (new docker image will be created named `postgres`) - -**Starting command** -`make start` - will set everything up and start blockscout in container. -To connect it to your local environment you will have to configure it using [env variables](#env-variables) - -Example connecting to local `ganache` instance running on port `2000` on Mac/Windows: -```bash -COIN=DAI \ -ETHEREUM_JSONRPC_VARIANT=ganache \ -ETHEREUM_JSONRPC_HTTP_URL=http://host.docker.internal:2000 \ -ETHEREUM_JSONRPC_WS_URL=ws://host.docker.internal:2000 \ -make start -``` - -Blockscout will be available on `localhost:4000` - -**Note** -On mac/Windows Docker provides with a special URL `host.docker.internal` that will be available into container and routed to your local machine. -On Linux docker is starting using `--network=host` and all services should be available on `localhost` - -### Migrations - -By default, `Makefile` will do migrations for you on `PostgreSQL` creation. -But you could run migrations manually using `make migrate` command. - -**WARNING** Migrations will clean up your local database ! - -## Env variables - -BlockScout supports 3 different JSON RPC Variants. -Variant could be configured using `ETHEREUM_JSONRPC_VARIANT` environment variable. - -Example: -```bash -ETHEREUM_JSONRPC_VARIANT=ganache make start -``` - -Available options are: - - * `parity` - Parity JSON RPC (**Default one**) - * `geth` - Geth JSON RPC - * `ganache` - Ganache JSON RPC - - -| Variable | Description | Default value | -| -------- | ----------- | ------------- | -| `ETHEREUM_JSONRPC_VARIANT` | Variant of your JSON RPC service: `parity`, `geth` or `ganache` | `parity` | -| `ETHEREUM_JSONRPC_HTTP_URL` | HTTP JSON RPC URL Only for `geth` or `ganache` variant | Different per JSONRPC variant | -| `ETHEREUM_JSONRPC_WS_URL` | WS JSON RPC url | Different per JSONRPC variant | -| `ETHEREUM_JSONRPC_TRACE_URL` | Trace URL **Only for `parity` variant** | `http://localhost:8545` | -| `COIN` | Default Coin | `POA` | -| `LOGO` | Coin logo | Empty | -| `NETWORK` | Network | Empty | -| `SUBNETWORK` | Subnetwork | Empty | -| `NETWORK_ICON` | Network icon | Empty | -| `NETWORK_PATH` | Network path | `/` | - - -`ETHEREUM_JSONRPC_HTTP_URL` default values: - - * For `parity` - `http://localhost:8545` - * For `geth` - `https://mainnet.infura.io/8lTvJTKmHPCHazkneJsY` - * For `ganache` - `http://localhost:7545` - -`ETHEREUM_JSONRPC_WS_URL` default values: - - * For `parity` - `ws://localhost:8546` - * For `geth` - `wss://mainnet.infura.io/8lTvJTKmHPCHazkneJsY/ws` - * For `ganache` - `ws://localhost:7545` +This integration is not production ready, and should be used for local BlockScout deployment only. +For usage instructions and ENV variables, see the [docker integration documentation](https://docs.blockscout.com/for-developers/information-and-settings/docker-integration-local-use-only). \ No newline at end of file