Updated deployment docs with additional information, styles, links

5 years ago · 154494a686
parent e0c423e9c5
commit 154494a686
4 changed files with 179 additions and 105 deletions
--- a/docs/ansible-deployment.md
+++ b/docs/ansible-deployment.md
@ -76,63 +76,100 @@ The single point of configuration in this script is a `group_vars/all.yml` file.
 ## Common variables
- `aws_access_key` and `aws_secret_key` is a credentials pair that provides access to AWS for the deployer;
+- `aws_access_key` and `aws_secret_key` is a credentials pair that provides access to AWS for the deployer.
 - `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 after the deployment. Will not work if `backend` is set to false;
 - `upload_debug_info_to_s3` - set to `true` if you want to upload full log output to the S3 bucket automatically after the deployment. Will not work if `backend` is set to false. *IMPORTANT*: Locally logs are stored at `log.txt` which is not cleaned automatically. Please, do not forget to clean it manually or using the `clean.yml` playbook;
 - `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;
 - `prefix` - is a unique tag to use for provisioned resources (5 alphanumeric chars or less);
 - `chains` - maps chains to the URLs of HTTP RPC endpoints, an ordinary blockchain node can be used;
 - The `region` should be left at `us-east-1` as some of the other regions fail for different reasons;
-*Note*: a chain name SHOULD NOT be more than 5 characters. Otherwise, it will throw an error because the aws load balancer name should not be greater than 32 characters.
+- `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 after the deployment. Will not work if `backend` is set to false.
 - `upload_debug_info_to_s3` - set to `true` if you want to upload full log output to the S3 bucket automatically after the deployment. Will not work if `backend` is set to false. 
  >[!DANGER]
  >Locally logs are stored at `log.txt` which is not cleaned automatically. Please, do not forget to clean it manually or using the `clean.yml` playbook.
 - `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.
 - `prefix` - is a unique tag to use for provisioned resources (5 alphanumeric chars or less).
 - `chains` - maps chains to the URLs of HTTP RPC endpoints, an ordinary blockchain node can be used.
 - The `region` should be left at `us-east-1` as some of the other regions fail for different reasons.
   >[!WARNING] 
   >a chain name SHOULD NOT be more than 5 characters. Otherwise, it will throw an error because the aws load balancer name should not be greater than 32 characters.
 ## Infrastructure related variables
- `dynamodb_table` represents the name of  table that will be used for Terraform state lock management;
+- `dynamodb_table` represents the name of  table that will be used for Terraform state lock management.
- If `ec2_ssh_key_content` variable is not empty, Terraform will try to create EC2 SSH key with the `ec2_ssh_key_name` name. Otherwise, the existing key with `ec2_ssh_key_name` name will be used;
+
- `instance_type` defines a size of the Blockscout instance that will be launched during the deployment process;
+- If `ec2_ssh_key_content` variable is not empty, Terraform will try to create EC2 SSH key with the `ec2_ssh_key_name` name. Otherwise, the existing key with `ec2_ssh_key_name` name will be used.
- `vpc_cidr`, `public_subnet_cidr`, `db_subnet_cidr` represents the network configuration for the deployment. Usually you want to leave it as is. However, if you want to modify it, please, expect that `db_subnet_cidr` represents not a single network, but a group of networks started with defined CIDR block increased by 8 bits. 
+
-  Example:
+- `instance_type` defines a size of the Blockscout instance that will be launched during the deployment process.
-  Number of networks: 2
+
-  `db_subnet_cidr`: "10.0.1.0/16"
+- `vpc_cidr`, `public_subnet_cidr`, `db_subnet_cidr` represent the network configuration for the deployment. Usually you will leave as is. However, if you want to modify, understand that `db_subnet_cidr` represents not a single network, but a group of networks that start with a defined CIDR block increased by 8 bits. 
-  Real networks: 10.0.1.0/24 and 10.0.2.0/24
+> [!TIP|label: Example]
- An internal DNS zone with`dns_zone_name` name will be created to take care of BlockScout internal communications;
+> Number of networks: 2 <br />
 > `db_subnet_cidr`: "10.0.1.0/16"<br />
 > Real networks: 10.0.1.0/24 and 10.0.2.0/24
 - An internal DNS zone with`dns_zone_name` name will be created to take care of BlockScout internal communications.
 - The name of a IAM key pair to use for EC2 instances, if you provide a name which
