From d4d39d1c07f0d436e3d7c29e711d956b82a0a162 Mon Sep 17 00:00:00 2001 From: krau <71133316+krau@users.noreply.github.com> Date: Mon, 16 Jun 2025 16:57:39 +0800 Subject: [PATCH] chore: update readme --- README.md | 30 +++++++++----- README_EN.md | 108 --------------------------------------------------- 2 files changed, 21 insertions(+), 117 deletions(-) delete mode 100644 README_EN.md diff --git a/README.md b/README.md index 3fda214..46b5c54 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,38 @@ # Save Any Bot -**简体中文** | [English](README_EN.md) +**简体中文** | [English](https://sabot.unv.app/en/) -把 Telegram 的文件保存到各类存储端. - -> _就像 PikPak Bot 一样_ +把 Telegram 上的文件转存到多种存储端. -## [部署](https://sabot.unv.app/deploy/) +## 部署 -## [参与开发](https://sabot.unv.app/contribute/) +请参考 [部署文档](https://sabot.unv.app/deployment/installation/) ---- +## Features -## 赞助 +- 支持文档/视频/图片/贴纸… 甚至还有 Telegraph +- 破解禁止保存的文件 +- 批量下载 +- 流式传输 +- 多用户 +- 基于存储规则的自动整理 +- 支持多种存储端: + - Alist + - Minio (S3 兼容) + - WebDAV + - Telegram (重传回指定聊天) + - 本地磁盘 + +## Sponsors 本项目受到 [YxVM](https://yxvm.com/) 与 [NodeSupport](https://github.com/NodeSeekDev/NodeSupport) 的支持. 如果这个项目对你有帮助, 你可以考虑通过以下方式赞助我: -- [爱发电](https://afdian.com/a/acherkrau) +- [爱发电](https://afdian.com/a/unvapp) ## Contributors @@ -68,4 +79,5 @@ - [gotd](https://github.com/gotd/td) - [TG-FileStreamBot](https://github.com/EverythingSuckz/TG-FileStreamBot) - [gotgproto](https://github.com/celestix/gotgproto) +- [tdl](https://github.com/iyear/tdl) - All the dependencies diff --git a/README_EN.md b/README_EN.md deleted file mode 100644 index 0e19aca..0000000 --- a/README_EN.md +++ /dev/null @@ -1,108 +0,0 @@ -
- -# Save Any Bot - -[简体中文](README.md) | **English** - -Save Telegram files to various storage endpoints. - -> _Just like PikPak Bot_ - -
- -## Deployment - -### Deploy from Binary - -Download the binary file for your platform from the [Release](https://github.com/krau/SaveAny-Bot/releases) page. - -Create a `config.toml` file in the extracted directory, refer to [config.example.toml](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) for configuration. - -Run: - -```bash -chmod +x saveany-bot -./saveany-bot -``` - -#### Add as systemd Service - -Create file `/etc/systemd/system/saveany-bot.service` and write the following content: - -``` -[Unit] -Description=SaveAnyBot -After=systemd-user-sessions.service - -[Service] -Type=simple -WorkingDirectory=/yourpath/ -ExecStart=/yourpath/saveany-bot -Restart=on-failure - -[Install] -WantedBy=multi-user.target -``` - -Enable auto-start and start the service: - -```bash -systemctl enable --now saveany-bot -``` - -### Deploy with Docker - -#### Docker Compose - -Download [docker-compose.yml](https://github.com/krau/SaveAny-Bot/blob/main/docker-compose.yml) file and create a `config.toml` file in the same directory, refer to [config.example.toml](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) for configuration. - -Run: - -```bash -docker compose up -d -``` - -#### Docker - -```shell -docker run -d --name saveany-bot \ - -v /path/to/config.toml:/app/config.toml \ - -v /path/to/downloads:/app/downloads \ - ghcr.io/krau/saveany-bot:latest -``` - -## Update - -Use `upgrade` or `up` command to upgrade to the latest version: - -```bash -./saveany-bot upgrade -``` - -If deployed with Docker, use the following commands to update: - -```bash -docker pull ghcr.io/krau/saveany-bot:latest -docker restart saveany-bot -``` - -## Usage - -Send (forward) files to the Bot and follow the prompts. - ---- - -## Sponsors - -This project is supported by [YxVM](https://yxvm.com/) and [NodeSupport](https://github.com/NodeSeekDev/NodeSupport). - -You can consider sponsoring me if this project helps you: - -- [Afdian](https://afdian.com/a/acherkrau) - -## Thanks - -- [gotd](https://github.com/gotd/td) -- [TG-FileStreamBot](https://github.com/EverythingSuckz/TG-FileStreamBot) -- [gotgproto](https://github.com/celestix/gotgproto) -- All the dependencies \ No newline at end of file