From 392545d27b889192af36e0d2a40f1a6f13bcfe77 Mon Sep 17 00:00:00 2001 From: Jaguaras Date: Wed, 22 Jan 2025 14:58:03 +0200 Subject: [PATCH 1/2] Restructure fast sync guide --- .../version-v2.2.0/node/fast-sync.md | 43 ++++++++++++++++--- .../version-v2.2.0/node/troubleshooting.md | 6 +-- 2 files changed, 40 insertions(+), 9 deletions(-) diff --git a/versioned_docs/version-v2.2.0/node/fast-sync.md b/versioned_docs/version-v2.2.0/node/fast-sync.md index 41ceb56..398df2a 100644 --- a/versioned_docs/version-v2.2.0/node/fast-sync.md +++ b/versioned_docs/version-v2.2.0/node/fast-sync.md @@ -6,18 +6,49 @@ title: Fast Sync import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## What is a Fast Sync? +## What is Fast Sync? -Fast Sync is a feature that allows your node to complete synchronization in as little as 10 to 20 minutes, even without a local RPC provider. The exact syncing duration may vary depending on your machine's hardware specifications. +Fast Sync feature was implemented on the HOPRd version 2.2.0, it allows your node to complete synchronization in as little as 10 to 20 minutes, even without a local RPC provider. The exact syncing duration may vary depending on your machine's hardware specifications. -## How to configure Fast Sync? +## Preparing for Fast Sync + +(**1**) First, you must upgrade your node to the latest version. To update your node, follow this [guide](backup-restore-update.md#update-your-node). + +(**2**) You must fully synchronize your node from scratch. Once your node is fully synchronized, check if it is performing normally by following this [guide](troubleshooting.md#how-to-check-if-my-node-is-performing-normally). + +(**3**) Make a backup of your fully synchronized node, select your platform: + + + + +Find the database log files "**hopr_logs.db**", "**hopr_logs.db-shm**", and "**hopr_logs.db-wal**" at the path "**/\/.hoprd-db-dufour/**". Store these files for future use in a Fast Sync. + + + + +Find the database log files "**hopr_logs.db**", "**hopr_logs.db-shm**", and "**hopr_logs.db-wal**" at the path "**/\/compose/hoprd_data/hoprd/db/**". Store these files for future use in a Fast Sync. + + + + +(**3.1**) Go to the [HOPR package backup page](http://my.dappnode/packages/my/hopr.public.dappnode.eth/backup). + +(**3.2**) Click the "**Backup now**" button to download a backup of your HOPR node. +**Important:** If you are using a browser like Brave, the backup file may not download automatically. You will need to click "**Keep**" in your browser’s downloads section. + +(**3.3**) Unarchive the downloaded backup file and navigate to the path **"/\hopr.public.dappnode.eth_backup/db/db/"** to find the database log files: "**hopr_logs.db**", "**hopr_logs.db-shm**", and "**hopr_logs.db-wal**". Store these files for future use in a Fast Sync. + + + + +## Enabling Fast Sync on your node Please select platform to configure Fast Sync feature: -(**1**) Download the archived file "**hopr_logs.tar.gz**" from the HOPR google cloud storage: [https://storage.googleapis.com/hoprd-sync-data-prod/hopr_logs.tar.gz](https://storage.googleapis.com/hoprd-sync-data-prod/hopr_logs.tar.gz) +(**1**) Locate the database log files that you previously gathered from this [guide](#preparing-for-fast-sync). (**2**) Ensure that you have stopped the HOPRd node Docker container. You can find more details [here](node-operations.md#stop-your-hopr-node). @@ -34,7 +65,7 @@ Please select platform to configure Fast Sync feature: -(**1**) Download the archived file "**hopr_logs.tar.gz**" from the HOPR google cloud storage: [https://storage.googleapis.com/hoprd-sync-data-prod/hopr_logs.tar.gz](https://storage.googleapis.com/hoprd-sync-data-prod/hopr_logs.tar.gz) +(**1**) Locate the database log files that you previously gathered from this [guide](#preparing-for-fast-sync). (**2**) Ensure that you have stopped the HOPRd node. You can find more details [here](node-operations.md#stop-your-hopr-node). @@ -49,7 +80,7 @@ Please select platform to configure Fast Sync feature: -(**1**) Download the archived file "**hopr_logs.tar.gz**" from the HOPR google cloud storage: [https://storage.googleapis.com/hoprd-sync-data-prod/hopr_logs.tar.gz](https://storage.googleapis.com/hoprd-sync-data-prod/hopr_logs.tar.gz) +(**1**) Locate the database log files that you previously gathered from this [guide](#preparing-for-fast-sync). (**2**) Connect to your DAppNode dashboard. diff --git a/versioned_docs/version-v2.2.0/node/troubleshooting.md b/versioned_docs/version-v2.2.0/node/troubleshooting.md index 232fe8f..8458042 100644 --- a/versioned_docs/version-v2.2.0/node/troubleshooting.md +++ b/versioned_docs/version-v2.2.0/node/troubleshooting.md @@ -149,7 +149,7 @@ Please select platform to re-sync node: (**4**) **Start your node**: once the cleanup is done, start your node again by following this [guide](./node-operations.md#start-your-hopr-node). -(**5**) **Optional step**: If you want to use the [fast synchronization feature](fast-sync.md#what-is-a-fast-sync) during the re-sync process, follow the [fast-sync guide](fast-sync.md#how-to-configure-fast-sync). +(**5**) **Optional step**: If you want to use the [fast synchronization feature](fast-sync.md#what-is-fast-sync) during the re-sync process, follow the [fast-sync guide](fast-sync.md#preparing-for-fast-sync). @@ -170,7 +170,7 @@ COMPOSE_PROFILES=hoprd docker compose down COMPOSE_PROFILES=hoprd docker compose up -d ``` -(**5**) **Optional step**: If you want to use the [fast synchronization feature](fast-sync.md#what-is-a-fast-sync) during the re-sync process, follow the [fast-sync guide](fast-sync.md#how-to-configure-fast-sync). +(**5**) **Optional step**: If you want to use the [fast synchronization feature](fast-sync.md#what-is-fast-sync) during the re-sync process, follow the [fast-sync guide](fast-sync.md#preparing-for-fast-sync). @@ -183,7 +183,7 @@ COMPOSE_PROFILES=hoprd docker compose up -d (**4**) **Restore your node identity**: Follow this guide to [restore your node identity](backup-restore-update.md#restore-your-node-identity). -(**5**) **Optional step**: If you want to use the [fast synchronization feature](fast-sync.md#what-is-a-fast-sync) during the re-sync process, follow the [fast-sync guide](fast-sync.md#how-to-configure-fast-sync). +(**5**) **Optional step**: If you want to use the [fast synchronization feature](fast-sync.md#what-is-fast-sync) during the re-sync process, follow the [fast-sync guide](fast-sync.md#preparing-for-fast-sync). (**6**) **Verify the restore process**: Go to the [Logs tab](http://my.dappnode/packages/my/hopr.public.dappnode.eth/logs). In the logs, you should see syncing process lines, indicating the restore was successful and the re-sync process is underway. Wait for the node to fully sync to 100%. From 6bd30df4a1c88aa75c549d8561d9c4f9b071a443 Mon Sep 17 00:00:00 2001 From: Jaguaras Date: Wed, 22 Jan 2025 14:59:27 +0200 Subject: [PATCH 2/2] update --- versioned_docs/version-v2.2.0/node/fast-sync.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-v2.2.0/node/fast-sync.md b/versioned_docs/version-v2.2.0/node/fast-sync.md index 398df2a..1ebf2c7 100644 --- a/versioned_docs/version-v2.2.0/node/fast-sync.md +++ b/versioned_docs/version-v2.2.0/node/fast-sync.md @@ -21,12 +21,12 @@ Fast Sync feature was implemented on the HOPRd version 2.2.0, it allows your nod -Find the database log files "**hopr_logs.db**", "**hopr_logs.db-shm**", and "**hopr_logs.db-wal**" at the path "**/\/.hoprd-db-dufour/**". Store these files for future use in a Fast Sync. +(**3.1**) Find the database log files "**hopr_logs.db**", "**hopr_logs.db-shm**", and "**hopr_logs.db-wal**" at the path "**/\/.hoprd-db-dufour/**". Store these files for future use in a Fast Sync. -Find the database log files "**hopr_logs.db**", "**hopr_logs.db-shm**", and "**hopr_logs.db-wal**" at the path "**/\/compose/hoprd_data/hoprd/db/**". Store these files for future use in a Fast Sync. +(**3.1**) Find the database log files "**hopr_logs.db**", "**hopr_logs.db-shm**", and "**hopr_logs.db-wal**" at the path "**/\/compose/hoprd_data/hoprd/db/**". Store these files for future use in a Fast Sync.