doc:readme更新

This commit is contained in:
李亮亮 2024-01-16 10:33:14 +08:00
parent 1ce47f6f62
commit a6f5920e95
1 changed files with 19 additions and 41 deletions

View File

@ -1,20 +1,15 @@
# roim-picx
### 预览地址
[roim-picx](https://roim.page)
> 该系统仅作为预览使用,每天有使用限额,请勿大量上传图片。不要使用该图床的地址作为生产使用,因为要定时删除。
### 一款基于Cloudflare的Worker、R2、Pages实现的图床应用具有以下特点
* 10GB的免费存储空间
* 每月300W次的不计流量的图片访问每天10W的限制。
* 每月100W次的图片上传次数
* 不需要自己购买服务器克隆代码后部署CloudFlare即可使用。
* 独立部署不需要担心被第三方删除数据。
## Token
> 4xVSYkCKw2ExbPNEaMPjCnaaOowU9sTf
### 已实现功能
* 图片批量上传
* 图片列表查询
* 图片删除
@ -23,42 +18,25 @@
* 链接地址点击复制
* 简单的身份认证功能,进入管理页面需要授权
### TODO
* 上传时支持选择目录。
* 提供删除图片的访问链接
* 管理页面支持分页加载图片
### 使用教程
* 1.fork项目到自己的github
* 2.注册CloudFlare并开通R2服务
![Upload](https://oss.tuqu.me/roim/blog/cf/r2.png)
* 3.找到Pages选项并且创建项目
![Upload](https://oss.tuqu.me/roim/blog/cf/pages1.png)
* 4.选择项目创建方式
![Upload](https://oss.tuqu.me/roim/blog/cf/pages2.png)
* 4.链接Github或GitLab并选需要构建的项目
![Upload](https://oss.tuqu.me/roim/blog/cf/pages3.png)
![Upload](https://oss.tuqu.me/roim/blog/cf/pages4.png)
* 5.设置环境变量
> 因为cloudflare默认的node版本较低需要手动指定版本否在会导致构建失败.
![Upload](https://oss.tuqu.me/roim/blog/cf/pages5.png)
* 6.设置项目的函数信息绑定R2和KV服务
![Upload](https://oss.tuqu.me/roim/blog/cf/pages6.png)
![Upload](https://oss.tuqu.me/roim/blog/cf/pages7.png)
* 7.构建项目,提示成功即可访问
![Upload](https://oss.tuqu.me/roim/blog/cf/pages8.png)
> 注意Pages的函数变量名称需要于项目的变量名称一直如果需要修改functions里面的Env名空间对应的文件是`[[path]].ts`
1. fork项目到自己的github
2. 创建Page项目
3. 输入编译参数
### 图床截图
![Upload](https://oss.tuqu.me/roim/blog/5.png)
![Preview](https://oss.tuqu.me/roim/blog/1.png)
![HTML](https://oss.tuqu.me/roim/blog/2.png)
![Markdown](https://oss.tuqu.me/roim/blog/3.png)
![Link](https://oss.tuqu.me/roim/blog/4.png)
![Manage](https://oss.tuqu.me/roim/blog/6.png)
1. 框架预设:无
2. 构建命令:`npm run build`
3. 输出目录:`dist`
4. 完成创建
5. 设置环境变量
### 项目参考来源
[1. cfworker-kv-image-hosting](https://github.com/realByg/cfworker-kv-image-hosting)
1. `AUTH_TOKEN`:授权码
2. `COPY_URL`:复制的路径,如无,则输入`page域名/rest`
6. 绑定R2
[2. HikariSearch](https://github.com/mixmoe/HikariSearch)
1. 变量名为:`R2`
7. 重新部署
---
项目fork自[roimdev/roim-picx](https://github.com/roimdev/roim-picx)