diff --git a/docs/Quick_start/QUICK_START_GUIDE.en.md b/docs/Quick_start/QUICK_START_GUIDE.en.md index 488db17..a7d9620 100644 --- a/docs/Quick_start/QUICK_START_GUIDE.en.md +++ b/docs/Quick_start/QUICK_START_GUIDE.en.md @@ -1,9 +1,36 @@ +# Installation Options +There are three options for installing Telemt: + - [Automated installation using a script](#very-quick-start). + - [Manual installation of Telemt as a service](#telemt-via-systemd). + - [Installation using Docker Compose](#telemt-via-docker-compose). + # Very quick start ### One-command installation / update on re-run ```bash curl -fsSL https://raw.githubusercontent.com/telemt/telemt/main/install.sh | sh ``` + +After starting, the script will prompt for: + - Your language (1 - English, 2 - Russian); + - Your TLS domain (press Enter for petrovich.ru). + +The script checks if the port (default **443**) is free. If the port is already in use, installation will fail. You need to free up the port or use the **-p** flag with a different port to retry the installation. + +To modify the script’s startup parameters, you can use the following flags: + - **-d, --domain** - TLS domain; + - **-p, --port** - server port (1–65535); + - **-s, --secret** - 32 hex secret; + - **-a, --ad-tag** - ad_tag; + - **-l, --lan**g - language (1/en or 2/ru); + +Providing all options skips interactive prompts. + +After completion, the script will provide a link for client connections: +```bash +tg://proxy?server=IP&port=PORT&secret=SECRET +``` + ### Installing a specific version ```bash curl -fsSL https://raw.githubusercontent.com/telemt/telemt/main/install.sh | sh -s -- 3.3.39 diff --git a/docs/Quick_start/QUICK_START_GUIDE.ru.md b/docs/Quick_start/QUICK_START_GUIDE.ru.md index 9cef988..e4bdcf8 100644 --- a/docs/Quick_start/QUICK_START_GUIDE.ru.md +++ b/docs/Quick_start/QUICK_START_GUIDE.ru.md @@ -1,9 +1,35 @@ +# Варианты установки +Имеется три варианта установки Telemt: + - [Автоматизированная установка с помощью скрипта](#очень-быстрый-старт). + - [Ручная установка Telemt в качестве службы](#telemt-через-systemd-вручную). + - [Установка через Docker Compose](#telemt-через-docker-compose). + # Очень быстрый старт ### Установка одной командой / обновление при повторном запуске ```bash curl -fsSL https://raw.githubusercontent.com/telemt/telemt/main/install.sh | sh ``` +После запуска скрипт запросит: + - ваш язык (1 - English, 2 - Русский); + - ваш TLS-домен (нажмите Enter для petrovich.ru). + +Во время установки скрипт проверяет, свободен ли порт (по умолчанию **443**). Если порт занят другим процессом - установка завершится с ошибкой. Для повторной установки необходимо освободить порт или указать другой через флаг **-p**. + +Для изменения параметров запуска скрипта можно использовать следующие флаги: + - **-d, --domain** - TLS-домен; + - **-p, --port** - порт (1–65535); + - **-s, --secret** - секрет (32 hex символа); + - **-a, --ad-tag** - ad_tag; + - **-l, --lang** - язык (1/en или 2/ru). + +Если заданы флаги для языка и домена - интерактивных вопросов не будет. + +После завершения установки скрипт выдаст ссылку для подключения клиентов: +```bash +tg://proxy?server=IP&port=PORT&secret=SECRET +``` + ### Установка нужной версии ```bash curl -fsSL https://raw.githubusercontent.com/telemt/telemt/main/install.sh | sh -s -- 3.3.39