xray_docker/reality/README.MD
wulabing 923fb3b8e6
0.0.12
[add] 添加订阅链接及二维码
[fix] 更新详细使用文档,添加暴露端口变量,方便生成订阅信息
2023-04-17 19:22:56 +08:00

77 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## xray_docker_reality
xray reality docker 镜像
[![xray_docker_reality_docker_image_build](https://github.com/wulabing/xray_docker/actions/workflows/xray_docker_reality.yml/badge.svg)](https://github.com/wulabing/xray_docker/actions/workflows/xray_docker_reality.yml)
## 基础使用方法
如果你没有安装 docker 请先安装docker
```
curl -fsSL get.docker.com -o get-docker.sh && sh get-docker.sh
```
如果你已经安装docker可以直接使用下面的命令运行后会自动下载镜像并启动容器
EXTERNAL_PORT 为你想要使用的端口如下所示你将使用443端口
```
EXTERNAL_PORT=443
docker run -d --name xray_reality --restart=always -p $EXTERNAL_PORT:443 -e EXTERNAL_PORT=$EXTERNAL_PORT wulabing/xray_docker_reality:latest
```
查看日志获取配置信息,如下所示,按照提示配置客户端即可,
```
docker logs -f xray_reality
```
## 进阶使用方法
如果你不想使用443端口你可以自定义端口例如使用8443端口如下所示
```
EXTERNAL_PORT=8443
docker run -d --name xray_reality --restart=always -p $EXTERNAL_PORT:443 -e EXTERNAL_PORT=$EXTERNAL_PORT wulabing/xray_docker_reality:latest
```
如果你想启动多个reality服务你可以使用不同的容器名并注意端口不要冲突如下所示你将启动两个reality服务分别使用444和445端口
```
EXTERNAL_PORT=444
docker run -d --name xray_reality_1 --restart=always -p $EXTERNAL_PORT:443 -e EXTERNAL_PORT=$EXTERNAL_PORT wulabing/xray_docker_reality:latest
EXTERNAL_PORT=445
docker run -d --name xray_reality_2 --restart=always -p $EXTERNAL_PORT:443 -e EXTERNAL_PORT=$EXTERNAL_PORT wulabing/xray_docker_reality:latest
```
如果你不想使用默认参数你可以自定义参数例如使用自定义的UUID,以及自定义目标地址和服务器名称,如下所示,**支持的自定义参数请参考下方环境变量说明**
存在多个SERVERNAMES时使用空格分开例如www.apple.com images.apple.com
请注意,如果你使用自定义参数,你需要自己保证参数的正确性,否则可能会导致容器无法启动
```
EXTERNAL_PORT=443
docker run -d --name xray_reality --restart=always -p $EXTERNAL_PORT:443 -e EXTERNAL_PORT=$EXTERNAL_PORT -e UUID="XXX" -e SERVERNAMES="www.apple.com images.apple.com" -e DEST="www.apple.com:443" -e PRIVATEKEY="XXX" wulabing/xray_docker_reality:latest
```
使用以下命令删除已经创建的容器如下所示需要将xray_reality替换为你自己的容器名 (--name 所设置的名称)
```
docker rm -f xray_reality
```
## 环境变量
你可以设置以下环境变量来自定义 XRay 的配置。
* UUIDXRay 的唯一用户标识符。若未设置,脚本将自动生成一个随机 UUID。
* DEST目标地址。默认值为 www.apple.com:443。
* SERVERNAMES服务器名称列表。默认值为 www.apple.com images.apple.com。
* PRIVATEKEY私钥。若未设置脚本将自动生成一个新的私钥和对应的公钥。
* NETWORK网络类型。默认值为 tcp。
## 常量
* flowxtls-rprx-vision
* securityreality
* shortIds留空
## 注意事项
请确保在使用前已正确安装和配置 XRay 客户端。
为了保证安全和稳定,请勿将 UUID、私钥等敏感信息泄露给他人。