ton-blockchain · igroman787 · Jun 20, 2023 · Jun 1, 2023 · Jun 1, 2023 · Jun 4, 2023
diff --git a/README.Ru.md b/README.Ru.md
@@ -1,6 +1,6 @@
 ## Что это
 Данная консольная программа является оберткой над `fift`, `lite-client` и `validator-engine-console`. Она была создана для облегчения управления кошельками, доменами и валидатором на операционной системе `Linux`.
-![](https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/screens/mytonctrl-status_ru.png)
+![](screens/mytonctrl-status_ru.png)
 
 ## Функционал
 - [x] Показать статус сети TON
@@ -42,14 +42,16 @@
 	- [x] Отправлять статистику валидатора на https://toncenter.com
 
 ## Список проверенных операционных систем
-```
-Ubuntu 16.04 LTS (Xenial Xerus) - Error: TON compilation error
-Ubuntu 18.04 LTS (Bionic Beaver) - OK
-Ubuntu 20.04 LTS (Focal Fossa) - OK
-Debian 8 - Error: Unable to locate package libgsl-dev
-Debian 9 - Error: TON compilation error
-Debian 10 - OK
-```
+| Operating System              | Status                     |
+|-------------------------------|----------------------------|
+| Ubuntu 16.04 LTS (Xenial Xerus) | Error: TON compilation error |
+| Ubuntu 18.04 LTS (Bionic Beaver) | OK                       |
+| Ubuntu 20.04 LTS (Focal Fossa) | OK                       |
+| Ubuntu 22.04 LTS (Jammy Jellyfish) | OK                   |
+| Debian 8 | Error: Unable to locate package libgsl-dev   |
+| Debian 9 | Error: TON compilation error                 |
+| Debian 10 | OK                                         |
+
 
 ## Описание установочных скриптов
 - `toninstaller.sh` - Данный скрипт клонирует исходники `TON` и `mytonctrl` в папки `/usr/src/ton` и `/usr/src/mytonctrl`, компилирует программы из исходников и прописывает их в `/usr/bin/`.

