Skip to content

Commit 3b7697d

Browse files
gkaravatskigkaravatski
committed
add FAQ from mytonctrl rep
1 parent b057a3e commit 3b7697d

File tree

6 files changed

+154
-15
lines changed

6 files changed

+154
-15
lines changed

‎docs/participate/run-nodes/faq.mdx

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# FAQ
2+
3+
## MyTonCtrl Directory Usage
4+
5+
MyTonCtrl is a wrapper that stores its files in two places:
6+
7+
1. `~/.local/share/mytonctrl/` - Long-term files such as logs are stored here.
8+
2. `/tmp/mytonctrl/` - Temporary files are stored here.
9+
10+
MyTonCtrl also includes another script, mytoncore, which in turn stores files in the following locations:
11+
12+
1. `~/.local/share/mytoncore/` - Permanent files, the main configuration will be stored here.
13+
2. `/tmp/mytoncore/` - Temporary files, parameters used for elections will be saved here.
14+
15+
MyTonCtrl downloads the source code for itself and the validator into the following directories:
16+
17+
1. `/usr/src/mytonctrl/`
18+
2. `/usr/src/ton/`
19+
20+
MyTonCtrl compiles the validator components into the following directory:
21+
22+
1. `/usr/bin/ton/`
23+
24+
MyTonCtrl creates a working directory for the validator here:
25+
26+
1. `/var/ton/`
27+
28+
---
29+
30+
## If MyTonCtrl was installed as root
31+
32+
The configurations will be stored differently:
33+
34+
1. `/usr/local/bin/mytonctrl/`
35+
2. `/usr/local/bin/mytoncore/`
36+
37+
---
38+
39+
## How to remove MyTonCtrl
40+
41+
Run the script as an administrator and remove the compiled TON components:
42+
43+
```bash
44+
sudo bash /usr/src/mytonctrl/scripts/uninstall.sh
45+
sudo rm -rf /usr/bin/ton
46+
```
47+
48+
During this process, ensure you have sufficient permissions to delete or modify these files or directories.
49+
50+
51+
## Directory Changes with MyTonCtrl
52+
53+
### Changing Validator Working Directory Pre-installation
54+
55+
If you wish to change the working directory of the validator prior to installation, there are two ways to do so:
56+
57+
1. **Fork the project** - You can fork the project and make your changes there. Learn how to fork a project with `man git-fork`.
58+
2. **Create a symbolic link** - You can also create a symbolic link with the following command:
59+
60+
```bash
61+
ln -s /opt/ton/var/ton
62+
```
63+
This command will create a link `/var/ton` that points to `/opt/ton`.
64+
65+
### Changing Validator Working Directory Post-installation
66+
67+
If you want to change the working directory of the validator from `/var/ton/` after installation, perform the following steps:
68+
69+
1. **Stop services** - You will need to stop the services with these commands:
70+
71+
```bash
72+
systemctl stop validator.service
73+
systemctl stop mytoncore.service
74+
```
75+
76+
2. **Move validator files** - You then need to move the validator files with this command:
77+
78+
```bash
79+
mv /var/ton/* /opt/ton/
80+
```
81+
82+
3. **Update configuration paths** - Replace the paths in the configuration located at `~/.local/share/mytoncore/mytoncore.db`.
83+
84+
4. **Note on experience** - There is no prior experience with such a transfer, so consider this when moving forward.
85+
86+
Remember to make sure you have sufficient permissions to make these changes or run these commands.
87+
88+
## Understanding Validator Status and Restarting Validator in MyTonCtrl
89+
90+
This document will help you understand how to confirm if MyTonCtrl has become a full validator and how to restart your validator.
91+
92+
## Restarting Your Validator
93+
94+
If you need to restart your validator, you can do so by running the following command:
95+
96+
```bash
97+
systemctl restart validator.service
98+
```
99+
100+
Ensure you have sufficient permissions to execute these commands and make necessary adjustments. Always remember to back up important data before performing operations that could potentially affect your validator.
101+
102+
## See Also
103+
104+
* [Troubleshooting](/participate/run-nodes/nodes-troubleshooting)

‎docs/participate/run-nodes/full-node.mdx

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,10 @@ import TabItem from '@theme/TabItem';
33

44
# Full Node
55

