From 74fc4003ea1c97429af94100ad9f58708cb9c460 Mon Sep 17 00:00:00 2001 From: ArseniiPetrovich Date: Tue, 26 Mar 2019 16:28:40 +0300 Subject: [PATCH] Updated readme, add variables --- README.md | 4 +++- group_vars/all.yml.example | 6 +++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ea5ba17..8b983f1 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ The single point of configuration in this script is a `group_vars/all.yml` file. - `backend` variable defines whether deployer should keep state files remote or locally. Set `backend` variable to `true` if you want to save state file to the remote S3 bucket; - `upload_config_to_s3` - set to `true` if you want to upload config`all.yml` file to the S3 bucket automatically during deployment. Will not work if `backend` is set to false; - `bucket` represents a globally unique name of the bucket where your configs and state will be stored. It will be created automatically during the deployment; +- `elixir_version` - is an Elixir version used in BlockScout release; - `chains` - maps chains to the URLs of HTTP RPC endpoints, an ordinary blockchain node can be used; @@ -86,6 +87,7 @@ The single point of configuration in this script is a `group_vars/all.yml` file. - `chain_block_transformer` - will be `clique` for clique networks like Rinkeby and Goerli, and `base` for the rest; - `chain_heart_beat_timeout`, `chain_heart_command` - configs for the integrated heartbeat. First describes a timeout after the command described at the second variable will be executed; - Each of the `chain_db_*` variables configures the database for each chain. Each chain will have the separate RDS instance. +- `chain_blockscout_version` - is a text at the footer of BlockScout instance. Usually represents the current BlockScout version. ## Infrastructure related variables @@ -104,7 +106,7 @@ The single point of configuration in this script is a `group_vars/all.yml` file. * If `use_ssl` is set to `false`, SSL will be forced on Blockscout. To configure SSL, use `alb_ssl_policy` and `alb_certificate_arn` variables; -- The region should be left at `us-east-1` as some of the other regions fail for different reasons; +- The `region` should be left at `us-east-1` as some of the other regions fail for different reasons; - The `root_block_size` is the amount of storage on your EC2 instance. This value can be adjusted by how frequently logs are rotated. Logs are located in `/opt/app/logs` of your EC2 instance; - The `pool_size` defines the number of connections allowed by the RDS instance; - `secret_key_base` is a random password used for BlockScout internally. It is highly recommended to gernerate your own `secret_key_base` before the deployment. For instance, you can do it via `openssl rand -base64 64 | tr -d '\n'` command; diff --git a/group_vars/all.yml.example b/group_vars/all.yml.example index fc75a0d..bc2de43 100644 --- a/group_vars/all.yml.example +++ b/group_vars/all.yml.example @@ -131,6 +131,9 @@ chain_db_storage_type: chain_db_version: core: "10.5" sokol: "10.6" + +## The following variable represents the elixir version that will be used to run BlockScout instance. Will be used to download the Elixir at the following link: https://github.com/elixir-lang/elixir/releases/download/{{ elixir_version }}/Precompiled.zip +elixir_version: "v1.7.4" # Infrastructure related variables @@ -179,9 +182,6 @@ secret_key_base: "TPGMvGK0iIwlXBQuQDA5KRqk77VETbEBlG4gAWeb93TvBsYAjvoAvdODMd6Zeg new_relic_app_name: "" new_relic_license_key: "" -## The following variable represents the elixir version that will be used to run BlockScout instance. Will be used to download the Elixir at the following link: https://github.com/elixir-lang/elixir/releases/download/{{ elixir_version }}/Precompiled.zip -elixir_version: "v1.7.4" - # BlockScout related variables ## An address of BlockScout repo to download