From 91e0a38b99f2c25dd583b59004adab561d976c7e Mon Sep 17 00:00:00 2001 From: Sergey Andreev Date: Fri, 31 May 2024 15:57:25 +0300 Subject: [PATCH 01/11] add info run in docker --- docs/participate/README.md | 1 + docs/participate/run-nodes/run-docker.md | 118 +++++++++++++++++++++++ sidebars.js | 1 + 3 files changed, 120 insertions(+) create mode 100644 docs/participate/run-nodes/run-docker.md diff --git a/docs/participate/README.md b/docs/participate/README.md index 42b265e304..9ceaf53fa2 100644 --- a/docs/participate/README.md +++ b/docs/participate/README.md @@ -25,6 +25,7 @@ It is also meant to offer essential frameworks (explorers, wallets, TEPs) that a * [Discover Node Types in TON](/participate/nodes/node-types) * [Run your Full Node or Validator](/participate/run-nodes/full-node) * [TON Validator maintenance & security](/participate/nodes/node-maintenance-and-security) +* [Run MyTonCtrl in Docker](/participate/run-nodes/run-docker) ## Participate in TON Web3 diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md new file mode 100644 index 0000000000..47740191a1 --- /dev/null +++ b/docs/participate/run-nodes/run-docker.md @@ -0,0 +1,118 @@ +# Run MyTonCtrl in Docker + +## Hardware requirements: + +* 16 cores CPU +* 128 GB RAM +* 1TB NVME SSD OR Provisioned 64+k IOPS storage +* 1 Gbit/s network connectivity +* public IP address (fixed IP address) +* 16 TB/month traffic on peak load + +**_Not recommended!_** **_For testing purposes only!_** + +Variable **IGNORE_MINIMAL_REQS=true** turns off requirements verification of CPU/RAM. + +## Software requirements: + +* docker-ce +* docker-ce-cli +* containerd.io +* docker-buildx-plugin +* docker-compose-plugin + + _Installation guide in official [Docker](https://docs.docker.com/engine/install/)_ + +## Tested operational systems: + +* Ubuntu 20.04 +* Ubuntu 22.04 +* Ubuntu 24.04 +* Debian 11 +* Debian 12 + +## Installation and start MyTonCtrl: + +1. Clone the last version of the repository +```bash +git clone https://github.com/fmira21/ton-docker-ctrl.git +``` +2. Go to directory +```bash +cd ./ton-docker-ctrl +``` +3. Indicate necessary values in the file .env +```bash +vi .env +``` +4. Initiate assembling of docker image. There is done a compilation of the last version fift, validator-engine, lite-client, etc. Installation and initial setting of MyTonCtrl. +```bash +docker compose build ton-node +``` +5. Start of MyTonCtrl +```bash +docker compose up -d +``` +## Variables setting: + +Variables indicated in the file .env +* **GLOBAL_CONFIG_URL** - Network configs of TON Blockchain (default: [Testnet](https://ton.org/testnet-global.config.json)) +* **MYTONCTRL_VERSION** - Git branch from which MyTonCtrl assembled +* **TELEMETRY** - Enabling/Disabling telemetry +* **MODE** - Set MyTonCtrl in the indicated mode (validator or liteserver) +* **IGNORE_MINIMAL_REQS** - Ignore hardware requirements + +## Stop and delete MyTonCtrl: + +1. Stop container +```bash +docker compose stop +``` +2. Delete container +```bash +docker compose down +``` +3. Delete container with data +```bash +docker compose down --volumes +``` +## Connection to MyTonCtrl: +```bash +docker compose exec -it ton-node bash -c "mytonctrl" +``` +As soon as get connected it is possible to check the status by using the command `status` +```bash +MyTonCtrl> status +``` +![](https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/screens/mytonctrl-status.png) + +Reflects the list of accessible commands `help` +```bash +MyTonCtrl> help +``` +## Review of MyTonCtrl logs: +```bash +docker compose logs +``` +## Updates of MyTonCtrl and Ton: + +To get the last versions of TON validator and MyTonCtrl, it is necessary to go to catalogue with docker-compose.yml and make assembling +```bash +cd ./ton-docker-ctrl +docker compose build ton-node +``` +When over start docker compose again +```bash +docker compose up -d +``` +When connected to MyTonCtrl an auto verification in terms of updates is done. In case any detected there is a message displayed "_MyTonCtrl update available. Please update it with `update` command._" + +Update is done by means of the command update by indication of a necessary branch +```bash +MyTonCtrl> update mytonctrl2 +``` +## Change of data storage path: + +By default Ton and Mytoncore works are stored in **/var/lib/docker/volumes/** + +You can change it in the file docker-compose.yml, by indicating the required route in **volumes** section diff --git a/sidebars.js b/sidebars.js index c4e1e78db3..64b8925bfe 100644 --- a/sidebars.js +++ b/sidebars.js @@ -668,6 +668,7 @@ const sidebars = { //'participate/nodes/nodes-faq', 'participate/nodes/node-maintenance-and-security', 'participate/run-nodes/local-ton', + 'participate/run-nodes/run-docker', ], }, { From 63f3b434cd4ce9851e10597bd12a6d1f983fb930 Mon Sep 17 00:00:00 2001 From: Sergey Andreev Date: Wed, 12 Jun 2024 10:28:04 +0300 Subject: [PATCH 02/11] change docker repository mytonctrl --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index 47740191a1..54947d481e 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -35,7 +35,7 @@ Variable **IGNORE_MINIMAL_REQS=true** turns off requirements verification of CPU 1. Clone the last version of the repository ```bash -git clone https://github.com/fmira21/ton-docker-ctrl.git +git clone https://github.com/pixelplex/ton-docker-ctrl.git ``` 2. Go to directory ```bash From ca0c64f3de2749de9eaa9228c944e1a585f64c5d Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:54:30 +0900 Subject: [PATCH 03/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index 54947d481e..69bbd87f8c 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -94,7 +94,7 @@ MyTonCtrl> help ```bash docker compose logs ``` -## Updates of MyTonCtrl and Ton: +## Updates of MyTonCtrl and TON: To get the last versions of TON validator and MyTonCtrl, it is necessary to go to catalogue with docker-compose.yml and make assembling ```bash From 1556597bd63d7751e53109cf53f186d2743b3c3c Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:54:42 +0900 Subject: [PATCH 04/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index 69bbd87f8c..ab485821d6 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -113,6 +113,6 @@ MyTonCtrl> update mytonctrl2 ``` ## Change of data storage path: -By default Ton and Mytoncore works are stored in **/var/lib/docker/volumes/** +By default TON and Mytoncore works are stored in **/var/lib/docker/volumes/** You can change it in the file docker-compose.yml, by indicating the required route in **volumes** section From 77e3c3f50ef0add9815c0ae4e996013720607cd6 Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:54:55 +0900 Subject: [PATCH 05/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index ab485821d6..5b7fe0806f 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -35,7 +35,7 @@ Variable **IGNORE_MINIMAL_REQS=true** turns off requirements verification of CPU 1. Clone the last version of the repository ```bash -git clone https://github.com/pixelplex/ton-docker-ctrl.git +git clone https://github.com/ton-community/ton-docker-ctrl.git ``` 2. Go to directory ```bash From 1911e15e2a034e269d58e1db6c10c918d2c34d25 Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:55:03 +0900 Subject: [PATCH 06/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index 5b7fe0806f..1e9d210a7d 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -6,7 +6,7 @@ * 128 GB RAM * 1TB NVME SSD OR Provisioned 64+k IOPS storage * 1 Gbit/s network connectivity -* public IP address (fixed IP address) +* Public IP address (fixed IP address) * 16 TB/month traffic on peak load **_Not recommended!_** **_For testing purposes only!_** From 5c79d5987dfffb32f34c03047c193e8c27086b0a Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:55:11 +0900 Subject: [PATCH 07/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index 1e9d210a7d..1d60ba076b 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -41,7 +41,7 @@ git clone https://github.com/ton-community/ton-docker-ctrl.git ```bash cd ./ton-docker-ctrl ``` -3. Indicate necessary values in the file .env +3. Indicate the necessary values in the .env file ```bash vi .env ``` From eae60df1d425e68e125a2a7649b7a42fe7e07d89 Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:56:34 +0900 Subject: [PATCH 08/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index 1d60ba076b..b16f15469d 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -45,7 +45,7 @@ cd ./ton-docker-ctrl ```bash vi .env ``` -4. Initiate assembling of docker image. There is done a compilation of the last version fift, validator-engine, lite-client, etc. Installation and initial setting of MyTonCtrl. +4. Initiate assembling of docker image. This step involves the compilation of the latest versions of fift, validator-engine, lite-client, etc., as well as the installation and initial setup of MyTonCtrl. ```bash docker compose build ton-node ``` From 7033d2432bff22f36d311114bad4fae11d261339 Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:56:44 +0900 Subject: [PATCH 09/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index b16f15469d..b83beaca17 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -101,7 +101,7 @@ To get the last versions of TON validator and MyTonCtrl, it is necessary to go t cd ./ton-docker-ctrl docker compose build ton-node ``` -When over start docker compose again +Once finished, start Docker Compose again ```bash docker compose up -d ``` From f3592167c05968e8c770e09895f1cb4ce20de359 Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:56:52 +0900 Subject: [PATCH 10/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index b83beaca17..9ae832e947 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -105,7 +105,7 @@ Once finished, start Docker Compose again ```bash docker compose up -d ``` -When connected to MyTonCtrl an auto verification in terms of updates is done. In case any detected there is a message displayed "_MyTonCtrl update available. Please update it with `update` command._" +When connected to MyTonCtrl, an automatic verification for updates is performed. If any updates are detected, a message is displayed"_MyTonCtrl update available. Please update it with `update` command._" Update is done by means of the command update by indication of a necessary branch ```bash From feb9527578fda356a6368e10d05909623f85fdc3 Mon Sep 17 00:00:00 2001 From: AlexG <39581753+reveloper@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:56:57 +0900 Subject: [PATCH 11/11] Update docs/participate/run-nodes/run-docker.md Co-authored-by: Dr. Awesome Doge --- docs/participate/run-nodes/run-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/participate/run-nodes/run-docker.md b/docs/participate/run-nodes/run-docker.md index 9ae832e947..3e136f6b72 100644 --- a/docs/participate/run-nodes/run-docker.md +++ b/docs/participate/run-nodes/run-docker.md @@ -107,7 +107,7 @@ docker compose up -d ``` When connected to MyTonCtrl, an automatic verification for updates is performed. If any updates are detected, a message is displayed"_MyTonCtrl update available. Please update it with `update` command._" -Update is done by means of the command update by indication of a necessary branch +Update is done using the update command by specifying the necessary branch ```bash MyTonCtrl> update mytonctrl2 ```