diff --git a/README.md b/README.md index ced32c4..e49ffe6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ ## 前提 提前安装好以下软件 +- git - curl - docker - docker-compose @@ -9,41 +10,53 @@ - 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 // ... @@ -60,6 +73,7 @@ bash ./bin/print_share_link.sh ``` ## 参考信息 + - [xray官方文档](https://xtls.github.io/) - [xray代码仓库](https://github.com/xtls/xray-core) - [xray docker镜像](https://hub.docker.com/r/teddysun/xray)