feat(nodes): add guide for running TON archive liteserver#2140
Conversation
Created a new guide for setting up an archive node in liteserver mode.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
|
||
| Running an archive liteserver node requires significant storage and network resources. | ||
|
|
||
| - **CPU**: 16-core CPU |
There was a problem hiding this comment.
Naming in lists seems unnecessary; let's keep the same formatting, as this was made for the "Run a validator" guide.
Lesser words - easier to get the significant information.
|
|
||
| - **CPU**: 16-core CPU | ||
| - **RAM**: 128 GB RAM | ||
| - **Storage**: At least 16TB of SSD storage, 20TB if you will not use ZFS with compression (NVMe recommended), or Provisioned 64k+ IOPS storage |
There was a problem hiding this comment.
Discuss with team if this reqiurements actual: WIP
|
|
||
| - **Supported OS**: Ubuntu 22.04 LTS, Ubuntu 24.04 LTS, or Debian 11. | ||
| - **Open Files Limit**: Must be set above 400,000. | ||
|
|
There was a problem hiding this comment.
Please, add info on the minimum version for Python:
Python 3.10 or higher
| | [@tonstatus](https://t.me/tonstatus) | TON Mainnet | | ||
| | [@testnetstatus](https://t.me/testnetstatus) | TON Testnet | | ||
|
|
||
| ## Step 2: Install ZFS and prepare volume |
There was a problem hiding this comment.
This part is better aligned with the first step, as the preparation environment, up to Mytonctrl installation.
| sudo zfs set mountpoint=/var/ton-work data/ton-work | ||
| ``` | ||
|
|
||
| ## Step 3: Installation via MyTonCtrl |
There was a problem hiding this comment.
This is still preparation of the environment, which should be numbered with
### 1.x Prepare the operator account| MyTonCtrl> installer set_node_argument --verbosity 1 | ||
| ``` | ||
|
|
||
| ### 5.2 ZFS Snapshots |
There was a problem hiding this comment.
Better to explain the function we provide here in the header.
This may be a part of the explanation of the updating flow:
### 5.2 Updating flow
make snapshot -> update -> make sure all is fine, roll back for updates that come out with issues.
There was a problem hiding this comment.
It seems like some information in this section is outside the scope of the update process. I have moved it to the position immediately following the update section to supplement the information on snapshot management. But I think we should kept it as a independent section.
| MyTonCtrl> status | ||
| ``` | ||
|
|
||
| Check the field **Local validator initial sync status**. The value indicates how many blocks are left to sync. On fully synchronized node, this value should be less than 20 seconds. |
There was a problem hiding this comment.
Discuss actuality for 20 seconds - WIP
| sudo chown -R <install_user>:<install_user> /var/ton-work/keys | ||
| ``` | ||
|
|
||
| ### 4.4 Open the node UDP port and the liteserver port |
There was a problem hiding this comment.
This step should be specified before the synchronization step
| sudo ufw status | ||
| ``` | ||
|
|
||
| ## Step 5: Troubleshooting and Maintenance |
There was a problem hiding this comment.
Better to set Maintenance as a separate step. We declare that the "Maintenance" step will be mandatory, even if no issues appear.
For example, the arhival LiteServer owner must and should do as follows:
- monitor server stability
- monitor synchronization parameter
- check memory leak
- make backups to be able to perform a quick restore
- If monitoring highlights abnormal behavior, report to support or check the troubleshooting chapter.
| sudo zfs send -c data/ton-work@backup-date | ssh user@remote_host "sudo zfs recv remote_data/ton-work" | ||
| ``` | ||
|
|
||
| ### 5.4 Performing software updates |
There was a problem hiding this comment.
We already defined this in the beginning, but let's mention again that updates are announced in Telegram channels.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
To fix the formatting issues:
Alternatively, a maintainer can comment /fmt in this PR to auto-apply fixes in a new commit from the bot. |
Created a new guide for setting up an archive node in liteserver mode.