diff --git a/README.md b/README.md
@@ -1,11 +1,34 @@
-[Данный текст доступен на русском языке.](https://github.com/ton-blockchain/mytonctrl/blob/master/README.Ru.md)
+![GitHub stars](https://img.shields.io/github/stars/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub forks](https://img.shields.io/github/forks/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub issues](https://img.shields.io/github/issues/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub pull requests](https://img.shields.io/github/issues-pr/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub last commit](https://img.shields.io/github/last-commit/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub license](https://img.shields.io/github/license/ton-blockchain/mytonctrl?style=flat-square&logo=github)
 
-## What is it?
-This console is a wrapper over `fift`,`lite-client` and `validator-engine-console`. It was created to facilitate wallet, domain and validator management on Linux OS.
+<!-- omit from toc --> 
+# MytTonCtrl
+[Данный текст доступен на русском языке.](README.Ru.md)
 
-![](https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/screens/mytonctrl-status.png)
+<!-- omit from toc --> 
+## Contents
 
-## Functionality
+- [What is MytTonCtrl?](#what-is-myttonctrl)
+- [Functionality](#functionality)
+	- [List of tested operating systems](#list-of-tested-operating-systems)
+- [Installation](#installation)
+	- [Installation scripts overview](#installation-scripts-overview)
+	- [Installation modes](#installation-modes)
+	- [Installation for Ubuntu](#installation-for-ubuntu)
+	- [Installation for Debian](#installation-for-debian)
+- [MyTonCtrl Documentation](#mytonctrl-documentation)
+- [Telemetry](#telemetry)
+- [MyTonCtrl installer mode](#mytonctrl-installer-mode)
+	- [Web admin panel](#web-admin-panel)
+	- [Local copy of toncenter](#local-copy-of-toncenter)
+- [Useful links](#useful-links)
+
+
+# What is MytTonCtrl?
+MyTonCtrl is a console application that serves as 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.
+
+![MyTonCtrl Status](screens/mytonctrl-status.png)
+
+# Functionality
 - [x] Show TON network status
 - [x] Management of local wallets
 	- [x] Create local wallet
@@ -45,48 +68,61 @@ This console is a wrapper over `fift`,`lite-client` and `validator-engine-consol
 	- [x] Send validator statistics to https://toncenter.com
 
 ## List of tested operating systems
-```
-Ubuntu 16.04 LTS (Xenial Xerus) - Error: TON compilation error
-Ubuntu 18.04 LTS (Bionic Beaver) - OK
-Ubuntu 20.04 LTS (Focal Fossa) - OK
-Debian 8 - Error: Unable to locate package libgsl-dev
-Debian 9 - Error: TON compilation error
-Debian 10 - OK
-```
-
+| Operating System              | Status                     |
+|-------------------------------|----------------------------|
+| Ubuntu 16.04 LTS (Xenial Xerus) | Error: TON compilation error |
+| Ubuntu 18.04 LTS (Bionic Beaver) | OK                       |
+| Ubuntu 20.04 LTS (Focal Fossa) | OK                       |
+| Ubuntu 22.04 LTS (Jammy Jellyfish) | OK                   |
+| Debian 8 | Error: Unable to locate package libgsl-dev   |
+| Debian 9 | Error: TON compilation error                 |
+| Debian 10 | OK                                         |
+
+# Installation
 ## Installation scripts overview
 - `toninstaller.sh`: clones `TON` and` mytonctrl` sources to `/usr/src/ton` and`/usr/src/mytonctrl` folders, compiles programs from sources and writes them to `/usr/bin/`.
 - `mytoninstaller.py`: configures the validator and `mytonctrl`; generates validator connection keys.
 
 ## Installation modes
-There are two installation modes: `lite` and` full`. They both **compile** and install `TON` components. However the `lite` version does not configure or run the node/validator.
+There are two installation modes: `lite` and`full`. They both **compile** and install `TON` components. However the `lite` version does not configure or run the node/validator.
 
 ## Installation for Ubuntu
 1. Download and execute the `install.sh` script in the desired installation mode. During installation the script prompts you for the superuser password several times.
-```sh
-wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
-sudo bash install.sh -m <mode>
-```
+	```sh
+	wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
+	sudo bash install.sh -m <mode>
+	```
 
 2. Done. You can try to run the `mytonctrl` console now.
-```sh
-mytonctrl
-```
+	```sh
+	mytonctrl
+	```
 
 
 ## Installation for Debian
 1. Download and execute the `install.sh` script in the desired installation mode. During installation the script prompts you for the superuser password several times.
-```sh
-wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
-su root -c 'bash install.sh -m <mode>'
-```
+	```sh
+	wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
+	su root -c 'bash install.sh -m <mode>'
+	```
 
 2. Done. You can try to run the `mytonctrl` console now.
-```sh
-mytonctrl
-```
+	```sh
+	mytonctrl
+	```
 
-## Telemetry
+# MyTonCtrl Documentation
+
+This repository contains the following technical documents for MyTonCtrl, categorized by language. Simply click the links below to navigate to the document you're interested in.
+
+|   | FAQ | Import Wallets | Ubuntu Manual | Nominator Pool |
+|:-:|:---:|:-------------:|:-------------:|:--------------:|
+| **English (EN)** | [Link](./docs/en/FAQ.md) | [Link](./docs/en/import-wallets.md) | [Link](./docs/en/manual-ubuntu.md) | [Link](./docs/en/nominator-pool.md) |
+| **Russian (RU)** | [Link](./docs/ru/FAQ.md) | [Link](./docs/ru/import-wallets.md) | [Link](./docs/ru/manual-ubuntu.md) | [Link](./docs/ru/nominator-pool.md) |
+| **Traditional Chinese** | [Link](./docs/zh_TW/FAQ.md) | [Link](./docs/zh_TW/import-wallets.md) | [Link](./docs/zh_TW/manual-ubuntu.md) | [Link](./docs/zh_TW/nominator-pool.md) |
+
+
+# Telemetry
 By default, `mytonctrl` sends validator statistics to the https://toncenter.com server.
 It is necessary to identify network abnormalities, as well as to quickly give feedback to developers.
 To disable telemetry during installation, use the `-t` flag:
@@ -99,6 +135,8 @@ To disable telemetry after installation, do the following:
 MyTonCtrl> set sendTelemetry false
 ```
 
+# MyTonCtrl installer mode
+
 ## Web admin panel
 To control the node/validator through the browser, you need to install an additional module:
 `mytonctrl` -> `installer` -> `enable JR`
@@ -111,11 +149,10 @@ git: https://github.com/igroman787/mtc-jsonrpc
 
 ## Local copy of toncenter
 To set up a local https://toncenter.com copy on your server, install an additional module:
-`mytonctrl` ->` installer` -> `enable PT`
+`mytonctrl` ->`installer` -> `enable PT`
 
 Ready. A local copy of toncenter is available at `http://<server-ip-address>:8000`
 git: https://github.com/igroman787/pytonv3
 
-## Useful links
-1. https://github.com/ton-blockchain/mytonctrl/blob/master/docs/en/manual-ubuntu.md
-2. https://ton.org/docs/
+# Useful links
+* https://docs.ton.org/
diff --git a/docs/en/FAQ.md b/docs/en/FAQ.md
@@ -0,0 +1,124 @@
+Here is the optimized version in English:
+
+# MyTonCtrl Directory Usage
+
+MyTonCtrl is a wrapper that stores its files in two places:
+
+1. `~/.local/share/mytonctrl/` - Long-term files such as logs are stored here.
+2. `/tmp/mytonctrl/` - Temporary files are stored here.
+
+MyTonCtrl also includes another script, mytoncore, which in turn stores files in the following locations:
+
+1. `~/.local/share/mytoncore/` - Permanent files, the main configuration will be stored here.
+2. `/tmp/mytoncore/` - Temporary files, parameters used for elections will be saved here.
+
+MyTonCtrl downloads the source code for itself and the validator into the following directories:
+
+1. `/usr/src/mytonctrl/`
+2. `/usr/src/ton/`
+
+MyTonCtrl compiles the validator components into the following directory:
+
+1. `/usr/bin/ton/`
+
+MyTonCtrl creates a working directory for the validator here:
+
+1. `/var/ton/`
+
+---
+
+## If MyTonCtrl was installed as root:
+
+The configurations will be stored differently:
+
+1. `/usr/local/bin/mytonctrl/`
+2. `/usr/local/bin/mytoncore/`
+
+---
+
+## How to remove MyTonCtrl:
+
+Run the script as an administrator and remove the compiled TON components:
+
+```bash
+sudo bash /usr/src/mytonctrl/scripts/uninstall.sh
+sudo rm -rf /usr/bin/ton
+```
+
+During this process, ensure you have sufficient permissions to delete or modify these files or directories.
+
+
+# Dealing with Errors and Directory Changes with MyTonCtrl
+
+If you encounter issues running MyTonCtrl as a different user or wish to change the working directory of the validator, this guide provides some solutions.
+
+## Running MyTonCtrl as Different User
+
+Running MyTonCtrl as a different user may trigger the following error:
+
+```
+Error: expected str, bytes or os.PathLike object, not NoneType
+```
+
+To resolve this, you should run MyTonCtrl as the user who installed it.
+
+## Changing Validator Working Directory Pre-installation
+
+If you wish to change the working directory of the validator prior to installation, there are two ways to do so:
+
+1. **Fork the project** - You can fork the project and make your changes there. Learn how to fork a project with `man git-fork`.
+2. **Create a symbolic link** - You can also create a symbolic link with the following command:
+
+    ```bash
+    ln -s /opt/ton/var/ton
+    ```
+This command will create a link `/var/ton` that points to `/opt/ton`.
+
+## Changing Validator Working Directory Post-installation
+
+If you want to change the working directory of the validator from `/var/ton/` after installation, perform the following steps:
+
+1. **Stop services** - You will need to stop the services with these commands:
+
+    ```bash
+    systemctl stop validator
+    systemctl stop mytoncore
+    ```
+
+2. **Move validator files** - You then need to move the validator files with this command:
+
+    ```bash
+    mv /var/ton/* /opt/ton/
+    ```
+
+3. **Update configuration paths** - Replace the paths in the configuration located at `~/.local/share/mytoncore/mytoncore.db`.
+
+4. **Note on experience** - There is no prior experience with such a transfer, so consider this when moving forward.
+
+Remember to make sure you have sufficient permissions to make these changes or run these commands.
+
+# Understanding Validator Status and Restarting Validator in MyTonCtrl
+
+This document will help you understand how to confirm if MyTonCtrl has become a full validator and how to restart your validator.
+
+## Checking Validator Status in MyTonCtrl
+
+You can confirm if your node has become a full validator by checking the following conditions:
+
+1. **Validator Desynchronization** - The desynchronization of the local validator should be less than 20.
+2. **Validator Index** - The validator index should be greater than -1.
+
+To view the performance factor of your validator, you can use the `vl` command in MyTonCtrl:
+
+1. Find your validator in the list by its ADNL address (`adnlAddr`).
+2. If the `mr` and `wr` coefficients are close to 1, it means that your validator is working correctly.
+
+## Restarting Your Validator
+
+If you need to restart your validator, you can do so by running the following command:
+
+```bash
+systemctl restart validator
+```
+
+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.
diff --git a/docs/en/FAQ.txt b/docs/en/FAQ.txt