translate /ru/document/ pages

pull/529/head
Nikita Korotaev 2024-07-14 12:13:06 +05:00
parent 0f3d72c3b4
commit 173ee04cf8
5 changed files with 484 additions and 0 deletions

View File

@ -0,0 +1,49 @@
# Быстрый старт
> **В этой главе вы узнаете, как максимально просто получить Xray и начать его использовать.**
## Загрузка и установка
Xray поддерживает разнообразные платформы, и вы можете получить разные версии Xray из множества источников и различными способами.
Перейдите в раздел [Загрузка и установка](./install.md), чтобы загрузить Xray.
## Настройка и запуск
После загрузки и установки Xray вам нужно всего лишь настроить его, чтобы начать использование.
Перейдите в раздел [Настройка и запуск](./config.md), чтобы изучить самый простой способ настройки.
## Команды и аргументы
Xray обладает множеством команд и аргументов, что делает его гибким и мощным.
Перейдите в раздел [Команды и аргументы](./command.md), чтобы узнать больше о командах и аргументах Xray.
## Улучшение документации
Если вы заинтересованы, перейдите в раздел [Использование документации](./document.md), чтобы помочь нам улучшить документацию, или нажмите кнопку `Помогите нам улучшить эту страницу!` внизу страницы.
Мы очень благодарны каждому участнику за вклад! Вы делаете Project X сильнее!
## Простыми словами
Практические советы для новичков.
Перейдите в раздел [Простыми словами](./level-0/) для просмотра.
## Базовые навыки
Освоив основы, вы можете перейти к разделу [Базовые навыки](./level-1/), чтобы узнать о других способах использования.
## Продвинутая документация
Практические советы для опытных пользователей.
Перейдите в раздел [Продвинутая документация](./level-2/) для просмотра.
::: tip Благодарность
Огромное спасибо всем за то, что делитесь своими навыками и опытом, которые делают Xray с каждым днем ​​лучше.
:::

159
docs/ru/document/command.md Normal file
View File

