From fe4e1844ea3951cc8ecc2b78b2d229a0114f94c3 Mon Sep 17 00:00:00 2001 From: Vladimir Lebedev Date: Tue, 25 Nov 2025 16:48:08 +0300 Subject: [PATCH 1/6] feat: improve mytonctrl overview --- ecosystem/node/mytonctrl/overview.mdx | 50 +++++++++++++-------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/ecosystem/node/mytonctrl/overview.mdx b/ecosystem/node/mytonctrl/overview.mdx index d9659c9e2..6a6bcbc9f 100644 --- a/ecosystem/node/mytonctrl/overview.mdx +++ b/ecosystem/node/mytonctrl/overview.mdx @@ -1,8 +1,9 @@ --- title: "Overview" -description: "MyTonCtrl exposes a modular CLI that bundles day-to-day node maintenance, staking workflows, and operational tooling. Use this overview to decide which command reference you need for a specific task." --- +MyTonCtrl is a tool to run and maintain a TON node (validators and liteservers). + ## Install MyTonCtrl Run the installer as the non-root operator who will manage the node. The command below fetches dependencies, downloads the script, and starts the interactive setup wizard: @@ -11,32 +12,35 @@ Run the installer as the non-root operator who will manage the node. The command sudo apt update sudo apt install -y curl wget git ca-certificates python3-pip wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh -sudo bash install.sh -d +sudo bash install.sh ``` The wizard walks you through hardware validation, TON binary installs, and MyTonCtrl configuration. Use flags to pre-select options or automate deployments: | Flag | What it does | Typical use | | ----------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------- | -| `-d` | Downloads a packaged blockchain dump before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | -| `-m validator`, `-m liteserver` | Pre-enables the target mode. | Skip switching modes manually after install. | -| `-n mainnet`, `-n testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | -| `-t` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | -| `-i` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | -| `-c ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | -| `-v ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | -| `-u ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | -| `-a `, `-r `, `-b ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | -| `-p ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | -| `-o` | Install only MyTonCtrl assets (requires `-p`). | Recover the console without touching TON binaries. | -| `-l` | Install only the TON node binaries and services. | Pair a fresh node with an already configured MyTonCtrl. | -| `-h` | Prints installer help and exits. | Basic check of available options. | - -Leaving out `-m` and `-p` keeps you in the interactive CLI (`install.py`), which prompts for network selection, telemetry, and mode enablement. +| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | +| `-m`, `--mode validator|liteserver|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | +| `-n`, `--network mainnet|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | +| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | +| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | +| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | +| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | +| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | +| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | +| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | +| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | +| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | +| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | +| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | +| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | +| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | + +Leaving out `-m` and `-p` keeps you in the interactive CLI, which prompts for network selection, telemetry, and mode enablement. ### Environment variables -Set these variables before running `install.sh` (for example, `ARCHIVE_TTL=864000 sudo bash install.sh -d`) to preconfigure node behavior: +Set these variables before running `install.sh` (for example, `ARCHIVE_TTL=864000 sudo bash install.sh`) to preconfigure node behavior: | Variable | Effect | Notes | | ---------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | @@ -46,15 +50,9 @@ Set these variables before running `install.sh` (for example, `ARCHIVE_TTL=86400 | `ARCHIVE_BLOCKS` | Downloads archive data via TON Storage during bootstrap. | Accepts a single block/UTC date or a range (` `); dates must be `YYYY-MM-DD`. | | `COLLATE_SHARD` | Configures collator shards during `collator` mode installs. | Space-separated shard IDs; defaults to `0:8000000000000000` if unset. | -## Operational notes - -- All guides assume you are running the interactive `mytonctrl` console on a node where the relevant mode is enabled (`enable_mode `). -- Many commands trigger privileged scripts (systemd, file writes, package installs). Run them from an account that can escalate with `sudo` or the original installation user. -- Keep validator wallets, ADNL keys, and configuration backups safe before applying destructive actions (disabling modes, removing Teleport, restoring archives, etc.). - -## Command guide index +## Command reference -| Guide | What it Covers | +| Reference | What it covers | | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | [Core Commands](/ecosystem/node/mytonctrl/core) | Everyday console operations: updating MyTonCtrl, enabling modes, viewing status, and managing settings. | | [Installer Commands](/ecosystem/node/mytonctrl/installer) | Running the MyTonInstaller module to configure node services, enable components, and adjust node arguments. | From 8149720b42484399e69d0a9f88324123482d4dda Mon Sep 17 00:00:00 2001 From: Vladimir Lebedev Date: Tue, 25 Nov 2025 16:52:52 +0300 Subject: [PATCH 2/6] fix: remark --- ecosystem/node/mytonctrl/overview.mdx | 38 +++++++++++++-------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/ecosystem/node/mytonctrl/overview.mdx b/ecosystem/node/mytonctrl/overview.mdx index 6a6bcbc9f..7f5ea3975 100644 --- a/ecosystem/node/mytonctrl/overview.mdx +++ b/ecosystem/node/mytonctrl/overview.mdx @@ -17,24 +17,24 @@ sudo bash install.sh The wizard walks you through hardware validation, TON binary installs, and MyTonCtrl configuration. Use flags to pre-select options or automate deployments: -| Flag | What it does | Typical use | -| ----------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------- | -| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | -| `-m`, `--mode validator|liteserver|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | -| `-n`, `--network mainnet|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | -| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | -| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | -| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | -| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | -| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | -| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | -| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | -| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | -| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | -| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | -| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | -| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | -| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | +| Flag | What it does | Typical use | | | +| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------- | +| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | | | +| `-m`, \`--mode validator | liteserver | collator\` | Pre-enables the target mode. | Skip switching modes manually after install. | +| `-n`, \`--network mainnet | testnet\` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | | +| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | | | +| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | | | +| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | | | +| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | | | +| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | | | +| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | | | +| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | | | +| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | | | +| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | | | +| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | | | +| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | | | +| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | | | +| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | | | Leaving out `-m` and `-p` keeps you in the interactive CLI, which prompts for network selection, telemetry, and mode enablement. @@ -52,7 +52,7 @@ Set these variables before running `install.sh` (for example, `ARCHIVE_TTL=86400 ## Command reference -| Reference | What it covers | +| Reference | What it covers | | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | [Core Commands](/ecosystem/node/mytonctrl/core) | Everyday console operations: updating MyTonCtrl, enabling modes, viewing status, and managing settings. | | [Installer Commands](/ecosystem/node/mytonctrl/installer) | Running the MyTonInstaller module to configure node services, enable components, and adjust node arguments. | From 6b07b7cbeec7661057a14ef0a2780ee220840152 Mon Sep 17 00:00:00 2001 From: Vladimir Lebedev Date: Tue, 25 Nov 2025 16:54:42 +0300 Subject: [PATCH 3/6] fix: formatting --- ecosystem/node/mytonctrl/overview.mdx | 38 +++++++++++++-------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/ecosystem/node/mytonctrl/overview.mdx b/ecosystem/node/mytonctrl/overview.mdx index 7f5ea3975..92b94d580 100644 --- a/ecosystem/node/mytonctrl/overview.mdx +++ b/ecosystem/node/mytonctrl/overview.mdx @@ -17,24 +17,24 @@ sudo bash install.sh The wizard walks you through hardware validation, TON binary installs, and MyTonCtrl configuration. Use flags to pre-select options or automate deployments: -| Flag | What it does | Typical use | | | -| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------- | -| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | | | -| `-m`, \`--mode validator | liteserver | collator\` | Pre-enables the target mode. | Skip switching modes manually after install. | -| `-n`, \`--network mainnet | testnet\` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | | -| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | | | -| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | | | -| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | | | -| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | | | -| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | | | -| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | | | -| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | | | -| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | | | -| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | | | -| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | | | -| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | | | -| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | | | -| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | | | +| Flag | What it does | Typical use | +| ----------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------- | +| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | +| `-m`, `--mode validator\|liteserver\|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | +| `-n`, `--network mainnet\|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | +| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | +| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | +| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | +| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | +| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | +| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | +| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | +| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | +| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | +| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | +| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | +| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | +| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | Leaving out `-m` and `-p` keeps you in the interactive CLI, which prompts for network selection, telemetry, and mode enablement. @@ -52,7 +52,7 @@ Set these variables before running `install.sh` (for example, `ARCHIVE_TTL=86400 ## Command reference -| Reference | What it covers | +| Reference | What it covers | | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | [Core Commands](/ecosystem/node/mytonctrl/core) | Everyday console operations: updating MyTonCtrl, enabling modes, viewing status, and managing settings. | | [Installer Commands](/ecosystem/node/mytonctrl/installer) | Running the MyTonInstaller module to configure node services, enable components, and adjust node arguments. | From eb07de37a694a08fbbc3dc5c1bdcea01760f9d54 Mon Sep 17 00:00:00 2001 From: Vladimir Lebedev Date: Tue, 25 Nov 2025 16:55:06 +0300 Subject: [PATCH 4/6] fix: remark --- ecosystem/node/mytonctrl/overview.mdx | 38 +++++++++++++-------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/ecosystem/node/mytonctrl/overview.mdx b/ecosystem/node/mytonctrl/overview.mdx index 92b94d580..bd165bc28 100644 --- a/ecosystem/node/mytonctrl/overview.mdx +++ b/ecosystem/node/mytonctrl/overview.mdx @@ -17,24 +17,24 @@ sudo bash install.sh The wizard walks you through hardware validation, TON binary installs, and MyTonCtrl configuration. Use flags to pre-select options or automate deployments: -| Flag | What it does | Typical use | -| ----------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------- | -| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | -| `-m`, `--mode validator\|liteserver\|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | -| `-n`, `--network mainnet\|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | -| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | -| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | -| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | -| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | -| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | -| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | -| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | -| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | -| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | -| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | -| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | -| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | -| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | +| Flag | What it does | Typical use | +| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | +| `-m`, `--mode validator\|liteserver\|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | +| `-n`, `--network mainnet\|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | +| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | +| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | +| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | +| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | +| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | +| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | +| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | +| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | +| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | +| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | +| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | +| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | +| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | Leaving out `-m` and `-p` keeps you in the interactive CLI, which prompts for network selection, telemetry, and mode enablement. @@ -52,7 +52,7 @@ Set these variables before running `install.sh` (for example, `ARCHIVE_TTL=86400 ## Command reference -| Reference | What it covers | +| Reference | What it covers | | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | [Core Commands](/ecosystem/node/mytonctrl/core) | Everyday console operations: updating MyTonCtrl, enabling modes, viewing status, and managing settings. | | [Installer Commands](/ecosystem/node/mytonctrl/installer) | Running the MyTonInstaller module to configure node services, enable components, and adjust node arguments. | From 111a1bb7a9b7261e78994d2f2642bea804fadccc Mon Sep 17 00:00:00 2001 From: Vladimir Lebedev Date: Tue, 25 Nov 2025 21:59:34 +0300 Subject: [PATCH 5/6] fix: style --- ecosystem/node/mytonctrl/overview.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ecosystem/node/mytonctrl/overview.mdx b/ecosystem/node/mytonctrl/overview.mdx index bd165bc28..a47fbdb5c 100644 --- a/ecosystem/node/mytonctrl/overview.mdx +++ b/ecosystem/node/mytonctrl/overview.mdx @@ -19,7 +19,7 @@ The wizard walks you through hardware validation, TON binary installs, and MyTon | Flag | What it does | Typical use | | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speed up the initial sync (omit if you prefer to sync from peers only). | +| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speeds up the initial sync (omit to sync from peers only). | | `-m`, `--mode validator\|liteserver\|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | | `-n`, `--network mainnet\|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | | `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | @@ -33,10 +33,10 @@ The wizard walks you through hardware validation, TON binary installs, and MyTon | `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | | `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | | `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | -| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-run your CLI answers before performing a real install. | +| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-runs CLI answers before performing a real install. | | `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | -Leaving out `-m` and `-p` keeps you in the interactive CLI, which prompts for network selection, telemetry, and mode enablement. +Leaving out `-m` and `-p` the installer in the interactive CLI, which prompts for network selection, telemetry, and mode enablement. ### Environment variables From 970b5726036a4ce881ad5adbeed56f31aef9b39d Mon Sep 17 00:00:00 2001 From: Vladimir Lebedev Date: Thu, 27 Nov 2025 15:56:13 +0300 Subject: [PATCH 6/6] fix: formatting --- ecosystem/node/mytonctrl/overview.mdx | 36 +++++++++++++-------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/ecosystem/node/mytonctrl/overview.mdx b/ecosystem/node/mytonctrl/overview.mdx index a47fbdb5c..b3641f3a5 100644 --- a/ecosystem/node/mytonctrl/overview.mdx +++ b/ecosystem/node/mytonctrl/overview.mdx @@ -17,24 +17,24 @@ sudo bash install.sh The wizard walks you through hardware validation, TON binary installs, and MyTonCtrl configuration. Use flags to pre-select options or automate deployments: -| Flag | What it does | Typical use | -| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speeds up the initial sync (omit to sync from peers only). | -| `-m`, `--mode validator\|liteserver\|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | -| `-n`, `--network mainnet\|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | -| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | -| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | -| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | -| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | -| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | -| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | -| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | -| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | -| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | -| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | -| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | -| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-runs CLI answers before performing a real install. | -| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | +| Flag | What it does | Typical use | +| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `-d`, `--dump` | Downloads a [packaged blockchain dump](https://dumps.ton.org) before first start. | Speeds up the initial sync (omit to sync from peers only). | +| `-m`, `--mode validator\|liteserver\|collator` | Pre-enables the target mode. | Skip switching modes manually after install. | +| `-n`, `--network mainnet\|testnet` | Switches global config URL and minimum hardware thresholds. | Point the node to testnet without editing configs later. | +| `-t`, `--telemetry` | Disables telemetry uploads during install. | Comply with policies that forbid sharing validator stats. | +| `-i`, `--ignore-reqs` | Ignores the CPU/RAM minimum check. | Lab hardware or cloud instances that fall below defaults. | +| `-c `, `--config ` | Supplies a custom `config.json` for TON installer steps. | Use a vetted mirror instead of the default URL. | +| `-g `, `--node-repo ` | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. | +| `-v `, `--node-version ` | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. | +| `-u `, `--user ` | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. | +| `-e `, `--env-file ` | Loads installer parameters (see below) from an env file. | Pre-seed values like `ARCHIVE_TTL`, shard lists, or ports for CI jobs. | +| `-a `, `--author `
`-r `, `--repo `
`-b `, `--branch ` | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. | +| `-p `, `--backup ` | Restore from a MyTonCtrl backup archive. | Reinstall on fresh hardware using an existing backup. | +| `-o`, `--only-mtc` | Install only MyTonCtrl assets (requires `-p`). | Use to interact with a node remotely. | +| `-l`, `--only-node` | Install only the TON node binaries and services. | Pair a fresh node with an existing MyTonCtrl instance elsewhere. | +| `--print-env` | Prints the resolved install command and env values, then exits. | Dry-runs CLI answers before performing a real install. | +| `-h`, `--help` | Prints installer help and exits. | Basic check of available options. | Leaving out `-m` and `-p` the installer in the interactive CLI, which prompts for network selection, telemetry, and mode enablement.