From ea06fe4c679f93888f116e56f6df36b4fb39eb3c Mon Sep 17 00:00:00 2001 From: hatemosphere Date: Fri, 8 Mar 2024 09:13:20 +0100 Subject: [PATCH 1/5] chore(docs): Better explain env settings, minor tweaks --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 888f0b6..74b2c8f 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ l1_chain_id: "" l2_chain_id: "" ``` +Please refer to [External Node docs](https://github.com/matter-labs/zksync-era/tree/main/docs/guides/external-node/prepared_configs) to find values for different zkSync Era chains. + If you want to use monitoring (which we highly recommend), you have to change these variables: ```yaml @@ -84,12 +86,17 @@ Basic auth secret can be generated by `htpasswd` and `sed` for interpolation: 1. Install the ansible collection on your machine from where you will run ansible: `ansible-galaxy collection install community.general` -2. Prepare the latest database backup on your host. you can download it from our [public GCS bucket](https://storage.googleapis.com/zksync-era-mainnet-external-node-backups/external_node_latest.pgdump). -you should place it to `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en` +2. Prepare the latest database backup on your host. you can download it from our public GCS buckets: -3. **OPTIONAL**: If you already have external-node, you can copy tree directory to new host. Copy external-node database tree to `{{ storage_directory }}/db`. +* Era Mainnet: +* Era Sepolia Testnet: +* Era Goerli Testnet: -**Keep in mind, external-node tree should be older than PostgreSQL database backup.** +Downloaded dump file should be placed into `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en` + +3. **OPTIONAL**: If you already have running node, you can copy its tree and state directory to a new host's `{{ storage_directory }}/db`. + +**Keep in mind that tree and state should be older than PostgreSQL database backup.** 4. Run ansible-playbook using this role. We recommend encrypting next variables with ansible-vault or some another way: From 9f7f0bb6cd3ec6b427d18662be0b588a769b4746 Mon Sep 17 00:00:00 2001 From: hatemosphere Date: Fri, 8 Mar 2024 09:15:58 +0100 Subject: [PATCH 2/5] prettify dump links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 74b2c8f..a10e8c1 100644 --- a/README.md +++ b/README.md @@ -88,9 +88,9 @@ Basic auth secret can be generated by `htpasswd` and `sed` for interpolation: 2. Prepare the latest database backup on your host. you can download it from our public GCS buckets: -* Era Mainnet: -* Era Sepolia Testnet: -* Era Goerli Testnet: +* [Era Mainnet latest dump](https://storage.googleapis.com/zksync-era-mainnet-external-node-backups/external_node_latest.pgdump) +* [Era Sepolia Testnet latest dump])) +* [Era Goerli Testnet latest dump](https://storage.googleapis.com/zksync-era-testnet-external-node-backups/external_node_latest.pgdump) Downloaded dump file should be placed into `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en` From 991e7ba5873d6eb39c746bd61c45c3f6850a1cf1 Mon Sep 17 00:00:00 2001 From: hatemosphere Date: Fri, 8 Mar 2024 09:16:24 +0100 Subject: [PATCH 3/5] typo fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a10e8c1..8559026 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ Basic auth secret can be generated by `htpasswd` and `sed` for interpolation: 2. Prepare the latest database backup on your host. you can download it from our public GCS buckets: * [Era Mainnet latest dump](https://storage.googleapis.com/zksync-era-mainnet-external-node-backups/external_node_latest.pgdump) -* [Era Sepolia Testnet latest dump])) +* [Era Sepolia Testnet latest dump]) * [Era Goerli Testnet latest dump](https://storage.googleapis.com/zksync-era-testnet-external-node-backups/external_node_latest.pgdump) Downloaded dump file should be placed into `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en` From e776080ba476e3497ec140da8f0b0c718b4f6022 Mon Sep 17 00:00:00 2001 From: hatemosphere Date: Fri, 8 Mar 2024 09:17:00 +0100 Subject: [PATCH 4/5] typo fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8559026..43ea606 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ Basic auth secret can be generated by `htpasswd` and `sed` for interpolation: 2. Prepare the latest database backup on your host. you can download it from our public GCS buckets: * [Era Mainnet latest dump](https://storage.googleapis.com/zksync-era-mainnet-external-node-backups/external_node_latest.pgdump) -* [Era Sepolia Testnet latest dump]) +* [Era Sepolia Testnet latest dump](https://storage.googleapis.com/zksync-era-boojnet-external-node-snapshots/external_node_latest.pgdump) * [Era Goerli Testnet latest dump](https://storage.googleapis.com/zksync-era-testnet-external-node-backups/external_node_latest.pgdump) Downloaded dump file should be placed into `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en` From 37bbe33ad7be59f8429328c93d20aa5905d8433b Mon Sep 17 00:00:00 2001 From: hatemosphere Date: Fri, 8 Mar 2024 09:18:55 +0100 Subject: [PATCH 5/5] minor tweaks --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 43ea606..640332c 100644 --- a/README.md +++ b/README.md @@ -92,9 +92,9 @@ Basic auth secret can be generated by `htpasswd` and `sed` for interpolation: * [Era Sepolia Testnet latest dump](https://storage.googleapis.com/zksync-era-boojnet-external-node-snapshots/external_node_latest.pgdump) * [Era Goerli Testnet latest dump](https://storage.googleapis.com/zksync-era-testnet-external-node-backups/external_node_latest.pgdump) -Downloaded dump file should be placed into `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en` +Downloaded dump file should be placed into `{{ storage_directory }}/pg_backups` directory (`/usr/src/en/pg_backups` by default) -3. **OPTIONAL**: If you already have running node, you can copy its tree and state directory to a new host's `{{ storage_directory }}/db`. +3. **OPTIONAL**: If you already have running node, you can copy its tree and state directory to a new host's `{{ storage_directory }}/db`. (`/usr/src/en/db` by default) **Keep in mind that tree and state should be older than PostgreSQL database backup.**