docs: 更新快速开始指南格式和内容

This commit is contained in:
Olia Lisa 2025-02-08 22:28:53 +08:00
parent 35a9f84893
commit 5cab57adf4

View File

@ -2,6 +2,7 @@
## 前提 ## 前提
提前安装好以下软件 提前安装好以下软件
- git
- curl - curl
- docker - docker
- docker-compose - docker-compose
@ -9,41 +10,53 @@
- qrencode - (可选, 非必要)用于生成二维码 - qrencode - (可选, 非必要)用于生成二维码
## 快速开始 ## 快速开始
1. 下载项目 1. 下载项目
```bash ```bash
git clone https://gitea.9001001.xyz/William/xray_docker.git git clone https://gitea.9001001.xyz/William/xray_docker.git
``` ```
2. 进入项目目录 2. 进入项目目录
```bash ```bash
cd xray_docker cd xray_docker
``` ```
3. 执行命令初始化配置并启动容器 3. 执行命令初始化配置并启动容器
```bash ```bash
bash ./bin/run.sh bash ./bin/run.sh
``` ```
## 停止 ## 停止
如果需要停止服务, 进入项目目录, 执行以下命令 如果需要停止服务, 进入项目目录, 执行以下命令
```bash ```bash
docker-compose down docker-compose down
``` ```
## 更新镜像 ## 更新镜像
进入项目目录, 执行以下命令 进入项目目录, 执行以下命令
```bash ```bash
bash ./bin/update_docker_images.sh bash ./bin/update_docker_images.sh
``` ```
## 查看分享链接 ## 查看分享链接
进入项目目录, 执行以下命令 进入项目目录, 执行以下命令
```bash ```bash
bash ./bin/print_share_link.sh bash ./bin/print_share_link.sh
``` ```
## 修改端口 ## 修改端口
修改conf/config.json 修改conf/config.json
```json ```json
// ... // ...
@ -60,6 +73,7 @@ bash ./bin/print_share_link.sh
``` ```
## 参考信息 ## 参考信息
- [xray官方文档](https://xtls.github.io/) - [xray官方文档](https://xtls.github.io/)
- [xray代码仓库](https://github.com/xtls/xray-core) - [xray代码仓库](https://github.com/xtls/xray-core)
- [xray docker镜像](https://hub.docker.com/r/teddysun/xray) - [xray docker镜像](https://hub.docker.com/r/teddysun/xray)