@ -0,0 +1,159 @@
# Командные аргументы
::: tip
Xray использует команды и аргументы в стиле Go.
:::
## Базовые команды
Вы можете запустить `xray help`, чтобы получить список всех базовых команд Xray, а также их описание и примеры использования.
```
Xray is a platform for building proxies.
Usage:
xray <command> [arguments]
The commands are:
run Run Xray with config, the default command
version Show current version of Xray
api Call an API in an Xray process
tls TLS tools
uuid Generate UUIDv4 or UUIDv5
x25519 Generate key pair for x25519 key exchange
wg Generate key pair for wireguard key exchange
Use "xray help <command>" for more information about a command.
```
### xray run
Запуск Xray с указанием одного или нескольких файлов конфигурации.
Использование:
```
xray run [-c config.json] [-confdir dir]
```
```
Run Xray with config, the default command.
The -config=file, -c=file flags set the config files for
Xray. Multiple assign is accepted.
The -confdir=dir flag sets a dir with multiple json config
The -format=json flag sets the format of config files.
Default "auto".
The -test flag tells Xray to test config files only,
without launching the server.
The -dump flag tells Xray to print the merged config.
```
`-config=` / `-c=`: Указывает путь к файлу конфигурации, поддерживается использование нескольких файлов.
`-confdir=`: Указывает путь к папке, содержащей несколько файлов конфигурации.
`-format=`: Задает формат файлов конфигурации.
`-test`: Проверяет корректность файлов конфигурации.
`-dump`: Выводит объединенный результат слияния нескольких файлов конфигурации.
::: tip
Помимо формата JSON по умолчанию, файлы конфигурации также могут быть в формате TOML или YAML. Если формат не указан явно, он определяется по расширению файла.
:::
```
xray run -dump
```
Выводит результат слияния нескольких файлов конфигурации.
### xray version
Выводит информацию о версии Xray, версии Golang и т. д.
Использование:
```
xray version
```
### xray api
Вызов gRPC API Xray, который должен быть включен в файле конфигурации.
Использование:
```
xray api <command> [arguments]
```
```
restartlogger Restart the logger
stats Get statistics
statsquery Query statistics
statssys Get system statistics
adi Add inbounds
ado Add outbounds
rmi Remove inbounds
rmo Remove outbounds
```
### xray tls
Инструменты для работы с TLS.
Использование:
```
xray tls <command> [arguments]
```
```
cert Generate TLS certificates
ping Ping the domain with TLS handshake
certChainHash Calculate TLS certificates hash.
```
### xray uuid
Генерация UUID.
Использование:
```
xray uuid [-i "example"]
```
### xray x25519
Генерация пары ключей x25519.
Использование:
```
xray x25519 [-i "(base64.RawURLEncoding)" --std-encoding ]
```
### xray wg
Генерация пары ключей curve25519 для WireGuard.
Использование:
```
xray wg [-i "(base64.StdEncoding)"]
```
::: tip
Если `-config` не указан, Xray попытается загрузить `config.json` из следующих мест:
- Рабочий каталог (Working Directory);
- Путь, указанный в переменной окружения `Xray.location.asset` (см. [Переменные окружения](../config/features/env.md#ресурсные-файлы)).
:::

108
docs/ru/document/config.md Normal file
View File

@ -0,0 +1,108 @@
# Настройка и запуск
После того, как вы [скачали и установили](./install) Xray, вам потребуется его настроить.
В данном руководстве мы рассмотрим только простой способ настройки. Дополнительные шаблоны: [Xray-examples](https://github.com/XTLS/Xray-examples)
Для настройки более сложных функций обратитесь к подробным инструкциям в разделе [Файл конфигурации](../config/).
::: danger
Во избежание расшифровки вашего трафика <br>
следует сгенерировать уникальный UUID с помощью команды `xray uuid` или `uuidgen`, <br>
который затем нужно вставить на стороне сервера в поле `inbounds[0].settings.clients[0].id`, <br>
а на стороне клиента - в поле `outbounds[0].settings.vnext[0].users[0].id`. <br>
:::
## Настройка сервера
Вам понадобится сервер с публичным IP-адресом (не за NAT), на котором будет запущен Xray. Конфигурация сервера:
```json
{
"inbounds": [
{
"port": 10086, // Порт, который слушает сервер
"protocol": "vmess",
"settings": {
"clients": [
{
"id": "b831381d-6324-4d53-ad4f-8cda48b30811" // Не забудьте заменить это поле, сгенерировав UUID с помощью `xray uuid` или `uuidgen`
}
]
}
}
],
"outbounds": [
{
"protocol": "freedom"
}
]
}
```
Убедитесь, что `id` и порт в конфигурации сервера совпадают с настройками клиента, чтобы подключение работало correctamente.
## Настройка клиента
На вашем компьютере (или телефоне) необходимо запустить Xray со следующей конфигурацией:
```json
{
"inbounds": [
{
"port": 1080, // Порт SOCKS-прокси, на него нужно будет направлять трафик в браузере
"listen": "127.0.0.1",
"protocol": "socks",
"settings": {
"udp": true
}
}
],
"outbounds": [
{
"protocol": "vmess",
"settings": {
"vnext": [
{
"address": "server", // Адрес сервера, замените его на IP-адрес или доменное имя вашего сервера
"port": 10086, // Порт сервера
"users": [
{
"id": "b831381d-6324-4d53-ad4f-8cda48b30811" // Не забудьте заменить это поле, сгенерировав UUID с помощью `xray uuid` или `uuidgen`
}
]
}
]
}
},
{
"protocol": "freedom",
"tag": "direct"
}
],
"routing": {
"domainStrategy": "IPOnDemand",
"rules": [
{
"type": "field",
"ip": ["geoip:private","geoip:cn"], // Исключить локальную сеть и диапазоны IP-адресов Китая
"outboundTag": "direct"
}
]
}
}
```
Единственное, что вам нужно изменить в приведенной выше конфигурации, - это IP-адрес вашего сервера и UUID пользователя, как указано в комментариях. Эта конфигурация будет перенаправлять весь трафик на ваш сервер, за исключением локальной сети (например, доступ к маршрутизатору) и диапазонов IP-адресов Китая (например, доступ к bilibili, acfun).
## Запуск
- В Windows и macOS файл конфигурации обычно находится в том же каталоге, что и Xray, и называется `config.json`.
- Просто запустите `Xray` или `Xray.exe`.
- В Linux файл конфигурации обычно находится в каталоге `/etc/xray/` или `/usr/local/etc/xray/`.
- Запустите команду `xray run -c /etc/xray/config.json`.
- Или используйте systemd или другой инструмент для запуска Xray как службы в фоновом режиме.
Более подробную информацию можно найти в [документации по конфигурации](../config/) и в разделе [Простыми словами](./level-0/).

View File

@ -0,0 +1,49 @@
# Вклад в документацию Project X
Мы приветствуем ваш вклад в документацию Project X и благодарим каждого контрибьютора за помощь! Вы делаете Xray лучше!
## Улучшение документации
Документация Project X размещена на [GitHub](https://github.com/XTLS/Xray-docs-next).
Вы можете внести изменения в документацию, выполнив следующие действия:
1. Откройте [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next), нажмите кнопку "Fork" в правом верхнем углу, чтобы создать копию репозитория документации в вашей учетной записи GitHub.
2. Используйте любой удобный инструмент для клонирования документации из вашего репозитория, например:
```
git clone https://github.com/XTLS/Xray-docs-next.git
```
3. Создайте новую ветку на основе ветки `main`, например:
```
git checkout -b your-branch
```
4. Внесите изменения в новую ветку.
Примечание: рекомендуем придерживаться [Руководства по оформлению текстов на китайском языке](https://github.com/sparanoid/chinese-copywriting-guidelines) (на китайском).
5. После внесения изменений отформатируйте их с помощью [Prettier](https://prettier.io/docs/en/install.html).
Примечание: запросы на включение (PR) с ошибками форматирования могут быть отклонены.
6. Зафиксируйте изменения и отправьте их в ваш репозиторий:
```
git push -u origin your-branch
```
7. Откройте GitHub, перейдите в раздел "Pull requests" и создайте новый запрос на включение (PR) в [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next).
8. В заголовке и описании PR кратко опишите внесенные изменения.
9. Дождитесь ответа. Если ваш PR будет принят, изменения появятся на [сайте документации Project X](https://xtls.github.io).
## Нашли ошибку?
Если вы обнаружили ошибку в документации, вы можете внести исправления или создать задачу (Issue).

119
docs/ru/document/install.md Normal file
View File

@ -0,0 +1,119 @@
# Загрузка и установка
## Поддерживаемые платформы
Xray доступен на следующих платформах:
- Windows 7 и выше (x86 / amd64 / arm32 / arm64);
- macOS 10.10 Yosemite и выше (amd64 / arm64);
- Linux 2.6.23 и выше (x86 / amd64 / arm / arm64 / mips64 / mips / ppc64 / s390x / riscv64);
- Включая, но не ограничиваясь: Debian 7 / 8, Ubuntu 12.04 / 14.04 и выше, CentOS 7 / 8, Arch Linux и др.;
- FreeBSD (x86 / amd64);
- OpenBSD (x86 / amd64);
- Dragonfly BSD (amd64);
## Загрузка Xray
Предварительно скомпилированные ZIP-архивы с двоичными файлами можно найти в [Github Releases](https://github.com/xtls/Xray-core/releases).
Скачайте архив для своей платформы, распакуйте его и можете использовать.
## Проверка установочного пакета
Xray предлагает два способа проверки:
- SHA1 / SHA256 хэш-сумма ZIP-архива;
- Воспроизводимая сборка: см. [Сборка Xray](../development/intro/compile.md).
## Установка на Windows
- Скачайте ZIP-архив для Windows на [Github Releases](https://github.com/xtls/Xray-core/releases), распакуйте его, чтобы получить исполняемый файл `xray.exe`, а затем [запустите его из командной строки с параметрами](./command).
- Установите с помощью менеджера пакетов [Scoop](https://scoop.sh): Xray был добавлен в [Mochi](https://github.com/Qv2ray/mochi).
## Установка на macOS
- Скачайте ZIP-архив для macOS на [Github Releases](https://github.com/xtls/Xray-core/releases), распакуйте его, чтобы получить исполняемый файл `xray`, а затем [запустите его из командной строки с параметрами](./command.md).
- Установите с помощью менеджера пакетов [Homebrew](https://brew.sh): `brew install xray`.
- [homebrew-xray](https://github.com/N4FA/homebrew-xray) Спасибо, [@N4FA](https://github.com/N4FA)!
## Установка на Linux
### Установочные скрипты
- Linux Script
- [Xray-install](https://github.com/XTLS/Xray-install)
* One Click
- [Xray-script](https://github.com/kirin10000/Xray-script)
- [ProxySU](https://github.com/proxysu/ProxySU)
- [v2ray-agent](https://github.com/reeceyng/v2ray-agent) Спасибо, [@mack-a](https://github.com/mack-a) [@Reece](https://github.com/reeceyng)!
- [Xray-yes](https://github.com/jiuqi9997/Xray-yes)
- [Xray-onekey](https://github.com/wulabing/Xray_onekey)
* Magisk
- [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk)
- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
### Arch Linux
#### Arch User Repository
Требуется [помощник AUR](https://wiki.archlinux.org/index.php/AUR_helpers), например, [yay](https://github.com/Jguer/yay), установка с помощью команды `yay -S xray`.
#### Arch Linux CN
Сначала добавьте [репозиторий Arch Linux CN](https://www.archlinuxcn.org/archlinux-cn-repo-and-mirror/), затем установите от имени пользователя root с помощью команды `pacman -S xray`.
### Linuxbrew
Использование менеджера пакетов Linuxbrew аналогично Homebrew: `brew install xray`.
### Debian <Badge text="WIP" type="warning"/>
### Gentoo
В настоящее время существует три оверлея сторонних разработчиков, которые предоставляют сценарии установки Portage:
- [CHN-beta/touchfish-os](https://github.com/gentoo-mirror/touchfish-os/tree/master/net-proxy/Xray): Поддерживается отдельным пользователем, подходит для систем с systemD.
- [Gentoo-zh](https://github.com/microcai/gentoo-zh): Поддерживается сообществом, подходит для систем с systemD.
- [JuanCldCmt/Xray-Overlay](https://github.com/JuanCldCmt/Xray-Overlay): Поддерживается отдельным пользователем, подходит для систем с openRC, использует группу пользователей xray для повышения безопасности.
Добавьте оверлей в локальную систему с помощью layman или eselect-repository, а затем выполните установку.
## Установка с помощью Docker
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray)
### Файловая структура образа Docker
- `/etc/xray/config.json`: файл конфигурации;
- `/usr/bin/xray`: основная программа Xray;
- `/usr/share/xray/geoip.dat`: файл данных IP;
- `/usr/share/xray/geosite.dat`: файл данных доменных имен.
# Графические клиенты
- OpenWrt
- [PassWall](https://github.com/xiaorouji/openwrt-passwall)
- [Hello World](https://github.com/jerrykuku/luci-app-vssr)
- [ShadowSocksR Plus+](https://github.com/fw876/helloworld)
- [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray))
- Windows
- [v2rayN](https://github.com/2dust/v2rayN)
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (проект заморожен и архивирован)
- [Netch (NetFilter & TUN/TAP)](https://github.com/NetchX/Netch) (проект заморожен и архивирован)
- Android
- [v2rayNG](https://github.com/2dust/v2rayNG)
- [Kitsunebi](https://github.com/rurirei/Kitsunebi/tree/release_xtls)
- iOS / macOS (с чипом ARM)
- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
- [Stash](https://apps.apple.com/app/stash/id1596063349)
- macOS (чип X86 / ARM)
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (проект заморожен и архивирован)
- [V2RayXS](https://github.com/tzmax/V2RayXS)
# Генератор UUID
Генератор UUID от сторонних разработчиков: [uuidgenerator.net](https://www.uuidgenerator.net)