From fad1cb8255c322525bcae076359a8ec49a5552b2 Mon Sep 17 00:00:00 2001 From: cf-pages <80505777+cf-pages@users.noreply.github.com> Date: Wed, 18 Jan 2023 20:30:20 +0000 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README=E6=B7=BB=E5=8A=A0?= =?UTF-8?q?=E6=96=B0=E7=89=88=E6=9C=AC=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 81 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7dcb9660d..21c66f0d8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Telegraph-Image -免费图片托管解决方案，Flickr/imgur替代品。使用Cloudflare页面和Telegraph。 +免费图片托管解决方案，Flickr/imgur替代品。使用Cloudflare Pages和Telegraph。 [English](README.md)|中文 @@ -11,7 +11,7 @@ ### 手把手教程 简单3步，即可部署本项目，拥有自己的图床 -1.下载或是Fork本仓库 ~~(Fork的时候如果能顺手点下旁边的Star就更好了❤)~~ +1.下载或Fork本仓库 (注意：目前请使用fork，在使用下载[#14](https://github.com/cf-pages/Telegraph-Image/issues/14)部署存在问题) 2.打开Cloudflare Dashboard，进入Pages管理页面，选择创建项目，如果在第一步中选择的是fork本仓库，则选择`连接到 Git 提供程序`，如果第一步中选择的是下载本仓库则选择`直接上传` ![1](https://telegraph-image.pages.dev/file/8d4ef9b7761a25821d9c2.png) @@ -27,6 +27,8 @@ 4.支持图片审查API，可根据需要开启，开启后不良图片将自动屏蔽，不再加载 +5.支持后台图片管理，可以对上传的图片进行在线预览，添加白名单，黑名单等操作 + ### 绑定自定义域名 在pages的自定义域里面，绑定cloudflare中存在的域名，在cloudflare托管的域名，自动会修改dns记录 ![2](https://telegraph-image.pages.dev/file/29546e3a7465a01281ee2.png) @@ -48,11 +50,87 @@ 2.由于使用Cloudflare的网络，图片的加载速度在某些地区可能得不到保证 -3.Cloudflare Function免费版每日限制100,000个请求（即上传或是加载图片的总次数不能超过100,000次）如超过可能需要选择购买Cloudflare Function的付费套餐 +3.Cloudflare Function免费版每日限制100,000个请求（即上传或是加载图片的总次数不能超过100,000次）如超过可能需要选择购买Cloudflare Function的付费套餐，如开启图片管理功能还会存在KV操作数量的限制，如超过需购买付费套餐 ### 感谢 Hostloc @feixiang和@乌拉擦 提供的思路和代码 +## 更新日志 +2023年1月18日--图片管理功能更新 + +1、支持图片管理功能，默认是关闭的，如需开启请部署完成后前往后台依次点击`设置`->`函数`->`KV 命名空间绑定`->`编辑绑定`->`变量名称`填写：`img_url` `KV 命名空间` 选择你提前创建好的KV储存空间，开启后访问http(s)://你的域名/admin 即可打开后台管理页面 +| 变量名称 | KV 命名空间 | +| ----------- | ----------- | +| img_url | 选择提前创建好的KV储存空间 | + +![](https://im.gurl.eu.org/file/a0c212d5dfb61f3652d07.png) +![](https://im.gurl.eu.org/file/48b9316ed018b2cb67cf4.png) + +2、后台管理页面新增登录验证功能，默认也是关闭的，如需开启请部署完成后前往后台依次点击`设置`->`环境变量`->`为生产环境定义变量`->`编辑变量` 添加如下表格所示的变量即可开启登录验证 +| 变量名称 | 值 | +| ----------- | ----------- | +|BASIC_USER = | <后台管理页面登录用户名称>| +|BASIC_PASS = | <后台管理页面登录用户密码>| + +![](https://im.gurl.eu.org/file/dff376498ac87cdb78071.png) + +当然你也可以不设置这两个值，这样访问后台管理页面时将无需验证，直接跳过登录步骤，这一设计使得你可以结合Cloudflare Access进行使用，实现支持邮件验证码登录，Microsoft账户登录，Github账户登录等功能，能够与你域名上原有的登录方式所集成，无需再次记忆多一组后台的账号密码，添加Cloudflare Access的方式请参考官方文档，注意需要保护路径包括/admin 以及 /api/manage/* + +3、新增图片总数量统计 +当开启图片管理功能后，可在后台顶部查看记录中的图片数量 + +![](https://im.gurl.eu.org/file/b7a37c08dc2c504199824.png) + +4、新增图片文件名搜索 +当开启图片管理功能后，可在后台搜索框使用图片文件名称，快速搜索定位需要管理的图片 + +![](https://im.gurl.eu.org/file/faf6d59a7d4a48a555491.png) + +5、新增图片状态显示 +当开启图片管理功能后，可在后台查看图片当前的状态{ "ListType": "None", "TimeStamp": 1673984678274 } +ListType代表图片当前是否在黑白名单当中，None则表示既不在黑名单中也不在白名单中，White表示在在白名单中，Block表示在黑名单中，TimeStamp为图片首次加载的时间戳，如开启的图片审查API，则这里还会显示图片审查的结果用Label标识 + +![](https://im.gurl.eu.org/file/6aab78b83bbd8c249ee29.png) + +6、新增黑名单功能 +当开启图片管理功能后，可在后台手动为图片加入黑名单，加入黑名单的图片将无法正常加载 + +![](https://im.gurl.eu.org/file/fb18ef006a23677a52dfe.png) + +7、新增白名单功能 +当开启图片管理功能后，可在后台手动为图片加入白名单，加入白名单的图片无论如何都会正常加载，可绕过图片审查API的结果 + +![](https://im.gurl.eu.org/file/2193409107d4f2bcd00ee.png) + +8、新增记录删除功能 +当开启图片管理功能后，可在后台手动删除图片记录，即不再后台显示该图片，除非有人再次上传并加载该图片，注意由于图片储存在telegraph的服务器上，我们无法删除上传的原始图片，只能通过上述第6点的黑名单功能屏蔽图片的加载 + +9、新增程序运行模式：白名单模式 +当开启图片管理功能后，除了默认模式外，这次更新还新增了一项新的运行模式，在该模式下，只有被添加进白名单的图片才会被加载，上传的图片需要审核通过后才能展示，最大程度的防止不良图片的加载，如需开启请设置环境变量：WhiteList_Mode=="true" + +10、新增后台图片预览功能 +当开启图片管理功能后，可在后台预览通过你的域名加载过的图片，点击图片可以进行放大，缩小，旋转等操作 + +![](https://im.gurl.eu.org/file/740cd5a69672de36133a2.png) + +## 已经部署了的，如何更新？ +其实更新非常简单，只需要参照上面的更新内容，先进入到Cloudflare Pages后台，把需要使用的环境变量提前设置好并绑定上KV命名空间，然后去到Github你之前fork过的仓库依次选择`Sync fork`->`Update branch`即可，稍等一会，Cloudflare Pages那边检测到你的仓库更新了之后就会自动部署最新的代码了 + +## 一些限制： +Cloudflare KV每天只有1000次的免费写入额度，每有一张新的图片加载都会占用该写入额度，如果超过该额度，图片管理后台将无法记录新加载的图片 + +每天最多 100,000 次免费读取操作，图片每加载一次都会占用该额度（在没有缓存的情况下，如果你的域名在Cloudflare开启了缓存，当缓存未命中时才会占用该额度），超过黑白名单等功能可能会失效 + +每天最多 1,000 次免费删除操作，每有一条图片记录都会占用该额度，超过将无法删除图片记录 + +每天最多 1,000 次免费列出操作，每打开或刷新一次后台/admin都会占用该额度，超过将进行后台图片管理 + +绝大多数情况下，该免费额度都基本够用，并且可以稍微超出一点，不是已超出就立马停用，且每项额度单独计算，某项操作超出免费额度后只会停用该项操作，不影响其他的功能，即即便我的免费写入额度用完了，我的读写功能不受影响，图片能够正常加载，只是不能在图片管理后台看到新的图片了。 + +如果你的免费额度不够用，可以自行向Cloudflare购买Cloudflare Workers的付费版本，每月$5起步，按量收费，没有上述额度限制 + +另外针对环境变量所做的更改将在下次部署时生效，如更改了`环境变量`，针对某项功能进行了开启或关闭，请记得重新部署。 +![](https://im.gurl.eu.org/file/b514467a4b3be0567a76f.png)