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:| Flag | What it does | Typical use |
|---|---|---|
-d, --dump | Downloads a packaged blockchain dump 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 <PATH>, --config <PATH> | Supplies a custom config.json for TON installer steps. | Use a vetted mirror instead of the default URL. |
-g <URL>, --node-repo <URL> | Points the TON node build to a different Git repository. | Test patched node sources or mirror Git access. |
-v <VERSION>, --node-version <VERSION> | Pins the TON node to a branch, tag, or commit. | Lock to a specific release when validating upgrades. |
-u <USER>, --user <USER> | Forces the operator account that owns MyTonCtrl. | Keep ownership correct when running the script from automation. |
-e <PATH>, --env-file <PATH> | Loads installer parameters (see below) from an env file. | Pre-seed values like ARCHIVE_TTL, shard lists, or ports for CI jobs. |
-a <AUTHOR>, --author <AUTHOR>-r <REPO>, --repo <REPO>-b <BRANCH>, --branch <BRANCH> | Override the Git source for MyTonCtrl and installer scripts. | Test forks or feature branches. |
-p <FILE>, --backup <FILE> | 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. |
-m and -p the installer in the interactive CLI, which prompts for network selection, telemetry, and mode enablement.
Environment variables
Set these variables before runninginstall.sh (for example, ARCHIVE_TTL=864000 sudo bash install.sh) to preconfigure node behavior:
| Variable | Effect | Notes |
|---|---|---|
ARCHIVE_TTL | Overrides the retention (in seconds) passed to --archive-ttl. | Defaults to 2592000 for liteserver mode and 86400 otherwise; set -1 for effectively permanent retention. |
STATE_TTL | Sets --state-ttl and shortens the archive TTL by the same amount. | Use with ARCHIVE_TTL to keep a smaller state cache. |
ADD_SHARD | Adds one or more --add-shard arguments. | Provide shard IDs separated by spaces (for example 0:2000000000000000 0:a000000000000000). |
ARCHIVE_BLOCKS | Downloads archive data via TON Storage during bootstrap. | Accepts a single block/UTC date or a range (<from> <to>); 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. |
Command reference
| Reference | What it covers |
|---|---|
| Core Commands | Everyday console operations: updating MyTonCtrl, enabling modes, viewing status, and managing settings. |
| Installer Commands | Running the MyTonInstaller module to configure node services, enable components, and adjust node arguments. |
| Wallet Commands | Creating, importing, exporting, and funding wallets managed by MyTonCtrl. |
| Validator Commands | Election voting, complaint handling, efficiency checks, and collator registry management for validators. |
| Collator Commands | Configuring collator shards, allowlists, and JSON options when operating in collator mode. |
| Pool Commands | Deploying and operating nominator pools or Orbs single-nominator pools. |
| Liquid Staking Commands | Managing liquid staking controllers, validator-set refreshes, and loan calculations. |
| Custom Overlay Commands | Adding, listing, and removing custom overlays for validator-console telemetry. |
| Utilities Commands | Account inspection, bookmark management, governance offer utilities, and validator list reporting. |
| Alerting Commands | Configuring the MyTonCtrl alert bot, toggling alert keys, and testing notifications. |
| Backups Commands | Creating and restoring configuration backups, including keyring exports. |
| BTC Teleport Commands | Reviewing Teleport proposals, voting, and uninstalling the Teleport bundle. |
Pick the right guide
- Provisioning a new node? Start with Setup MyTonCtrl and then use the Core and Installer references for ongoing maintenance.
- Operating pools or liquid staking? Combine the Pools or Liquid Staking guides with the relevant validator or wallet sections.
- Keeping eyes on production nodes? Review Alerting, Backups, and Utilities so you can monitor and recover your infrastructure quickly.