From 6749bf41a5c4ceedb79a298f00bccc028f4ef4e9 Mon Sep 17 00:00:00 2001 From: MarSeventh <1193267292@qq.com> Date: Sat, 14 Jun 2025 23:50:39 +0800 Subject: [PATCH] update readme --- README.md | 135 ++++++--------------------------------------------- README_en.md | 121 +++------------------------------------------ 2 files changed, 22 insertions(+), 234 deletions(-) diff --git a/README.md b/README.md index 606d3b4..be98dfb 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,6 @@ > > **v2.0 版本升级注意事项请查看公告！** -**🚀项目官网**：[CloudFlare ImgBed](https://cfbed.sanyue.de/) -
@@ -50,9 +48,13 @@ 1. 部署使用出现问题，请先仔细查阅文档、常见问题解答以及已有issues。 -2. **前端仓库**：[MarSeventh/Sanyue-ImgHub](https://github.com/MarSeventh/Sanyue-ImgHub) +2. **体验地址**：[CloudFlare ImgBed](https://cfbed.1314883.xyz/) -3. **注意**：本仓库为[Telegraph-Image](https://github.com/cf-pages/Telegraph-Image)项目的重制版，如果你觉得本项目不错，在支持本项目的同时，也请支持原项目。 +> 访问码：cfbed + +3. **前端仓库**：[MarSeventh/Sanyue-ImgHub](https://github.com/MarSeventh/Sanyue-ImgHub) + +4. **注意**：本仓库为[Telegraph-Image](https://github.com/cf-pages/Telegraph-Image)项目的重制版，如果你觉得本项目不错，在支持本项目的同时，也请支持原项目。 ## 2025.2.6 V2.0 版本升级注意事项 @@ -79,34 +81,14 @@
-
- 生态建设 - - - -## 1. 插件 - -- **编辑器内自动上传（油猴脚本）**：https://greasyfork.org/zh-CN/scripts/529816-image-uploader-to-markdown-to-cloudflare-imgbed （_作者：Linux.do: [calg_c](https://linux.do/u/calg_c/summary)_） - -## 2.仓库 - -- **向TG BOT发送文件上传图床**：[uki0xc/img-up-bot: 使用telegram机器人链接图床进行上传](https://github.com/uki0xc/img-up-bot?tab=readme-ov-file) （_作者：[uki0xc](https://github.com/uki0xc)_) - - - -
- 体验地址及优质博文、视频 + 优质博文、视频 -**体验地址**：[CloudFlare ImgBed](https://cfbed.1314883.xyz/) - -> 访问码：cfbed - **体验视频**：[CloudFlare免费图床，轻松守护你的每一份精彩！_哔哩哔哩_bilibili](https://www.bilibili.com/video/BV1y3WGe4EGh/?vd_source=da5ecbe595e41089cd1bed95932b8bfd) -**相关教程视频**： +**相关视频教程**： - [利用Cloudflare R2 +Pages搭建在线图床系统，不限空间，不被墙，超级简单，完全免费 (youtube.com)](https://www.youtube.com/watch?v=T8VayuUMOzM) @@ -123,14 +105,13 @@ -## 最近更新 +## 最近更新（[更新日志](https://cfbed.sanyue.de/guide/update-log.html)）： Add Features: - 美化报错图片 - 上传页面支持预览ico等更多格式文件 -更新日志：https://cfbed.sanyue.de/guide/update-log.html # 1.Introduction @@ -138,8 +119,9 @@ Add Features: ![CloudFlare](static/readme/海报.png) -# 2.[Deployment and Q&A](https://cfbed.sanyue.de/guide/quick-start.html) +# 2.[Document](https://cfbed.sanyue.de) +提供详细的部署文档、功能文档、开发计划、常见问题解答等，帮助您快速上手。 # 3.Show @@ -160,97 +142,8 @@ Add Features:
-# 4.TODO -## 4.1Add Features💕 - -
- 功能更新列表 - - -1. :white_check_mark: ~~增加粘贴图片上传功能~~（2024.7.22已完成） -2. :white_check_mark:~~增加markdown、html等格式链接复制功能~~（2024.7.21已完成） -3. :white_check_mark:~~上传页面增加管理端入口~~（2024.7.21已完成） -4. :memo:增加用户个性化配置接口 - - ~~登录页面和上传页面背景图自定义~~（2024.8.25已完成） - - ~~图床名称和Logo自定义~~（2024.8.26已完成） - - ~~网站标题和Icon自定义~~（2024.8.26已完成） - - ~~背景切换时间自定义~~（2024.9.11已完成） - - ~~背景透明度支持自定义~~（2024.9.12已完成） - - ~~页脚自定义传送门~~（2024.10.20已完成） - - ~~全局自定义链接前缀~~（2024.12.27已完成） - - ~~可隐藏页脚~~（2025.2.4已完成） -5. :white_check_mark:~~增加随机图API~~（2024.7.25已完成） -6. :white_check_mark:~~完善多格式链接展示形式，增加ubb格式链接支持~~（2024.8.21已完成） -7. :white_check_mark:~~完善登录逻辑，后端增加认证码校验接口~~（2024.8.21已完成） -8. :white_check_mark:~~支持URL粘贴上传~~（2024.8.23已完成） -9. :white_check_mark:~~支持大于5MB的图片上传前自动压缩~~（2024.8.26已完成） -10. :white_check_mark:~~上传页面右下角工具栏样式重构，支持上传页自定义压缩（上传前+存储端）~~（2024.9.28已完成） -11. :white_check_mark:~~重构管理端，认证+显示效果优化，增加图片详情页~~（2024.12.20已完成） -12. :white_check_mark:~~管理端增加访问量统计，IP记录、IP黑名单、上传IP黑名单等~~（2024.12.20已支持上传ip黑名单，访问记录由于对KV读写消耗太大，暂时搁置） -13. :white_check_mark:~~上传页面点击链接，自动复制到剪切板~~(2024.9.27已完成) -14. :white_check_mark:~~上传设置记忆（上传方式、链接格式等）~~（2024.9.27已完成，**两种上传方式合并**） -15. :white_check_mark:~~若未设置密码，无需跳转进入登录页~~（2024.9.27已完成） -16. :white_check_mark:~~增加仅删除上传成功图片、上传失败图片重试~~（2024.9.28已完成） -17. :white_check_mark:~~优化粘贴上传时文件命名方法~~（2024.9.26已完成） -18. :white_check_mark:~~增加对R2 bucket的支持~~（2024.11.5已完成） -19. :white_check_mark:~~管理端增加批量黑名单、白名单功能~~（2024.12.14已完成） -20. :white_check_mark:~~Telegram Channel渠道上传文件记录机器人和频道数据，便于迁移和备份~~（2024.12.4已完成） -21. :white_check_mark:~~支持自定义命名方式（仅原名 or 仅随机前缀 or 默认的随机前缀\_原名）~~（2024.12.4已完成） -22. :white_check_mark:~~支持上传失败自动切换其他渠道尝试~~（2024.12.12已完成） -23. :white_check_mark:~~后端list接口实现分页功能~~（2024.2.5已完成） -24. :white_check_mark:~~支持自定义链接前缀~~（2024.12.4已完成） -25. :memo:对接alist，或实现webdav（评估中） -26. :white_check_mark:~~文件详情增加文件大小记录~~（2024.12.10已完成） -27. :white_check_mark:~~支持管理员自定义全局默认链接前缀~~（2025.2.1已完成） -28. :white_check_mark:~~开放更多文件格式~~（2024.12.9已完成） -29. :white_check_mark:~~进行删除、加入白名单、加入黑名单等操作时，自动清除CF CDN缓存，避免延迟生效~~（2024.12.11已完成） -30. :white_check_mark:~~管理端批量选择时，记录用户选择的顺序~~（2024.12.20已完成） -31. :memo:上传图片支持自定义上传路径，支持相册功能 - - ~~文件夹删除功能~~（2025.3.6已完成） - - ~~文件位置移动功能~~（2025.3.7已完成） - - ~~管理端加载更多数据时鬼打墙问题修复~~（2025.3.6已完成） - - ~~管理端批量操作适配文件夹~~（2025.3.6已完成） - - ~~管理端分页逻辑调整~~（2025.3.6已完成） -32. :white_check_mark:~~支持多个 Telegram Bot Token 负载均衡~~（2025.2.4已完成） -33. :white_check_mark:~~管理端提供详细的设置信息和设置方式引导~~（2025.2.5已完成） -34. :white_check_mark:~~Logo焕新、登录页面优化、设置提示项等多项展示效果优化~~（2025.2.2已完成） -35. :white_check_mark:~~接入S3 API渠道~~（2024.2.3已完成） -36. :white_check_mark:~~支持短链接命名方式~~（2025.2.1已完成） -37. :white_check_mark:~~支持深色模式~~（2025.1.11已完成） -38. :hourglass_flowing_sand:支持KV备份恢复功能 -39. :white_check_mark:~~页脚可自定义隐藏~~（2025.2.4已完成） -40. :hourglass_flowing_sand:搜索功能增强 -41. :white_check_mark:支持粘贴多个链接，支持外链管理 -42. :hourglass_flowing_sand:上传文件记录MD5，支持文件硬链接 -43. :hourglass_flowing_sand:上传页面增加最近上传展示 -44. :hourglass_flowing_sand:支持从后台管理处配置上传页默认设置 -45. :white_check_mark:增加公告功能 -46. :hourglass_flowing_sand:支持访问图片时设置宽高参数 -47. :hourglass_flowing_sand:支持上传时转换图片格式 - -
- -## 4.2Fix Bugs👻 - -
- Bug修复列表 - - -1. :white_check_mark:~~修复API上传无法直接展示在后台的问题~~（2024.7.25已修复） -1. :white_check_mark:~~由于telegra.ph关闭上传，迁移至TG频道上传~~（2024.9.7已修复） -1. :white_check_mark:~~修复未设管理员认证时管理端无限刷新的问题~~（2024.9.9已修复） -1. :white_check_mark:~~修复部分视频无法预览播放的问题~~（经测试，暂定为文件自身存在问题，暂无法修复） -1. :hourglass_flowing_sand:增加新的图片审查渠道 -1. :white_check_mark:~~R2渠道在管理端删除时，存储桶同步删除~~（2024.12.4已修复） -1. :white_check_mark:~~读取文件响应头增加允许跨域头`access-control-allow-origin: *`~~（2024.12.9已修复） -1. :white_check_mark:~~上传界面加入访问限制白名单~~（2024.12.11已修复） -1. :white_check_mark:修复文件名过长挡住操作按钮的问题 -1. :white_check_mark:修复`list`接口返回数据完整性问题 - -
- -# 5.Tips +# 4.Tips - 前端开源，参见[MarSeventh/Sanyue-ImgHub](https://github.com/MarSeventh/Sanyue-ImgHub)项目。 @@ -275,13 +168,13 @@ Add Features: [![Contributors](https://contrib.rocks/image?repo=Marseventh/Cloudflare-ImgBed)](https://github.com/MarSeventh/CloudFlare-ImgBed/graphs/contributors) -# 6.Star History +# 5.Star History **如果觉得项目不错希望您能给个免费的star✨✨✨，非常感谢！** [![Star History Chart](https://api.star-history.com/svg?repos=MarSeventh/CloudFlare-ImgBed,MarSeventh/Sanyue-ImgHub&type=Date)](https://star-history.com/#MarSeventh/CloudFlare-ImgBed&MarSeventh/Sanyue-ImgHub&Date) -# 7.Special Sponsors +# 6.Special Sponsors - **[亚洲云](https://www.asiayun.com/)**：提供云计算服务资源支持（高防服务器|福州高防|广东电信|香港服务器|美国服务器|海外服务器） diff --git a/README_en.md b/README_en.md index 0e3c17a..5bef369 100644 --- a/README_en.md +++ b/README_en.md @@ -68,24 +68,7 @@
- Ecosystem - -## 1. Plugins - -- **Auto upload inside editor (Tampermonkey script)**: https://greasyfork.org/zh-CN/scripts/529816-image-uploader-to-markdown-to-cloudflare-imgbed (Author: Linux.do: [calg_c](https://linux.do/u/calg_c/summary)) - -## 2. Repositories - -- **Upload files to image hosting via TG BOT**: [uki0xc/img-up-bot: Upload using Telegram bot linked image hosting](https://github.com/uki0xc/img-up-bot?tab=readme-ov-file) (Author: [uki0xc](https://github.com/uki0xc)) - -
- -
- Experience Links and Quality Blogs/Videos - -**Experience site**: [CloudFlare ImgBed](https://cfbed.1314883.xyz/) - -> Access code: cfbed + Quality Blogs & Videos **Experience video**: [CloudFlare Free Image Hosting, easily protect your every wonderful moment! _ Bilibili](https://www.bilibili.com/video/BV1y3WGe4EGh/?vd_source=da5ecbe595e41089cd1bed95932b8bfd) @@ -104,22 +87,22 @@
-## Recent Updates +## Recent Updates ([Update Log](https://cfbed.sanyue.de/guide/update-log.html)): Add Features: - Beautify error images - Upload page supports preview of ico and more formats -Update log: https://cfbed.sanyue.de/guide/update-log.html - # 1. Introduction Free file hosting solution with full lifecycle features including **upload**, **management**, **read**, and **delete**, supporting **authentication**, **directories**, **image moderation**, **random images**, and other features (see [Feature Docs](https://cfbed.sanyue.de/guide/features.html) for details). ![CloudFlare](static/readme/海报.png) -# 2. [Deployment and Q&A](https://cfbed.sanyue.de/guide/quick-start.html) +# 2. [Document](https://cfbed.sanyue.de) + +Provides detailed deployment documentation, feature docs, development plans, FAQ, and more to help you get started quickly. # 3. Show @@ -138,95 +121,7 @@ Free file hosting solution with full lifecycle features including **upload**, ** -# 4. TODO - -## 4.1 Add Features 💕 - -
- Feature update list - -1. :white_check_mark: ~~Add paste image upload feature~~ (completed 2024.7.22) -2. :white_check_mark: ~~Add markdown, html format link copy~~ (completed 2024.7.21) -3. :white_check_mark: ~~Add admin panel entry on upload page~~ (completed 2024.7.21) -4. :memo: Add user customization interface - - ~~Custom login and upload page backgrounds~~ (completed 2024.8.25) - - ~~Custom image hosting name and logo~~ (completed 2024.8.26) - - ~~Custom website title and icon~~ (completed 2024.8.26) - - ~~Custom background switch interval~~ (completed 2024.9.11) - - ~~Custom background opacity~~ (completed 2024.9.12) - - ~~Custom footer portal~~ (completed 2024.10.20) - - ~~Global custom link prefix~~ (completed 2024.12.27) - - ~~Footer hide option~~ (completed 2025.2.4) -5. :white_check_mark: ~~Add random image API~~ (completed 2024.7.25) -6. :white_check_mark: ~~Improve multi-format link display, add UBB support~~ (completed 2024.8.21) -7. :white_check_mark: ~~Improve login logic, add backend auth code verification~~ (completed 2024.8.21) -8. :white_check_mark: ~~Support URL paste upload~~ (completed 2024.8.23) -9. :white_check_mark: ~~Auto compress images >5MB before upload~~ (completed 2024.8.26) -10. :white_check_mark: ~~Restyle upload page toolbar, support custom compression~~ (completed 2024.9.28) -11. :white_check_mark: ~~Refactor admin, add authentication and display optimization, add image detail page~~ (completed 2024.12.20) -12. :white_check_mark: ~~Add visit statistics, IP record, IP blacklist, upload IP blacklist in admin~~ (upload IP blacklist done, visit record postponed) -13. :white_check_mark: ~~Auto copy link on upload page click~~ (completed 2024.9.27) -14. :white_check_mark: ~~Upload settings memory (method, link format)~~ (completed 2024.9.27, merged upload methods) -15. :white_check_mark: ~~No password set, no redirect to login~~ (completed 2024.9.27) -16. :white_check_mark: ~~Add delete only successful uploads, retry failed uploads~~ (completed 2024.9.28) -17. :white_check_mark: ~~Optimize file naming on paste upload~~ (completed 2024.9.26) -18. :white_check_mark: ~~Add R2 bucket support~~ (completed 2024.11.5) -19. :white_check_mark: ~~Add batch blacklist and whitelist in admin~~ (completed 2024.12.14) -20. :white_check_mark: ~~Telegram Channel upload records bot and channel data for migration/backup~~ (completed 2024.12.4) -21. :white_check_mark: ~~Support custom naming methods~~ (completed 2024.12.4) -22. :white_check_mark: ~~Support auto retry with other channels on upload failure~~ (completed 2024.12.12) -23. :white_check_mark: ~~Backend list API pagination~~ (completed 2024.2.5) -24. :white_check_mark: ~~Support custom link prefix~~ (completed 2024.12.4) -25. :memo: Integrate alist or implement webdav (under evaluation) -26. :white_check_mark: ~~Add file size record in details~~ (completed 2024.12.10) -27. :white_check_mark: ~~Support admin custom global default link prefix~~ (completed 2025.2.1) -28. :white_check_mark: ~~Open more file formats~~ (completed 2024.12.9) -29. :white_check_mark: ~~Auto clear CF CDN cache on delete, whitelist, blacklist~~ (completed 2024.12.11) -30. :white_check_mark: ~~Admin batch selection remembers user order~~ (completed 2024.12.20) -31. :memo: Support custom upload path and album feature - - ~~Folder delete~~ (completed 2025.3.6) - - ~~File move~~ (completed 2025.3.7) - - ~~Fix ghost click bug on admin load more~~ (completed 2025.3.6) - - ~~Batch operations support folders~~ (completed 2025.3.6) - - ~~Admin pagination logic adjustment~~ (completed 2025.3.6) -32. :white_check_mark: ~~Support multiple Telegram Bot Token load balancing~~ (completed 2025.2.4) -33. :white_check_mark: ~~Admin provides detailed setting info and guidance~~ (completed 2025.2.5) -34. :white_check_mark: ~~Logo redesign, login page optimization, setting tooltips~~ (completed 2025.2.2) -35. :white_check_mark: ~~Add S3 API channel~~ (completed 2024.2.3) -36. :white_check_mark: ~~Support short link naming~~ (completed 2025.2.1) -37. :white_check_mark: ~~Support dark mode~~ (completed 2025.1.11) -38. :hourglass_flowing_sand: Support KV backup and restore -39. :white_check_mark: ~~Footer can be hidden~~ (completed 2025.2.4) -40. :hourglass_flowing_sand: Search function enhancement -41. :white_check_mark: Support pasting multiple links and external link management -42. :hourglass_flowing_sand: Upload file MD5 record and hard link support -43. :hourglass_flowing_sand: Upload page recent uploads display -44. :hourglass_flowing_sand: Configure upload page default settings from admin -45. :white_check_mark: Add announcement feature -46. :hourglass_flowing_sand: Support width/height params on image access -47. :hourglass_flowing_sand: Support image format conversion on upload - -
- -## 4.2 Fix Bugs 👻 - -
- Bug fix list - -1. :white_check_mark: ~~Fix API upload not showing in backend~~ (fixed 2024.7.25) -2. :white_check_mark: ~~Migrate upload to TG channel due to telegra.ph closure~~ (fixed 2024.9.7) -3. :white_check_mark: ~~Fix infinite refresh when no admin auth set~~ (fixed 2024.9.9) -4. :white_check_mark: ~~Fix some videos not previewing (likely file issue)~~ -5. :hourglass_flowing_sand: Add new image moderation channel -6. :white_check_mark: ~~R2 channel deletes bucket synchronously in admin~~ (fixed 2024.12.4) -7. :white_check_mark: ~~Add CORS header `access-control-allow-origin: *` in file response~~ (fixed 2024.12.9) -8. :white_check_mark: ~~Add upload page access restriction whitelist~~ (fixed 2024.12.11) -9. :white_check_mark: Fix long file names covering buttons -10. :white_check_mark: Fix `list` API data completeness - -
- -# 5. Tips +# 4. Tips - Frontend is open source, see [MarSeventh/Sanyue-ImgHub](https://github.com/MarSeventh/Sanyue-ImgHub). @@ -251,13 +146,13 @@ Free file hosting solution with full lifecycle features including **upload**, ** [![Contributors](https://contrib.rocks/image?repo=Marseventh/Cloudflare-ImgBed)](https://github.com/MarSeventh/CloudFlare-ImgBed/graphs/contributors) -# 6. Star History +# 5. Star History **If you like the project, please give a free star✨✨✨, thank you very much!** [![Star History Chart](https://api.star-history.com/svg?repos=MarSeventh/CloudFlare-ImgBed,MarSeventh/Sanyue-ImgHub&type=Date)](https://star-history.com/#MarSeventh/CloudFlare-ImgBed&MarSeventh/Sanyue-ImgHub&Date) -# 7. Special Sponsors +# 6. Special Sponsors - **[AsiaYun](https://www.asiayun.com/)**: Provides cloud computing resources support (high defense servers | Fuzhou high defense | Guangdong Telecom | Hong Kong servers | US servers | Overseas servers)