📄更新文档,添加分支部署教程

This commit is contained in:
柳神 2024-09-05 10:41:25 +08:00
parent 3218da91ce
commit 7aafd5a912
7 changed files with 46 additions and 20 deletions

1
main/fclite.min.css vendored

File diff suppressed because one or more lines are too long

1
main/fclite.min.js vendored

File diff suppressed because one or more lines are too long

View File

@ -10,24 +10,30 @@
## 开发进度
### 2024-09-05
* 更新部署方式将静态文件放到page分支下主分支不放数据文件
* 前后端分离,部署方式不变但更加直观方便
### 2024-09-03
* 添加特定RSS选项用于指定部分友链特殊RSS地址
* 更新文档添加特定RSS选项配置部分
### 2024-08-28
<details>
<summary>查看更多</summary>
<h3>2024-08-28</h3>
* 日常维护修复issue中提出的时间为空导致错误的情况使用更新时间代替
### 2024-08-11
<h3>2024-08-11</h3>
* 添加服务器部署的情况下合并github结果的选项
* 由于复杂性,决定将服务和定时抓取分开,使用面板自带进行配置,防止小白无法配置
* 修改文档,添加自部署部分
<details>
<summary>查看更多</summary>
<h3>2024-08-03</h3>
* 将自部署分离为API服务和定时爬取
@ -68,6 +74,7 @@
- **爬取文章**: 爬取所有友链的文章结果放置在根目录的all.json文件中方便读取并部署到前端。
- **邮箱推送更新(对作者推送所有友链更新)**: 作者可以通过邮箱订阅所有rss的更新未来开发
- **issue邮箱订阅(对访客实时推送最新文章邮件)**: 基于`GitHub issue`的博客更新邮件订阅功能,游客可以通过简单的提交`issue`进行邮箱订阅站点更新,删除对应`issue`即可取消订阅。
- **文件分离**: 将前后端分离前端文件放在page分支后端文件放在主分支
## 特点介绍
@ -86,33 +93,34 @@
* 邮箱推送
* 美观邮箱模板
* 自部署(2024-08-11添加)
* 前端单开分支(2024-09-05添加) @CCKNBC
## action部署使用方法
### 前置工作
1. **Fork 本仓库:**
点击页面右上角的 Fork 按钮,将本仓库复制到你自己的`GitHub`账号下。
点击页面右上角的 Fork 按钮,将本仓库复制到你自己的`GitHub`账号下仅复刻main分支即可。
![](./static/fork.png)
2. **配置 Secrets:**
在你 Fork 的仓库中,依次进入 `Settings` -> `Secrets` -> `New repository secret`,添加以下 Secrets
- `PAT_TOKEN`: GitHub 的个人访问令牌,用于访问 GitHub API。
- `SMTP_PWD`: SMTP 服务器的密码,用于发送电子邮件。
- `SMTP_PWD`(可选): SMTP 服务器的密码,用于发送电子邮件,如果你不需要,可以不进行配置。
![](./static/1.png)
2. **配置action权限**
3. **配置action权限**
在设置中,点击`action`,拉到最下面,勾选`Read and write permissions`选项并保存确保action有读写权限。
3. **启用 GitHub Actions:**
4. **启用 GitHub Actions:**
GitHub Actions 已经配置好在仓库的 `.github/workflows/*.yml` 文件中,当到一定时间时将自动执行,也可以手动运行。
其中每个action功能如下
- `friend_circle_lite.yml`实现核心功能,爬取并发送邮箱;
- `friend_circle_lite.yml`实现核心功能,爬取并发送邮箱需要在Action中启用
- `deal_subscribe_issue.yml`处理固定格式的issue打上固定标签评论并关闭issue
4. **设置issue格式**
5. **设置issue格式**
这个我已经设置好了你只需要检查issue部分是否有对应格式即可可以自行修改对应参数以进行自定义。
### 配置选项
@ -138,7 +146,7 @@
`article_count`:每个作者留存文章个数。
`marge_result`是否合并多个json文件若为true则会合并指定网络地址和本地地址的json文件
`marge_result`是否合并多个json文件若为true则会合并指定网络地址和本地地址的json文件并去重
- `enable`:是否启用合并功能,该功能提供与自部署的友链合并功能,可以解决服务器部分国外网站,服务器无法访问的问题
@ -174,7 +182,7 @@
`github_repo`:仓库名称,作用同上。
`your_blog_url`:用来定时检测是否有最新文章
`your_blog_url`:用来定时检测是否有最新文章请确保你的网站可以被FCLite抓取到
- **SMTP 配置**
使用配置中的相关信息实现邮件发送功能。
@ -197,7 +205,7 @@
这部分配置较为复杂,请自行学习使用。
- ** 特定RSS配置 **
- **特定 RSS 配置**
用于指定特定友链特殊RSS样例如下
@ -216,8 +224,12 @@
2. **贡献与定制:**
欢迎对仓库进行贡献或根据需要进行定制。
**如果你配置正常那么等action运行一次可以手动运行应该就可以在page分支看到结果了检查一下如果结果无误可以继续看下一步**
### 友圈json生成
**注意以下可能仅适用于hexo-theme-butterfly或部分类butterfly主题如果你是其他主题可以自行适配理论上只要存在友链数据文件都可以整理为该类型甚至可以自行整理为对应json格式后放到 `/source` 目录下即可,格式可以参考:`https://blog.qyliu.top/friend.json` **
1. 将以下文件放置到博客根目录:
```javascript
@ -272,11 +284,27 @@
如果是github action可以在hexo g脚本前添加即可完整构建注意需要安装yaml包才可解析yml文件。
## 部署到网页
## 部署静态网站
首先将该项目部署到vercel部署到vercel的目的主要是利用vercel检测仓库并实时刷新的功能及时获取all.json文件内容。任意平台均可。
首先将该项目部署到vercel部署到vercel等平台的目的主要是检测仓库变动并实时更新数据及时获取all.json文件内容。任意平台均可但是注意部署的分支为page分支
部署完成后,你将获得一个地址,建议自行绑定域名。
1. vercel 部署完成后,检查对应页面,如果页面中没有数据,且 `/all.json` 路径无法访问可能是部署到main分支了可以通过 `setting-git-Production Branch` 填写为page并重新进行部署即可
![](./static/vercel.png)
2. zeabur 可以在部署时直接选择分支:
![](./static/zeabur.png)
3. CloudFlare Page 也可以在构建时即选择对应的分支,这里不再细讲。
![](./static/cloudflare.png)
部署完成后你将获得一个地址如果是通过vercel部署的建议自行绑定域名。
检查 `https://example.com/all.json` 是否有数据,如果有,则部署成功。
## 部署到你的页面
在前端页面的md文件中写入

BIN
static/cloudflare.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

BIN
static/fork.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

BIN
static/vercel.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 373 KiB

BIN
static/zeabur.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 264 KiB