Skip to content

Commit

Permalink
move mtc backup to guidelines (ton-community#906)
Browse files Browse the repository at this point in the history
  • Loading branch information
yungwine authored Dec 30, 2024
1 parent 55af0cc commit df332ce
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
MyTonCtrl allows users to create and restore node configuration backups with two simple, easy-to-use commands. This feature allows node operations to quickly and efficiently transfer node configuration from one host to another.

### Manually create backup package
# Manual backup creation is initialized with the `create_backup` command, the backup creation process should not take more than a few seconds.
Manual backup creation is initialized with the `create_backup` command, the backup creation process should not take more than a few seconds.

MyTonCtrl will create a backup package in the home directory of the MyTonCtrl user, the package name will include the hostname as well as the epoch timestamp of the backup.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ In order to transfer validation duties from the main node to the standby node, o
* up-to-date node configuration file and keyring
* keys required for MyTonCtrl functionality

MyTonCtrl provides functionality to [create backups](mytonctrl-backup-restore) that contain all required data. If you are running a validator node, we strongly recommend that you set up [automated backups](mytonctrl-backup-restore#automated-backup-creation) and download backup archives from your machine frequently.
MyTonCtrl provides functionality to [create backups](mytonctrl-backup-restore.md) that contain all required data. If you are running a validator node, we strongly recommend that you set up [automated backups](mytonctrl-backup-restore.md#automated-backup-creation) and download backup archives from your machine frequently.

## Restore
Before transferring the validator configuration to the standby machine, please ensure that you have stopped / disabled the TON node on the donor machine for ~20 minutes. Failure to do so will result in connectivity issues and crashes on both the donor and target machines.

The restore process is [described in Backups](mytonctrl-backup-restore)
The restore process is [described in Backups](mytonctrl-backup-restore.md)

Please ensure that you create and retain the backup of your standby node original configuration before you apply/restore a backup package from another machine, as you will need this to bring the standby node back into standby mode.

Expand Down
2 changes: 0 additions & 2 deletions sidebars/documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,6 @@ module.exports = [
'v3/documentation/infra/nodes/mytonctrl/mytonctrl-alerting',
'v3/documentation/infra/nodes/mytonctrl/mytonctrl-status',
'v3/documentation/infra/nodes/mytonctrl/mytonctrl-errors',
'v3/documentation/infra/nodes/mytonctrl/mytonctrl-backup-restore',
'v3/documentation/infra/nodes/mytonctrl/mytonctrl-validator-standby',
],
},
'v3/documentation/infra/nodes/node-commands',
Expand Down
8 changes: 8 additions & 0 deletions sidebars/guidelines.js
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,14 @@ module.exports = [
'v3/guidelines/nodes/running-nodes/secure-guidelines',
],
},
{
type: 'category',
label: 'Maintenance Guidelines',
items: [
'v3/guidelines/nodes/maintenance-guidelines/mytonctrl-backup-restore',
'v3/guidelines/nodes/maintenance-guidelines/mytonctrl-validator-standby',
],
},
'v3/guidelines/nodes/custom-overlays',
'v3/guidelines/nodes/nodes-troubleshooting',
'v3/guidelines/nodes/node-maintenance-and-security',
Expand Down

0 comments on commit df332ce

Please sign in to comment.