diff --git a/README.md b/README.md index fab5bcf..78e1e2b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Discord](https://img.shields.io/discord/534485763354787851.svg)](https://discord.gg/vvUtWJB) -SKALE Proxy is high performance, easy-to-run public service that provides proxied and load-balanced +SKALE Proxy is high performance, easy-to-run public service that provides proxied and load-balanced JSON-RPC endpoints for SKALE chains. It is based on NGINX. ## Usage guide @@ -14,14 +14,14 @@ JSON-RPC endpoints for SKALE chains. It is based on NGINX. ### Repo setup -1. Clone repo & all submodules -2. Put `abi.json`, `server.crt` and `server.key`files in `data` folder +1. Clone repo & all submodules +2. Put `abi.json`, `server.crt` and `server.key`files in `data` folder 3. Export all required environment variables (see below) 4. Run `scripts/run_proxy.sh` #### Required environment variables -- `ENDPOINT` - endpoint of the Ethereum network where `skale-manager` contracts are deployed +- `ETH_ENDPOINT` - endpoint of the Ethereum network where `skale-manager` contracts are deployed ## License @@ -30,4 +30,3 @@ JSON-RPC endpoints for SKALE chains. It is based on NGINX. All contributions to SKALE Proxy are made under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.en.html). See [LICENSE](LICENSE). Copyright (C) 2022-Present SKALE Labs. - diff --git a/scripts/run_proxy.sh b/scripts/run_proxy.sh index c5d9dd2..a0a4a57 100644 --- a/scripts/run_proxy.sh +++ b/scripts/run_proxy.sh @@ -4,7 +4,7 @@ set -e export DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" -: "${ENDPOINT?Need to set ENDPOINT}" +: "${ETH_ENDPOINT?Need to set ETH_ENDPOINT}" cd $DIR/.. docker-compose up --build -d \ No newline at end of file