6-
:::caution MyTonCtrl requires terminal restarting
7-
if you get error without visible reason, ***like [Validator is not settings](/participate/run-nodes/nodes-troubleshooting#validator-console-is-not-settings) even from owner***, try to restart terminal
6+
:::caution [MyTonCtrl](/participate/run-nodes/mytonctrl) requires terminal restarting
7+
If you get an error without visible reason, ***like [Validator is not settings](/participate/run-nodes/nodes-troubleshooting#validator-console-is-not-settings) even from owner***, try to restart terminal
88
:::
99

10-
:::caution Node usage on personal local machine
11-
You shouldn't run any type of node on your personal local machine for long, even if it is satisfy the requirements. Nodes actively use disks and can damage them fast.
12-
:::
13-
14-
To install and manage your own node, use the **MyTonCtrl** open-source tool developed by the TON Foundation. The majority of TON Nodes are reliable and tested by **MyTonCtrl**.
15-
16-
[MyTonCtrl](https://github.com/ton-blockchain/mytonctrl) is a console application that is a convenient wrapper for fift, lite-client, and validator-engine-console. It has been specifically developed to streamline wallet, domain, and validator management tasks on the Linux operating system.
17-
18-
Actually, there is [MyTonCtrl2](https://github.com/ton-blockchain/mytonctrl/tree/mytonctrl2) with a lot of improvements ([single nominator pool](/participate/network-maintenance/single-nominator), more checks, etc.). But now it is under development and can be unstable.
19-
20-
We are actively seeking feedback about the installation process. If you have any questions or suggestions, please [contact us](https://t.me/Alexgton).
21-
2210
## OS requirements
2311

2412
We highly recommend installing MyTonCtrl using the supported operating systems:
@@ -28,6 +16,10 @@ We highly recommend installing MyTonCtrl using the supported operating systems:
2816

2917
## Hardware requirements
3018

19+
:::caution Node usage on personal local machine
20+
You shouldn't run any type of node on your personal local machine for long, even if it is satisfy the requirements. Nodes actively use disks and can damage them fast.
21+
:::
22+
3123
### With validator
3224

3325
- 16 cores CPU

‎docs/participate/run-nodes/mytonctrl.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# MyTonCtrl
2+
3+
## Overview
4+
5+
To install and manage your own node, use the **MyTonCtrl** open-source tool developed by the TON Foundation. The majority of TON Nodes are reliable and tested by **MyTonCtrl**.
6+
7+
[MyTonCtrl](https://github.com/ton-blockchain/mytonctrl) is a console application that is a convenient wrapper for fift, lite-client, and validator-engine-console. It has been specifically developed to streamline wallet, domain, and validator management tasks on the Linux operating system.
8+
9+
Actually, there is [MyTonCtrl2](https://github.com/ton-blockchain/mytonctrl/tree/mytonctrl2) with a lot of improvements ([single nominator pool](/participate/network-maintenance/single-nominator), more checks, etc.). But now it is under development and can be unstable.
10+
11+
We are actively seeking feedback about the installation process. If you have any questions or suggestions, please [contact us](https://t.me/Alexgton).
12+
13+
14+
15+
16+
## See Also
17+
18+
* [FAQ](/participate/run-nodes/faq)
19+
* [Troubleshooting](/participate/run-nodes/nodes-troubleshooting)

‎docs/participate/run-nodes/nodes-troubleshooting.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ mytonctrl
5151
```
5252
:::
5353

54+
###Running MyTonCtrl as Different User
55+
56+
Running MyTonCtrl as a different user may trigger the following error:
57+
58+
```bash
59+
Error: expected str, bytes or os.PathLike object, not NoneType
60+
```
61+
62+
To resolve this, you should run MyTonCtrl as the user who installed it.
63+
5464
## What does "block is not applied" mean?
5565

5666
__Q:__ Sometimes we get `block is not applied` or `block is not ready` for various requests - is this normal?
@@ -145,4 +155,8 @@ The best way (while the penalty for temporary non-validation is small, it can be
145155

146156
```bash
147157
cp var/ton-work/db/config.json var/ton-work/db/config.json.backup
148-
```
158+
```
159+
160+
## See Also
161+
162+
* [MyTonCtrl FAQ](/participate/run-nodes/faq)

‎docusaurus.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,10 @@ const config = {
361361
position: 'left',
362362
label: 'Nodes',
363363
items: [
364+
{
365+
to: '/participate/run-nodes/mytonctrl',
366+
label: 'MyTonCtrl',
367+
},
364368
{
365369
to: '/participate/nodes/node-types',
366370
label: 'Node Types',
@@ -393,6 +397,10 @@ const config = {
393397
to: '/participate/network-maintenance/vesting-contract',
394398
label: 'Vesting Contract',
395399
},
400+
{
401+
to: '/participate/run-nodes/faq',
402+
label: 'FAQ',
403+
},
396404
],
397405
},
398406
{

‎sidebars.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,7 @@ const sidebars = {
660660
label: 'Blockchain Nodes',
661661
items: [
662662
'participate/nodes/node-types',
663+
'participate/run-nodes/mytonctrl',
663664
'participate/run-nodes/full-node',
664665
'participate/run-nodes/enable-liteserver-node',
665666
'participate/run-nodes/become-validator',
@@ -669,6 +670,7 @@ const sidebars = {
669670
//'participate/nodes/nodes-faq',
670671
'participate/nodes/node-maintenance-and-security',
671672
'participate/run-nodes/local-ton',
673+
'participate/run-nodes/faq',
672674
],
673675
},
674676
{

0 commit comments

Comments
 (0)