Translate to English #1 (#331)

* Translate to English

* Format
This commit is contained in:
Winston2084 2023-03-04 23:33:55 +08:00 committed by GitHub
parent a5842db0e2
commit 4e6196c70a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 123 additions and 128 deletions

View File

@ -2,50 +2,50 @@
sidebar: auto
---
# 快速入门
# Quick Start
> **这个章节将告诉您如何用最简单的方式获得 Xray并且开始使用 Xray。**
> **This chapter will tell you how to get Xray in the easiest way and start using Xray.**
## 下载安装
## Download and Install
Xray 支持各种平台,并且您可以从多种渠道和方式获得 Xray 的各种版本。
Xray supports various platforms, and you can get various versions of Xray from various sources and methods.
请点击 [如何下载安装 Xray](./install.md) 以获取 Xray
Please click [How to Download and Install Xray](./install.md) to get Xray
## 配置运行
## Configure and Run
下载并安装 Xray 后,只需对他进行配置即可使用。
After downloading and installing Xray, you need to configure it.
请点击 [如何配置运行 Xray](./config.md) 以学习最简单的配置方式。
Please click [How to Configure and Run Xray](./config.md) to learn the easiest way to configure Xray.
## 命令参数
## Command Parameters
Xray 有多种命令和参数可用,因此变得灵活和强大。
Xray has a variety of commands and parameters available, making it flexible and powerful.
请点击 [Xray 的命令参数](./command.md) 查看 Xray 的更多命令和参数用法。
Please click [Command Parameters for Xray](./command.md) to view more commands and parameters usages.
## 改进文档
## Improve Documents
如果你有兴趣,请点击 [使用文档](./document.md) 帮助我们改进文档,或者点击页面下方的 `帮助我们改善此页面!`
If you're interested, please click [Documents](./document.md) to help us improve the documents, or click the`Help us improve this page!`
我们十分感谢每一位 Contributor 作出的贡献!是你们让 Project X 变得更加强大!
We are very grateful to every Contributor for their contribution! You guys make Project X even stronger!
## 小小白白话文
## Beginner Tutorial
给予新手指导的使用心得
A easy tutorial for beginner.
请点击 [小小白白话文](./level-0/) 以进行查看。
Please click [小小白白话文](./level-0/) to view it.
## 入门技巧
## Getting Started Tips
具备了基础之后,你就可以通过 [入门技巧](./level-1/) 来探索更多的使用方式了。
After you have the basics, you can explore more ways to use them through [Getting Started Tips](./level-1/).
## 进阶文档
## Advanced Documentation
给予进阶用户指导的使用技巧
Tips for advanced user guidance
点击 [进阶文档](./level-2/) 以进行查看
Click on [Advanced Documentation](./level-2/) to view it
::: tip 感谢
非常感谢大家无私分享使用技巧和心得, 使得 Xray 日益强大。
::: tip Appreciations
Thank you very much for your selfless sharing of usage skills and experience, which makes Xray more and more powerful.
:::

View File

