Skip to content

Commit fee73cf

Browse files
committed
docs: update README to clarify TOKEN usage and provide Docker image update instructions
1 parent 64e02ac commit fee73cf

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,15 @@
2222
TOKEN=YOUR_TOKEN # Optional
2323
```
2424

25+
TOKEN 类似于密码,如果设置,则只有拥有该令牌的请求才能使用该服务。
26+
2527
### Vercel
2628

2729
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fyy4382%2Fread-aloud&env=TOKEN&envDescription=%E7%B1%BB%E4%BC%BC%E4%BA%8E%E5%AF%86%E7%A0%81%EF%BC%8C%E9%98%B2%E6%AD%A2%E4%BB%96%E4%BA%BA%E6%BB%A5%E7%94%A8%E4%BD%A0%E7%9A%84%E6%9C%8D%E5%8A%A1&project-name=read-aloud&repository-name=read-aloud)
2830

2931
框架(Framework) 选择 Other,几个 Command 都保持不动(不要 Override)。
3032

31-
环境变量 TOKEN 设置为字母、数字、下划线和连字符的组合(其他特殊字符未被测试是否可用)。
33+
环境变量 TOKEN 设置为字母、数字、下划线和连字符的组合(其他特殊字符未被测试是否可用)。TOKEN 类似于密码,如果设置,则只有拥有该令牌的请求才能使用该服务。
3234

3335
### Node.js (Docker)
3436

@@ -38,6 +40,18 @@ docker run -d --name read-aloud -p 3000:3000 -e TOKEN=YOUR_TOKEN yunfinibol/read
3840

3941
记得将 `YOUR_TOKEN` 替换为你的实际令牌。
4042

43+
TOKEN 类似于密码,如果设置,则只有拥有该令牌的请求才能使用该服务。
44+
45+
更新 Docker 镜像:
46+
47+
```bash
48+
# 获取最新镜像
49+
docker pull yunfinibol/read-aloud:main
50+
# 重启容器
51+
docker rm -f read-aloud
52+
docker run -d --name read-aloud -p 3000:3000 -e TOKEN=YOUR_TOKEN yunfinibol/read-aloud:main
53+
```
54+
4155
## API 参考
4256

4357
Swagger 文档:<https://ra.yfi.moe/api/ui>

0 commit comments

Comments
 (0)