# 说明

## 前提

提前安装好以下软件

- git
- curl
- docker
- docker-compose
- jq - 用于查看 json 文件, 提取 json 文件信息. 编辑 json 文件
- qrencode - (可选, 非必要)用于生成二维码

## 快速开始

1. 下载项目

```bash
git clone https://gitea.9001001.xyz/William/xray_docker.git
```

2. 进入项目目录

```bash
cd xray_docker
```

3. 执行命令生成配置并启动容器

```bash
bash ./bin/run.sh
```

## 停止

如果需要停止服务, 进入项目目录, 执行以下命令

```bash
docker-compose down
```

## 更新镜像

进入项目目录, 执行以下命令

```bash
bash ./bin/update_docker_images.sh
```

## 查看分享链接

进入项目目录, 执行以下命令

```bash
bash ./bin/print_share_link.sh
```

## 修改端口

修改 conf/config.json

```json
// ...

  "inbounds": [
    {
      "listen": "0.0.0.0",
      "port": 8003,  // 修改为你想要的端口, 比如:9991
      "protocol": "vless",
			// ...
		}
  ]

//...
```

## 参考信息

- [xray 官方文档](https://xtls.github.io/)
- [xray 代码仓库](https://github.com/xtls/xray-core)
- [xray docker 镜像](https://hub.docker.com/r/teddysun/xray)
- [xray 安装命令](https://github.com/XTLS/Xray-install)