@ -1,12 +1,12 @@
# 命令参数
# Command Parameters
::: tip
Xray 使用 Go 风格的命令及参数
Xray uses Go-style commands and parameters
:::
## 获取基本命令
## Get Basic Commands
您可以运行 `xray help` 来获得所有 xray 最基础的用法, 以及可用的命令及说明.
You can run `xray help`to get the most basic usage of all xray, as well as available commands and instructions.
```
Xray is a platform for building proxies.
@ -28,9 +28,9 @@ Use "xray help <command>" for more information about a command.
### xray run
指定一个或多个配置文件,并运行。
Specify one or more configuration files and run.
使用方法:
Usage:
```
xray run [-c config.json] [-confdir dir]
@ -53,9 +53,9 @@ without launching the server
### xray version
输出 Xray 版本、 Golang 版本等信息。
Output Xray version, Golang version and other information.
使用方法:
Usage:
```
xray version
@ -63,9 +63,9 @@ without launching the server
### xray api
调用 Xray 的 gRPC API需要在配置文件中开启。
To call Xray's gRPC API, it needs to be enabled in the configuration file.
使用方法:
Usage:
```
xray api <command> [arguments]
@ -84,9 +84,9 @@ xray api <command> [arguments]
### xray tls
一些与 TLS 相关的工具。
Some tools related to TLS.
使用方法:
Usage:
```
xray tls <command> [arguments]
@ -99,17 +99,17 @@ xray tls <command> [arguments]
### xray uuid
生成 UUID。
Generated UUID.
使用方法:
Usage:
```
xray uuid
```
::: tip
`-config`没有指定时Xray 将先后尝试从以下路径加载`config.json`:
When `-config` is not specified, Xray will try to load `config.json` from the following paths:
- 工作目录(Working Directory
- [环境变量](../config/features/env.md#资源文件路径)中`Xray.location.asset`所指定的路径
- Working Directory
- The path specified by `Xray.location.asset` in the [environment variable](../config/features/env.md).
:::

View File

@ -1,20 +1,20 @@
# 配置运行
# Configure and Run
[下载并安装](./install) 了 Xray 之后,您需要对它进行一下配置。
After [downloading and installing Xray](./install/), you need to configure it,
为了演示,这里只介绍简单的配置方式。更多的模板: [Xray-examples](https://github.com/XTLS/Xray-examples)
For demonstration, only a simple configuration method is introduced here. More templates: [Xray-examples](https://github.com/XTLS/Xray-examples)
如需配置更复杂的功能,请参考更详细的 [配置文件](../config/) 中相关说明。
If you need to configure more complex functions, please refer to the relevant instructions in the more detailed [configuration file](../config/).
## 服务端配置
## Server Configuration
你需要一台防火墙外的服务器,来运行服务器端的 Xray。配置如下
You need a server outside the firewall to run server-side Xray. The configuration is as follows:
```json
{
"inbounds": [
{
"port": 10086, // 服务器监听端口
"port": 10086, // server listening port
"protocol": "vmess",
"settings": {
"clients": [
@ -33,17 +33,17 @@
}
```
服务器的配置中需要确保 `id` 和端口与客户端一致,就可以正常连接了。
In the configuration of the server, you need to ensure `id` that the and port are consistent with the client, and then you can connect normally.
## 客户端配置
## Client Configuration
在你的 PC或手机需要用以下配置运行 Xray
On your PC (or phone), you need to run Xray with the following configuration:
```json
{
"inbounds": [
{
"port": 1080, // SOCKS 代理端口,在浏览器中需配置代理并指向这个端口
"port": 1080, // SOCKS proxy port, the proxy needs to be configured in the browser and point to this port
"listen": "127.0.0.1",
"protocol": "socks",
"settings": {
@ -57,8 +57,8 @@
"settings": {
"vnext": [
{
"address": "server", // 服务器地址,请修改为你自己的服务器 ip 或域名
"port": 10086, // 服务器端口
"address": "server", // Server address, please change it to your own server IP or domain name
"port": 10086, // server port
"users": [
{
"id": "b831381d-6324-4d53-ad4f-8cda48b30811"
@ -86,14 +86,14 @@
}
```
上述配置唯一要更改的地方是你的服务器 IP配置中已注明。上述配置会把除局域网比如访问路由器以外的所有流量转发至你的服务器。
The only thing to change in the above configuration is your server IP, which is noted in the configuration. The above configuration will forward all traffic to your server except on the LAN (such as the access router).
## 运行
## Run
- 在 Windows 和 macOS 中,配置文件通常是 Xray 同目录下的 `config.json` 文件。
- 直接运行 `Xray``Xray.exe` 即可。
- 在 Linux 中,配置文件通常位于 `/etc/xray/``/usr/local/etc/xray/` 目录下。
- 运行 `xray run -c /etc/xray/config.json`
- 或使用 systemd 等工具将 Xray 作为服务在后台运行。
- On Windows and macOS, configuration files are usually `config.json`
- Just run `Xray` or `Xray.exe`
- On Linux, configuration files are usually located in `/etc/xray/` or `/usr/local/etc/xray/`.
- Run `xray run -c /etc/xray/config.json`
- Or use something like systemd to run Xray as a service in the background.
更多详细的说明可以参考 [配置文档](../config/) 和 [小小白话文](../documents/level-0/)。
For more detailed instructions, please refer to [Configuration](../config/) Document and [小小白话文](../documents/level-0/).

View File

@ -1,47 +1,45 @@
# 为 Project X 的文档贡献
# Contribute to Project X's Document
欢迎您为 Project X 的文档做出贡献,我们感谢每一位 Contributor 的贡献!是你们让 Xray 更加强大!
Contributions to Project X's Document are welcome, and we appreciate every Contributor's contribution! You guys make Xray stronger!
## 改进文档
## Improve Document
Project X 的文档托管在 [GitHub](https://github.com/XTLS/Xray-docs-next).
Document for Project X is hosted on [GitHub](https://github.com/XTLS/Xray-docs-next).
您可以通过以下步骤, 提交您对文档的改动:
You can submit your changes to the Document by following these steps:
1. 从 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库.
1. Open the repository from [Project X Document](https://github.com/XTLS/Xray-docs-next), click fork in the upper right corner, fork a mirror image of the document repository to your own GitHub repository.
2. 使用任何您喜欢的工具, 从您克隆的仓库获得文档的克隆, 如:
2. Get a clone of the docs from the repository you cloned using whatever tool you like, like:
```
git clone https://github.com/XTLS/Xray-docs-next.git
```
3. 基于 main 分支创建新的分支, 如:
3. Create a new branch based on the main branch, such as:
```
git checkout -b your-branch
```
4. 在新分支上做修改。
4. Make changes on the new branch.
注:推荐 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)
5. After modification, please use [Prettier](https://prettier.io/docs/en/install.html)Format your changes.
5. 修改完成后,请使用 [Prettier](https://prettier.io/docs/en/install.html) 格式化您的更改。
Note: Pull requests with formatting issues may be rejected.
注:存在格式问题的 PR将有可能被拒绝。
6. 提交修改,并推送到您的仓库中
6. Submit the changes and push them to your repository
```
git push -u origin your-branch
```
6. 打开 GitHub, 点击 'Pull request' 向 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 提交 PR。
6. Open GitHub, click 'Pull request' to submit a pull request to [Project X Document](https://github.com/XTLS/Xray-docs-next).
7. 请在 PR 的标题和正文中,概述此次 PR 新增/修改的内容等;
7. Please outline the new/modified content of this pull request in the title and body of the pull request;
8. 等待回应, 如果 PR 被 merge, 您做的修改将直接呈现在 [Project X 文档网站](https://xtls.github.io)。
8. Waiting for a response, if the pull request is merged, your changes will be directly displayed on [Project X Document Website](https://xtls.github.io).
## 发现问题?
## Found Problems?
如果您发现文档出错,可以改进文档或提交一个 Issue。
If you find an error in the document, you can improve the documentation or submit an issue.

View File

@ -1,45 +1,43 @@
# 下载安装
# Download and Install
## 平台支持
## Platform Support
Xray 在以下平台中可用:
- Xray is available on the following platforms:
- Windows 7 and later (x86 / amd64 / arm32 / arm64);
- macOS 10.10 Yosemite and later (amd64 / arm64);
- Linux 2.6.23 and later (x86 / amd64 / arm / arm64 / mips64 / mips / ppc64 / s390x / riscv64);
- Including but not limited to Debian 7 / 8, Ubuntu 12.04 / 14.04 and subsequent versions, CentOS 7 / 8, Arch Linux, etc.;
- FreeBSD (x86 / amd64);
- OpenBSD (x86 / amd64);
- Dragonfly BSD (amd64);
- Windows 7 及之后版本x86 / amd64 / arm32
- macOS 10.10 Yosemite 及之后版本amd64
- 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)
## Download Xray
## 下载 Xray
Precompiled binaries in ZIP format are available at [GitHub Releases](https://github.com/xtls/Xray-core/releases) found in.
预编译的二进制 ZIP 格式压缩包可在 [Github Releases](https://github.com/xtls/Xray-core/releases) 中找到。
Download the compressed package of the corresponding platform, and use it after decompression.
下载对应平台的压缩包,解压后即可使用。
## Verify the Installation Package
## 验证安装包
Xray provides two verification methods:
Xray 提供两种验证方式:
- SHA1/SHA256 digest of the ZIP archive
- Reproducible build: Please refer to [Compile Xray](https://xtls.github.io/development/intro/compile.html)
- ZIP 压缩包的 SHA1 / SHA256 摘要
- 可复现构建:请参照 [编译 Xray](../development/intro/compile.md)
## Install on Windows
## Windows 安装方式
- Download the ZIP archive suitable for the Windows platform on [Github Releases](https://github.com/xtls/Xray-core/releases). After decompression, you can get an executable file `xray.exe`, and then run it with [parameters](./command) through the command line.
- By [Scoop](https://scoop.sh/) Package manager installation: Xray has been added to [Mochi](https://github.com/Qv2ray/mochi).
- 在 [Github Releases](https://github.com/xtls/Xray-core/releases) 下载适用于 Windows 平台的 ZIP 压缩包,解压后可得到可执行文件 `xray.exe`
,然后[通过命令行带参数运行](./command) 即可
- 通过 [Scoop](https://scoop.sh) 包管理器安装Xray 已经被添加到 [Mochi](https://github.com/Qv2ray/mochi)。
## Install on macOS
## macOS 安装方式
- Download the ZIP archive suitable for the macOS platform on [Github Releases](https://github.com/xtls/Xray-core/releases). After decompression, you can get an executable file `xray`, and then run it with [parameters](./command) through the command line.
- By [Homebrew](https://brew.sh/) Package manager installation: `brew install xray`
- [homebrew-xray](https://github.com/N4FA/homebrew-xray): Thanks [@N4FA](https://github.com/N4FA)
- 在 [Github Releases](https://github.com/xtls/Xray-core/releases) 下载适用于 macOS 平台的 ZIP 压缩包,解压后可得到可执行文件 `xray`
,然后[通过命令行带参数运行](./command.md) 即可
- 通过 [Homebrew](https://brew.sh) 包管理器安装:`brew install xray`
## Install on Linux
## Linux 安装方式
### 安装脚本
### Install Script
- Linux Script
@ -49,7 +47,7 @@ Xray 提供两种验证方式:
- [Xray-script](https://github.com/kirin10000/Xray-script)
- [ProxySU](https://github.com/proxysu/ProxySU)
- [Xray-agent](https://github.com/reeceyng/v2ray-agent) 感谢[@mack-a](https://github.com/mack-a) [@Reece](https://github.com/reeceyng)
- [Xray-agent](https://github.com/reeceyng/v2ray-agent) Thanks [@mack-a](https://github.com/mack-a) [@Reece](https://github.com/reeceyng)
* Magisk
- [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk)
@ -59,31 +57,30 @@ Xray 提供两种验证方式:
#### Arch User Repository
需要使用 [AUR helpers](https://wiki.archlinux.org/index.php/AUR_helpers),以 [yay](https://github.com/Jguer/yay)
为例,可通过 `yay -S xray` 安装。
Need to use [AUR helpers](https://wiki.archlinux.org/index.php/AUR_helpers), [yay](https://github.com/Jguer/yay) as an example, it can be installed via `yay -S xray`.
#### Arch Linux CN
首先添加 [Arch Linux CN 仓库](https://www.archlinuxcn.org/archlinux-cn-repo-and-mirror/),然后在 root 用户下使用 `pacman -S xray` 安装。
First add [Arch Linux CN](https://www.archlinuxcn.org/archlinux-cn-repo-and-mirror/) repository, and then use the root user `pacman -S xray`to install.
### Linuxbrew
Linuxbrew 包管理器的使用方式与 Homebrew 一致:`brew install xray`
The Linuxbrew package manager is used in the same way as Homebrew: `brew install xray`
### Debian <Badge text="WIP" type="warning"/>
## Docker 安装方式
## Install via Docker
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray)
### Docker image 的文件结构
### The File Structure of the Docker Image
- `/etc/xray/config.json`:配置文件
- `/usr/bin/xray`Xray 主程序
- `/usr/local/share/xray/geoip.dat`IP 数据文件
- `/usr/local/share/xray/geosite.dat`:域名数据文件
- `/etc/xray/config.json`: configuration file
- `/usr/bin/xray`: Xray main program
- `/usr/local/share/xray/geoip.dat`: IP data file
- `/usr/local/share/xray/geosite.dat`: domain name data file
# 图形化客户端
# GUI Client
- OpenWrt
- [PassWall](https://github.com/xiaorouji/openwrt-passwall)
@ -92,18 +89,18 @@ Linuxbrew 包管理器的使用方式与 Homebrew 一致:`brew install xray`
- [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) (该项目已冻结存档)
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project has been and archived)
- [Netch (NetFilter & TUN/TAP)](https://github.com/NetchX/Netch) (This project has been and archived)
- Android
- [v2rayNG](https://github.com/2dust/v2rayNG)
- [Kitsunebi](https://github.com/rurirei/Kitsunebi/tree/release_xtls)
- iOS / macOS(使用 ARM 芯片)
- iOS / macOS (ARM)
- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
- [Stash](https://apps.apple.com/app/stash/id1596063349)
- macOSX86 芯片 / ARM 芯片)
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (该项目已冻结存档)
- macOS (X86/ARM)
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project has been and archived)
- [V2RayXS](https://github.com/tzmax/V2RayXS)
# UUID 生成器
# UUID Generator
第三方的 UUID 生成器 [uuidgenerator.net](https://www.uuidgenerator.net)
Third-party UUID generator [uuidgenerator.net](https://www.uuidgenerator.net)