-
Notifications
You must be signed in to change notification settings - Fork 339
Added info run docker #611
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
reveloper
merged 12 commits into
ton-community:main
from
pixelplex:mytonctrl-run-docker
Aug 27, 2024
Merged
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
91e0a38
add info run in docker
SergeyAndreevPixel 63f3b43
change docker repository mytonctrl
SergeyAndreevPixel 6df7151
Merge branch 'main' into mytonctrl-run-docker
reveloper ca0c64f
Update docs/participate/run-nodes/run-docker.md
reveloper 1556597
Update docs/participate/run-nodes/run-docker.md
reveloper 77e3c3f
Update docs/participate/run-nodes/run-docker.md
reveloper 1911e15
Update docs/participate/run-nodes/run-docker.md
reveloper 5c79d59
Update docs/participate/run-nodes/run-docker.md
reveloper eae60df
Update docs/participate/run-nodes/run-docker.md
reveloper 7033d24
Update docs/participate/run-nodes/run-docker.md
reveloper f359216
Update docs/participate/run-nodes/run-docker.md
reveloper feb9527
Update docs/participate/run-nodes/run-docker.md
reveloper File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/pixelplex/ton-docker-ctrl.git | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
2. Go to directory | ||
```bash | ||
cd ./ton-docker-ctrl | ||
``` | ||
3. Indicate necessary values in the file .env | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```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. | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```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 | ||
``` | ||
 | ||
|
||
Reflects the list of accessible commands `help` | ||
```bash | ||
MyTonCtrl> help | ||
``` | ||
## Review of MyTonCtrl logs: | ||
```bash | ||
docker compose logs | ||
``` | ||
## Updates of MyTonCtrl and Ton: | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```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._" | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Update is done by means of the command update by indication of a necessary branch | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```bash | ||
MyTonCtrl> update mytonctrl2 | ||
``` | ||
## Change of data storage path: | ||
|
||
By default Ton and Mytoncore works are stored in **/var/lib/docker/volumes/** | ||
reveloper marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
You can change it in the file docker-compose.yml, by indicating the required route in **volumes** section |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.