-  already exists it will be used, otherwise it will be generated for you;
+  already exists it will be used, otherwise it will be generated for you.
 - 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.
-* 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 `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 `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;
+- `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.
- `new_relic_app_name` and  `new_relic_license_key` should usually stay empty unless you want and know how to configure New Relic integration;
+
- `elixir_version` - is an Elixir version used in BlockScout release;
+- `new_relic_app_name` and  `new_relic_license_key` should usually stay empty unless you want and know how to configure New Relic integration.
- `chain_trace_endpoint` - maps chains to the URLs of HTTP RPC endpoints, which represents a node where state pruning is disabled (archive node) and tracing is enabled. If you don't have a trace endpoint, you can simply copy values from `chains` variable;
+
- `chain_ws_endpoint` - maps chains to the URLs of HTTP RPCs that supports websockets. This is required to get the real-time updates. Can be the same as `chains` if websocket is enabled there (but make sure to use`ws(s)` instead of `htpp(s)` protocol);
+- `elixir_version` - is an Elixir version used in BlockScout release.
- `chain_jsonrpc_variant` - a client used to connect to the network. Can be `parity`, `geth`, etc;
+
- `chain_logo` - maps chains to the it logos. Place your own logo at `apps/block_scout_web/assets/static` and specify a relative path at `chain_logo` variable;
+- `chain_trace_endpoint` - maps chains to the URLs of HTTP RPC endpoints, which represents a node where state pruning is disabled (archive node) and tracing is enabled. If you don't have a trace endpoint, you can simply copy values from `chains` variable.
- `chain_coin` - a name of the coin used in each particular chain;
+
- `chain_network` - usually, a name of the organization keeping group of networks, but can represent a name of any logical network grouping you want;
+- `chain_ws_endpoint` - maps chains to the URLs of HTTP RPCs that supports websockets. This is required to get the real-time updates. Can be the same as `chains` if websocket is enabled there (but make sure to use`ws(s)` instead of `htpp(s)` protocol).
- `chain_subnetwork` - a name of the network to be shown at BlockScout;
+
 - `chain_jsonrpc_variant` - a client used to connect to the network. Can be `parity`, `geth`, etc.
 - `chain_logo` - maps chains to the it logos. Place your own logo at `apps/block_scout_web/assets/static` and specify a relative path at `chain_logo` variable.
 - `chain_coin` - a name of the coin used in each particular chain.
 - `chain_network` - usually, a name of the organization keeping group of networks, but can represent a name of any logical network grouping you want.
 - `chain_subnetwork` - a name of the network to be shown at BlockScout.
 - `chain_network_path` - a relative URL path which will be used as an endpoint for defined chain. For example, if we will have our BlockScout at `blockscout.com` domain and place `core` network at `/poa/core`, then the resulting endpoint will be `blockscout.com/poa/core` for this network.
- `chain_network_icon` - maps the chain name to the network navigation icon at apps/block_scout_web/lib/block_scout_web/templates/icons without .eex extension
+
 - `chain_network_icon` - maps the chain name to the network navigation icon at apps/block_scout_web/lib/block_scout_web/templates/icons without .eex extension.
 - `chain_graphiql_transaction` - is a variable that maps chain to a random transaction hash on that chain. This hash will be used to provide a sample query in the GraphIQL Playground.
- `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;
+- `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.
 ## Blockscout related variables
- `blockscout_repo` - a direct link to the Blockscout repo;
+- `blockscout_repo` - a direct link to the Blockscout repo.
- `chain_branch` - maps branch at `blockscout_repo` to each chain;
+
- Specify the `chain_merge_commit` variable if you want to merge any of the specified `chains` with the commit in the other branch. Usually may be used to update production branches with the releases from master branch;
+- `chain_branch` - maps branch at `blockscout_repo` to each chain.
- `skip_fetch` - if this variable is set to `true` , BlockScout repo will not be cloned and the process will start from building the dependencies. Use this variable to prevent playbooks from overriding manual changes in cloned repo;
+
- `ps_*` variables represents a connection details to the test Postgres database. This one will not be installed automatically, so make sure `ps_*` credentials are valid before starting the deployment;
+- Specify the `chain_merge_commit` variable if you want to merge any of the specified `chains` with the commit in the other branch. Usually may be used to update production branches with the releases from master branch.
 - `skip_fetch` - if this variable is set to `true` , BlockScout repo will not be cloned and the process will start from building the dependencies. Use this variable to prevent playbooks from overriding manual changes in cloned repo.
 - `ps_*` variables represents a connection details to the test Postgres database. This one will not be installed automatically, so make sure `ps_*` credentials are valid before starting the deployment.
 - `chain_custom_environment` - is a map of variables that should be overrided when deploying the new version of Blockscout. Can be omitted.
-*Note*: `chain_custom_environment` variables will not be propagated to the Parameter Store at production  servers and need to be set there manually.
+   >[!NOTE]
   > `chain_custom_environment` variables will not be propagated to the Parameter Store at production  servers and need to be set there manually.
 # Database Storage Required
@ -158,103 +195,115 @@ The configuration variable `db_storage` can be used to define the amount of stor
 cat group_vars/infrastructure.yml.example group_vars/all.yml.example > group_vars/all.yml
 ```
