Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions docs/DEPLOY.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,36 @@
# 部署

项目目前处于开发阶段,文档可能未及时更新或存在描述不清,如遇部署失败请提 [Issue](https://github.com/OXeu/Rin/issues/new?assignees=&labels=help+wanted&projects=&template=need-help.md&title=%5BHelp%5D+%E9%97%AE%E9%A2%98%E6%8F%8F%E8%BF%B0)

## 更新日志
### v0.2.0 2024-06-07 更新
* 新增 `S3_CACHE_FOLDER` 环境变量
* 环境变量加密列表与变量列表更新,仅保留必须加密的环境变量
* 加密变量现在可以通过 Github 直接配置
* Github 变量配置更新,新增必须通过 Github 配置的加密变量(S3 存储,用于 SEO 索引保存)

## 迁移指南
无特别说明时正常的版本更新直接同步 frok 的仓库即可

### v0.2.0 迁移指南
* 由于引入 SEO 优化导致需要在 Github 中配置 S3 存储的环境变量,因此需要额外在 Github 中配置以下环境变量(明文,添加到 Variables):
```ini
SEO_BASE_URL=<SEO 基础地址,用于 SEO 索引,默认为 FRONTEND_URL>
SEO_CONTAINS_KEY=<SEO 索引时只索引以 SEO_BASE_URL 开头或包含SEO_CONTAINS_KEY 关键字的链接,默认为空>
S3_FOLDER=<S3 图片资源存储的文件夹,默认为 'images/'>
S3_CACHE_FOLDER=<S3 缓存文件夹(用于 SEO、高频请求缓存),默认为 'cache/'>
S3_BUCKET=<S3 存储桶名称>
S3_REGION=<S3 存储桶所在区域,如使用 Cloudflare R2 填写 auto 即可>
S3_ENDPOINT=<S3 存储桶接入点地址>
S3_ACCESS_HOST=<S3 存储桶访问地址,末尾无'/'>
```
同时添加以下加密环境变量(加密,添加到 Secrets):
```ini
S3_ACCESS_KEY_ID=<你的S3AccessKeyID>
S3_SECRET_ACCESS_KEY=<你的S3SecretAccessKey>
```
以上环境变量在之前的版本中是通过 Cloudflare 面板配置的,现在需要迁移到 Github 中配置,新版本的部署 Github Action 会自动其上传到 Cloudflare,之后就不再需要在 Cloudflare 面板中配置这些环境变量了


## 其他文档
[环境变量列表](./ENV.md)
Expand Down Expand Up @@ -137,10 +161,10 @@ S3_ACCESS_HOST=<S3 存储桶访问地址,末尾无'/'>
>
> ~~在 `设置` > `变量` > `环境变量` 处编辑变量,点击添加变量,复制粘贴以下内容至变量名处即可自动添加上所有环境变量,之后再根据自己的具体配置修改变量值:~~
在 v0.2.0 版本后,以下所有环境变量都建议通过在 Github 创建对应的密钥来添加,添加方式与上文添加 `CLOUDFLARE_ACCOUNT_ID` 与 `CLOUDFLARE_API_TOKEN` 相同,以下是环境变量列表:
```
```ini
GITHUB_CLIENT_ID=<你的GithubClientID>
GITHUB_CLIENT_SECRET=<你的GithubClientSecret>
JWT_SECRET=<JWT密钥>
JWT_SECRET=<JWT 认证所需密钥,可为常规格式的任意密码>
S3_ACCESS_KEY_ID=<你的S3AccessKeyID>
S3_SECRET_ACCESS_KEY=<你的S3SecretAccessKey>
```
Expand Down