From 3b66962db694576b1442babe1be6c756ecb188d8 Mon Sep 17 00:00:00 2001 From: Konstantin Zolotarev Date: Sat, 27 Oct 2018 16:14:42 +0300 Subject: [PATCH] Added README.md template --- docker/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docker/README.md diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000000..949a926390 --- /dev/null +++ b/docker/README.md @@ -0,0 +1,29 @@ +# BlockScout Docker integration + +For now this integration is not production ready. It made only for local usage only ! + +## How to use ? + +## Env variables + +BlockScout support 3 different JSON RPC Variants. +Vriant 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 | `http://localhost:7545` | +| `ETHEREUM_JSONRPC_WEB_SOCKET_URL` | WS JSON RPC url **Only for `geth` or `ganache` variant** | `ws://localhost:7545` | +