-4. Set the variables at `group_vars/all.yml` config template file as described at the [corresponding part of instruction](#Configuration);
+4. Set the variables at `group_vars/all.yml` config template file as described in the [configuration section](#Configuration);
 5. Run `ansible-playbook deploy_infra.yml`; 
-   - During the deployment the ["diffs didn't match"](#error-applying-plan-diffs-didnt-match) error may occur, it will be ignored automatically. If  Ansible play recap shows 0 failed plays, then the deployment was successful despite the error.
+   - During the deployment the ["diffs didn't match"](#error-applying-plan-diffs-didnt-match) error may occur. If it does, it will be ignored automatically. If the Ansible play recap shows 0 failed plays, then the deployment was successful despite the error.
-   - Optionally, you may want to check the variables the were uploaded to the [Parameter Store](https://console.aws.amazon.com/systems-manager/parameters) at AWS Console.
+   - Optionally, you may want to check the variables uploaded to the [Parameter Store](https://console.aws.amazon.com/systems-manager/parameters) on your AWS Console.
 # Deploying BlockScout
-1. Ensure all the [BlockScout prerequisites](#Prerequisites-for-deploying-blockscout) are installed and has the right version number;
+1. Ensure all the [BlockScout prerequisites](#Prerequisites-for-deploying-blockscout) are installed and has the right version number.
 2. Merge `blockscout` and `all` config template files into single config file:
 2. Merge `blockscout` and `all` config template files into a single config file:
 ```bash
 cat group_vars/blockscout.yml.example group_vars/all.yml.example > group_vars/all.yml
 ```
-**Note!** All three configuration files are compatible to each other, so you can simply `cat group_vars/blockscout.yml.example >> group_vars/all.yml` if you already do have the `all.yml` file after the deploying of infrastructure.
+> [!NOTE]
 > All three configuration files are compatible with one another, so you can simply `cat group_vars/blockscout.yml.example >> group_vars/all.yml` if you already have the `all.yml` file after deploying the infrastructure.
-3. Set the variables at `group_vars/all.yml` config template file as described at the [corresponding part of instruction](#Configuration);
+3. Set the variables at `group_vars/all.yml` config template file as described in the [configuration section](#Configuration).
-  **Note!** Use `chain_custom_environment` to update the variables in each deployment. Map each deployed chain with variables as they should appear at the Parameter Store. Check the example at `group_vars/blockscout.yml.example` config file. `chain_*` variables will be ignored during BlockScout software deployment.
+> [!NOTE]
 > Use `chain_custom_environment` to update the variables in each deployment. Map each deployed chain with variables as they should appear at the Parameter Store. Check the example at `group_vars/blockscout.yml.example` config file. `chain_*` variables will be ignored during BlockScout software deployment.
-4. This step is for mac OS users. Please skip it, if this is not your case.
+4. This step is for mac OS users only. Please skip if you are not using this OS.
-To avoid the error
+   To avoid the the following Python crash error:
-```
+   ```
-TASK [main_software : Fetch environment variables] ************************************
+   TASK [main_software : Fetch environment variables] ************************************
-objc[12816]: +[__NSPlaceholderDate initialize] may have been in progress in another thread when fork() was called.
+   objc[12816]: +[__NSPlaceholderDate initialize] may have been in progress in another thread when fork() was called.
-objc[12816]: +[__NSPlaceholderDate initialize] may have been in progress in another thread when fork() was called. We cannot safely call it or ignore it in the fork() child process. Crashing instead. Set a breakpoint on objc_initializeAfterForkError to debug.
+   objc[12816]: +[__NSPlaceholderDate initialize] may have been in progress in another thread when fork() was called. We cannot safely call it or ignore it in the fork() child process. Crashing instead. Set a breakpoint on objc_initializeAfterForkError to debug.
-```
+   ```
 error and crashing of Python follow the next steps:
- Open terminal: `nano .bash_profile`;
+   - Open terminal: `nano .bash_profile`;
- Add the following line to the end of the file: `export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES`;
+   - Add the following line to the end of the file: `export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES`;
- Save, exit, close terminal and re-open the terminal. Check to see that the environment variable is now set: `env`
+   - Save, exit, close terminal and re-open the terminal. Check to see that the environment variable is now set: `env`
-(source: https://stackoverflow.com/questions/50168647/multiprocessing-causes-python-to-crash-and-gives-an-error-may-have-been-in-progr);
+   (source: https://stackoverflow.com/questions/50168647/multiprocessing-causes-python-to-crash-and-gives-an-error-may-have-been-in-progr);
 5. Run `ansible-playbook deploy_software.yml`.
 5. Run `ansible-playbook deploy_software.yml`; 
 6. When the prompt appears, check that server is running and there is no visual artifacts. The server will be launched at port 4000 at the same machine where you run the Ansible playbooks. If you face any errors you can either fix it or cancel the deployment by pressing **Ctrl+C** and then pressing **A** when additionally prompted.
 7. When server is ready to be deployed simply press enter and deployer will upload Blockscout to the appropriate S3.
 8. Two other prompts will appear to ensure your will on updating the Parameter Store variables and deploying the BlockScout through the CodeDeploy. Both **yes** and **true** will be interpreted as the confirmation.
 9. Monitor and manage your deployment at [CodeDeploy](https://console.aws.amazon.com/codesuite/codedeploy/applications) service page at AWS Console.
 # Destroying Provisioned Infrastructure
-First of all you have to remove autoscaling groups (ASG) deployed via CodeDeploy manually since Terraform doesn't track them and will miss them during the automatic destroy process. Once ASG is deleted you can use `ansible-playbook destroy.yml` playbook to remove the rest of generated infrastructure. Make sure to check the playbook output since in some cases it might not be able to delete everything. Check the error description for details.
+First, remove autoscaling groups (ASG) deployed via CodeDeploy manually since Terraform doesn't track them and will miss them during the automatic destroy process. Once ASG is deleted you can use the `ansible-playbook destroy.yml` playbook to remove the rest of generated infrastructure. Make sure to check the playbook output since in some cases it may not delete everything. Check the error description for details.
-**Note!** While Terraform is stateful, Ansible is stateless, so if you modify `bucket` or `dynamodb_table` variables and run `destroy.yml` or `deploy_infra.yml`  playbooks, it will not alter the current S3/Dynamo resources names, but create a new resources. Moreover, altering `bucket` variable will make Terraform to forget about existing infrastructure and, as a consequence, redeploy it. If it absolutely necessary for you to alter the S3 or DynamoDB names you can do it manually and then change the appropriate variable accordingly. 
+> [!WARNING]
 >While Terraform is stateful, Ansible is stateless, so if you modify `bucket` or `dynamodb_table` variables and run `destroy.yml` or `deploy_infra.yml`  playbooks, it will not alter the current S3/Dynamo resources names, but create a new resources. Moreover, altering `bucket` variable will make Terraform to forget about existing infrastructure and, as a consequence, redeploy it. If it is absolutely necessary for you to alter the S3 or DynamoDB names, perform this operation manually and then change the appropriate variable accordingly. 
-Also note, that changing `backend` variable will force Terraform to forget about created infrastructure also, since it will start searching the current state files locally instead of remote.
+> [!NOTE]
 > Changing the `backend` variable will force Terraform to forget about created infrastructure, since it will start searching the current state files locally instead of remote.
 # Useful information
 ## Cleaning Deployment cache
-Despite the fact that Terraform cache is automatically cleared automatically before each deployment, you may also want to force the cleaning process manually. To do this simply run the `ansible-playbook clean.yml` command, and Terraform cache will be cleared.
+Despite the fact that the Terraform cache is automatically cleared before each deployment, you may also want to manually force the cleaning process. To clear the Terraform cache, Run the `ansible-playbook clean.yml` command.
 ## Migrating deployer to another machine
-You can easily manipulate your deployment from any machine with sufficient prerequisites. If  `upload_debug_info_to_s3` variable is set to true, the deployer will automatically upload your `all.yml` file to the s3 bucket, so you can easily download it to any other machine. Simply download this file to your `group_vars` folder and your new deployer will pick up the current deployment instead of creating a new one.
+You can easily manipulate your deployment from any machine with sufficient prerequisites. If the `upload_debug_info_to_s3` variable is set to true, the deployer will automatically upload your `all.yml` file to the s3 bucket, so you can download it to any other machine. Simply download this file to your `group_vars` folder and your new deployer will pick up the current deployment instead of creating a new one.
 ## Attaching the existing RDS instance to the current deployment
-In some cases you may want not to create a new database, but to add the existing one to use within the deployment. In order to do that configure all the proper values at `group_vars/all.yml` including yours DB ID and name and execute the `ansible-playbook attach_existing_rds.yml` command. This will add the current DB instance into Terraform-managed resource group. After that run `ansible-playbook deploy_infra.yml` as usually. 
+Rather than create a new database, you may want to add an existing instance to use with the deployment. To do this, configure all proper values at `group_vars/all.yml`, including your DB ID and name, and execute the `ansible-playbook attach_existing_rds.yml` command. This will add the current DB instance into the Terraform-managed resource group. After that run `ansible-playbook deploy_infra.yml` as you normally would. 
 **Note 1**:  while executing `ansible-playbook attach_existing_rds.yml` the S3 and DynamoDB will be automatically created (if `backend` variable is set to `true`) to store Terraform state files. 
 **Note 2**: the actual name of your resource must include prefix that you will use in this deployment.
-Example:
+> [!NOTE|label: Note 1]  
 > While executing `ansible-playbook attach_existing_rds.yml` the S3 and DynamoDB instances will be automatically created (if `backend` variable is set to `true`) to store Terraform state files. 
-  Real resource: tf-poa
+> [!NOTE|label: Note 2] 
 > The actual name of your resource must include the prefix you are using with this deployment.<br />
 >
 >Example:<br />
 >
 >Real resource: tf-poa<br />
 >
 > `prefix` variable: tf<br />
 >
 > `chain_db_id` variable: poa<br />
-  `prefix` variable: tf
+> [!NOTE|label: Note 3]
 > mMke sure MultiAZ is disabled on your database.
-  `chain_db_id` variable: poa
+> [!NOTE|label: Note 4]  
 > Make sure that all the variables at `group_vars/all.yml` are exactly the same as your existing DB.
-**Note 3**: make sure MultiAZ is disabled on your database.
+## Using AWS CodeDeploy to Monitor and manage a BlockScout deployment
 **Note 4**: make sure that all the variables at `group_vars/all.yml` are exactly the same as at your existing DB.
 ## Using AWS CodeDeploy to Mmnitor and manage a BlockScout deployment
 BlockScout deployment can be managed through the AWS console. [A brief tutorial is available on our forum](https://forum.poa.network/t/monitor-and-manage-a-blockscout-deployment-using-codedeploy-in-your-aws-console/2499).
 # Common Errors and Questions
-### S3: 403 error during provisioning
+## S3: 403 error during provisioning
 Usually appears if S3 bucket already exists. Remember, S3 bucket has globally unique name, so if you don't have it, it doesn't mean, that it doesn't exists at all. Login to your AWS console and try to create S3 bucket with the same name you specified at `bucket` variable to ensure.
-### Error Applying Plan (diffs didn't match)
+This usually appears if the S3 bucket already exists. Remember, the S3 bucket has a unique global name. Login to your AWS console and create an S3 bucket with the same name you specified in the  `bucket` variable to ensure they match.
-If you see something like the following:
+## Error Applying Plan (diffs didn't match)
-```
+If you see something similar to the following:
 ```bash
 Error: Error applying plan:
 1 error(s) occurred:
@ -268,8 +317,8 @@ Please include the following information in your report:
    Mismatch reason: attribute mismatch: availability_zones.1252502072
 ```
-This is due to a bug in Terraform, however the fix is to just rerun `ansible-playbook deploy_infra.yml` again, and Terraform will pick up where it left off. This does not always happen, but this is the current workaround if you see it.
+This is due to a bug in Terraform, the fix is to run `ansible-playbook deploy_infra.yml` again, and Terraform will pick up where it left off. This does not always happen, but this is the current workaround if needed.
-### Server doesn't start during deployment
+## Server doesn't start during deployment
-Even if server is configured correctly, sometimes it may not bind the appropriate 4000 port due to unknown reason. If so, simply go to the appropriate nested blockscout folder, kill and rerun server. For example, you can use the following command: `pkill beam.smp && pkill node && sleep 10 && mix phx.server`.
+Even if the server is configured correctly, sometimes it may not bind the appropriate 4000 port for unknown reasons. If so, simply go to the appropriate nested blockscout folder, kill and rerun the server. For example, you can use the following command: `pkill beam.smp && pkill node && sleep 10 && mix phx.server`.
--- a/docs/env-variables.md
+++ b/docs/env-variables.md
@ -2,6 +2,17 @@
 Below is a table outlining the environment variables utilized by BlockScout.
 **Notes:**
 - This table is horizontally scrollable, version information is located in the last column.
 - Settings related to the `ETHEREUM_JSONRPC_VARIANT` variable and client related settings for running a full archive node with geth or parity are located in [this forum post](https://forum.poa.network/t/faq-what-settings-are-required-on-a-parity-or-geth-client/1805).
 - Additional information related to certain variables is available on the [ansible deployment](ansible-deployment.md) page.
 - To set variables using the CLI, use the export command. For example: 
 ```bash
 $ export ETHEREUM_JSONRPC_VARIANT=parity
 $ export COIN=POA
 $ export NETWORK=POA
 ```
 | Variable | Required | Description | Default | Version |
 | --- | --- | --- | ---| --- |
@ -32,7 +43,7 @@ Below is a table outlining the environment variables utilized by BlockScout.
 | `HEART_BEAT_TIMEOUT` | | Production environment variable to restart the application in the event of a crash. | 30 | all |
 | `HEART_COMMAND` | | Production environment variable to restart the application in the event of a crash. | systemctl restart explorer.service | all |
 | `BLOCKSCOUT_VERSION` | | Added to the footer to signify the current BlockScout version. | (empty) | v1.3.4+ |
-| `RELEASE_LINK` | | The link to Blockscout release notes in the footer. | https://github.com/poanetwork/ <br /> <u>blockscout/releases/</u> <br /> <u>tag/${BLOCKSCOUT_VERSION}</u> | v1.3.5+ |
+| `RELEASE_LINK` | | The link to Blockscout release notes in the footer. | <u>https: //github.com/poanetwork/</u> <br /><u>blockscout/releases/</u> <br /> <u>tag/${BLOCKSCOUT_VERSION}</u> | v1.3.5+ |
 | `ELIXIR_VERSION` | | Elixir version to install on the node before Blockscout deploy. | (empty) | all |
 | `BLOCK_TRANSFORMER` | | Transformer for blocks: base or clique. | base |  v1.3.4+ |
 | `GRAPHIQL _TRANSACTION` | | Default transaction in query to GraphiQL. | (empty) |  v1.3.4+ |
--- a/docs/index.html
+++ b/docs/index.html
@ -1,20 +1,19 @@
 <!DOCTYPE html>
 <html lang="en">
-<head>
+ <head>
  <meta charset="UTF-8">
  <title>BlockScout Docs</title>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  <meta name="description" content="Description">
  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
- <link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
  <style>
    nav.app-nav li ul {
      min-width: 100px;
  }
-</style>
+  </style>
-
+ </head>
-</head>
+ <body>
 <body>
  <div id="app"></div>
  <script>
    window.$docsify = {
@ -31,5 +30,6 @@
  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
  <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
  <script src="https://unpkg.com/docsify-plugin-flexible-alerts"></script>
-</body>
+  <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
 </body>
 </html>
--- a/docs/manual-deployment.md
+++ b/docs/manual-deployment.md
@ -1,9 +1,13 @@
 <!-- manual-deployment.md -->
-## Manual Deployment
+# Manual Deployment
 Below is the procedure for manual deployment of BlockScout. For automated deployment, see [ansible deployment](ansible-deployment.md).
 BlockScout currently requires a full archive node in order to import every state change for every address on the target network. For client specific settings related to a node running parity or geth, please see [this forum post](https://forum.poa.network/t/faq-what-settings-are-required-on-a-parity-or-geth-client/1805). 
 ## Deployment Steps
 1. `git clone https://github.com/poanetwork/blockscout`
 2. `cd blockscout`
@ -27,9 +31,13 @@ Below is the procedure for manual deployment of BlockScout. For automated deploy
 7. If not already running, start postgres: `pg_ctl -D /usr/local/var/postgres start`
   > [!TIP]
   > To check [postgres status](https://www.postgresql.org/docs/9.6/app-pg-isready.html): `pg_isready`
 8. Create and migrate database `mix do ecto.create, ecto.migrate`
-   *Note:*  If you have run previously, drop the previous database
+   > [!NOTE] 
   > If you have run previously, drop the previous database
   `mix do ecto.drop, ecto.create, ecto.migrate`
 9. Install Node.js dependencies
@ -41,10 +49,10 @@ Below is the procedure for manual deployment of BlockScout. For automated deploy
 10. Enable HTTPS in development. The Phoenix server only runs with HTTPS.
     * `cd apps/block_scout_web`
     * `mix phx.gen.cert blockscout blockscout.local; cd -`
     * Add blockscout and blockscout.local to your  `/etc/hosts`
-      * `mix phx.gen.cert blockscout blockscout.local; cd -`
+```bash
      * Add blockscout and blockscout.local to your  `/etc/hosts`
 ```
   127.0.0.1       localhost blockscout blockscout.local
@ -54,15 +62,21 @@ Below is the procedure for manual deployment of BlockScout. For automated deploy
 ```
-* If using Chrome, Enable  `chrome://flags/#allow-insecure-localhost` .
+> [!NOTE] 
 > If using Chrome, Enable  `chrome://flags/#allow-insecure-localhost`
 11. Set your [environment variables](env-variables.md) as needed. 
-11.  Set your [environment variables](env-variables.md) as needed.  For example:
+CLI Example:
 ```bash
 export COIN=DAI
 export NETWORK_ICON=_network_icon.html
 export ... 
 ```
 > [!NOTE] 
 >The `ETHEREUM_JSONRPC_VARIANT` will vary depending on your client (parity, geth etc). [See this forum post](https://forum.poa.network/t/faq-what-settings-are-required-on-a-parity-or-geth-client/1805) for more information on client settings.
 12. Return to the root directory and start the Phoenix Server.  `mix phx.server`
 ## Check your instance: