docs: refactor
This commit is contained in:
krau
29
.github/workflows/docs.yml
vendored
29
.github/workflows/docs.yml
vendored
@@ -6,17 +6,30 @@ on:
|
||||
paths:
|
||||
- "docs/**"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-22.04
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.11"
|
||||
- uses: actions/cache@v4
|
||||
submodules: true # Fetch Hugo themes (true OR recursive)
|
||||
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
|
||||
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@v3
|
||||
with:
|
||||
key: ${{ github.ref }}
|
||||
path: .cache
|
||||
- run: pip install mkdocs-material
|
||||
- run: cd docs && mkdocs gh-deploy --force
|
||||
hugo-version: '0.147.8'
|
||||
extended: true
|
||||
|
||||
- name: Build
|
||||
run: hugo --minify
|
||||
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
if: github.ref == 'refs/heads/main'
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./public
|
||||
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
public/
|
||||
5
docs/archetypes/default.md
Normal file
5
docs/archetypes/default.md
Normal file
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
date = '{{ .Date }}'
|
||||
draft = true
|
||||
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
|
||||
+++
|
||||
31
docs/content/zh/_index.md
Normal file
31
docs/content/zh/_index.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: 介绍
|
||||
---
|
||||
|
||||
# Save Any Bot
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
把 Telegram 上的文件转存到多种存储端.
|
||||
|
||||
## 特性
|
||||
|
||||
- 支持文档/视频/图片/贴纸... 甚至还有 Telegraph
|
||||
- 破解禁止保存的文件
|
||||
- 批量下载
|
||||
- 流式传输
|
||||
- 多用户
|
||||
- 基于存储规则的自动整理
|
||||
- 支持多种存储端:
|
||||
- Alist
|
||||
- Minio (S3 兼容)
|
||||
- WebDAV
|
||||
- Telegram (重传回指定聊天)
|
||||
- 本地磁盘
|
||||
|
||||
## [贡献者](https://github.com/krau/SaveAny-Bot/graphs/contributors)
|
||||
|
||||
|
||||
14
docs/content/zh/contribute/_index.md
Normal file
14
docs/content/zh/contribute/_index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "参与开发"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
# 参与开发
|
||||
|
||||
## 贡献新存储端
|
||||
|
||||
1. Fork 本项目, 克隆到本地
|
||||
2. 在 `pkg/enums/storage/storages.go` 中添加新的存储端类型, 并运行代码生成
|
||||
3. 在 `config/storage` 目录下定义存储端配置, 并添加到 `config/storage/factory.go` 中
|
||||
4. 在 `storage` 目录下新建一个包, 编写存储端实现, 然后在 `storage/storage.go` 中导入并添加它
|
||||
5. 更新文档, 添加配置说明
|
||||
4
docs/content/zh/deployment/_index.md
Normal file
4
docs/content/zh/deployment/_index.md
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "部署指南"
|
||||
weight: 5
|
||||
---
|
||||
141
docs/content/zh/deployment/configuration/_index.md
Normal file
141
docs/content/zh/deployment/configuration/_index.md
Normal file
@@ -0,0 +1,141 @@
|
||||
---
|
||||
title: "配置说明"
|
||||
---
|
||||
|
||||
# 配置说明
|
||||
|
||||
SaveAnyBot 的配置文件使用 toml 格式, 你可以在 [TOML 官方网站](https://toml.io/) 上了解更多关于 toml 的语法.
|
||||
|
||||
SaveAnyBot 需要读取工作目录下的 `config.toml` 文件作为配置文件, 若缺少该文件则会创建默认文件, 并尝试从环境变量中加载配置.
|
||||
|
||||
以下是一个最简的配置文件示例:
|
||||
|
||||
```toml
|
||||
[telegram]
|
||||
token = "1234567890:ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
||||
|
||||
[[users]]
|
||||
# telegram user id
|
||||
id = 777000
|
||||
blacklist = true
|
||||
|
||||
[[storages]]
|
||||
name = "本机存储"
|
||||
type = "local"
|
||||
enable = true
|
||||
base_path = "./downloads"
|
||||
```
|
||||
|
||||
## 详细配置
|
||||
|
||||
### 全局配置
|
||||
|
||||
- `stream`: 是否启用 Stream 模式, 默认为 `false`. 启用后 Bot 将直接将文件流式传输到存储端(若存储端支持), 不需要下载到本地
|
||||
{{< hint warning >}}
|
||||
Stream 模式对于磁盘空间有限的部署环境十分有用, 但也有一些弊端:
|
||||
<br />
|
||||
<ul>
|
||||
<li>无法使用多线程从 Telegram 下载文件, 速度较慢.</li>
|
||||
<li>网络不稳定时, 任务失败率高.</li>
|
||||
<li>无法在中间层对文件进行处理, 例如自动文件类型识别.</li>
|
||||
<li>并非支持所有存储端, 不支持的存储端可能会降级为普通模式或无法上传.</li>
|
||||
</ul>
|
||||
{{< /hint >}}
|
||||
- `workers`: 同时处理任务数量, 默认为 3
|
||||
- `threads`: 下载文件时使用的线程数, 默认为 4. 仅在未启用 Stream 模式时生效.
|
||||
- `retry`: 任务失败时的重试次数, 默认为 3.
|
||||
|
||||
### Telegram 配置
|
||||
|
||||
- `token`: 你的 Telegram Bot Token, 可以通过 [BotFather](https://t.me/botfather) 创建 Bot 并获取 Token.
|
||||
- `app_id`, `app_hash`: Telegram API ID & Hash, 在 [Telegram API](https://my.telegram.org/apps) 创建应用获取, 若不提供则使用默认值.
|
||||
- `flood_retry`: Flood 控制重试次数, 默认为 5.
|
||||
- `rpc_retry`: RPC 请求重试次数, 默认为 5.
|
||||
- `proxy`: 代理配置, 可选项.
|
||||
- `enable`: 是否启用代理.
|
||||
- `url`: 代理地址, 只支持 `socks5://`
|
||||
|
||||
```toml
|
||||
[telegram]
|
||||
token = "1234567890:ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
||||
app_id = 1025907
|
||||
app_hash = "452b0359b988148995f22ff0f4229750"
|
||||
flood_retry = 5
|
||||
rpc_retry = 5
|
||||
[telegram.proxy]
|
||||
enable = false
|
||||
url = "socks5://127.0.0.1:7890"
|
||||
```
|
||||
|
||||
### 存储端列表
|
||||
|
||||
存储端列表用于定义 Bot 支持的存储位置, 每个存储端需要指定名称、类型和相关配置, 使用双中括号语法 `[[storages]]` 定义.
|
||||
|
||||
每一个存储端至少需要以下字段:
|
||||
|
||||
- `name`: 存储端名称, 用于在 Bot 中识别, 需要唯一
|
||||
- `enable`: 是否启用该存储端, 默认为 `true`
|
||||
- `type`: 存储端类型, 目前支持以下类型:
|
||||
- `local`: 本地磁盘
|
||||
- `alist`: Alist
|
||||
- `webdav`: WebDAV
|
||||
- `minio`: MinIO (兼容 S3 API)
|
||||
- `telegram`: 上传到 Telegram
|
||||
|
||||
示例, 这是一个包含本地存储和 webdav 存储的配置:
|
||||
|
||||
```toml
|
||||
[[storages]]
|
||||
name = "本地存储"
|
||||
type = "local"
|
||||
enable = true
|
||||
# 以下是 local 类型存储的自定义配置
|
||||
base_path = "./downloads"
|
||||
|
||||
[[storages]]
|
||||
name = "WebDAV"
|
||||
type = "webdav"
|
||||
enable = true
|
||||
# 以下是 webdav 类型存储的自定义配置
|
||||
url = "https://example.com/webdav"
|
||||
base_path = "/path/to/webdav"
|
||||
username = "your_username"
|
||||
password = "your_password"
|
||||
```
|
||||
|
||||
所有存储端的自定义配置项可查看 [存储端配置](./storages)
|
||||
|
||||
### 用户列表
|
||||
|
||||
用户列表用于定义对存储端的访问控制, 每个用户需要指定 Telegram 上的用户 ID, 使用双中括号语法 `[[users]]` 定义.
|
||||
|
||||
- `id`: 用户的 Telegram User ID
|
||||
- `storages`: 过滤的存储端列表, 使用存储端名称定义, 默认为白名单模式 (即只允许访问列表中的存储端)
|
||||
- `blacklist`: 是否启用黑名单模式, 默认为 `false`. 若启用黑名单模式, 则仅允许访问**没有**在列表中的存储端.
|
||||
|
||||
示例, 这是一个包含三个用户的配置, 用户 `123123` 只能访问本地存储, 用户 `456456` 只能访问除 WebDAV 以外的存储, 用户 `789789` 启用黑名单模式但没有指定存储端, 因此可以访问所有存储:
|
||||
|
||||
```toml
|
||||
[[users]]
|
||||
id = 123123
|
||||
storages = ["本地存储"]
|
||||
|
||||
[[users]]
|
||||
id = 456456
|
||||
storages = ["WebDAV"]
|
||||
blacklist = true
|
||||
|
||||
[[users]]
|
||||
id = 789789
|
||||
storages = []
|
||||
blacklist = true
|
||||
```
|
||||
|
||||
### 杂项
|
||||
|
||||
```toml
|
||||
no_clean_cache = false # 是否在退出时不清空缓存文件夹
|
||||
# 临时下载文件夹配置
|
||||
[temp]
|
||||
base_path = "./cache"
|
||||
```
|
||||
65
docs/content/zh/deployment/configuration/storages.md
Normal file
65
docs/content/zh/deployment/configuration/storages.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: "存储端配置"
|
||||
---
|
||||
|
||||
# 存储端配置
|
||||
|
||||
请先阅读 [配置说明](../) 了解配置文件的基本格式.
|
||||
|
||||
## Alist
|
||||
|
||||
`type=alist`
|
||||
|
||||
不支持 Stream 模式.
|
||||
|
||||
```toml
|
||||
url = "https://alist.example.com" # Alist 的 URL
|
||||
username = "your_username" # Alist 的用户名
|
||||
password = "your_password" # Alist 的密码
|
||||
base_path = "/path/saveanybot" # Alist 中的基础路径, 所有文件将存储在此路径下
|
||||
token_exp = 3600 # Alist 访问令牌的自动刷新时间, 单位秒
|
||||
token = "your_token"
|
||||
# Alist 的访问令牌, 可选, 如果不设置则使用用户名和密码进行身份验证.
|
||||
# 使用 token 验证时无法自动刷新 token
|
||||
```
|
||||
|
||||
## 本地磁盘
|
||||
|
||||
`type=local`
|
||||
|
||||
```toml
|
||||
base_path = "./downloads" # 本地存储的基础路径, 所有文件将存储在此路径下
|
||||
```
|
||||
|
||||
## WebDAV
|
||||
`type=webdav`
|
||||
|
||||
```toml
|
||||
url = "https://webdav.example.com" # WebDAV 的 URL
|
||||
username = "your_username" # WebDAV
|
||||
password = "your_password" # WebDAV 的密码
|
||||
base_path = "/path/to/webdav" # WebDAV 中的基础路径, 所有文件将存储在此路径下
|
||||
```
|
||||
|
||||
## MinIO (S3)
|
||||
|
||||
`type=minio`
|
||||
|
||||
```toml
|
||||
endpoint = "minio.example.com" # MinIO 或 S3 的端点
|
||||
access_key_id = "your_access_key_id" # MinIO 或 S3 的访问密钥 ID
|
||||
secret_access_key = "your_secret_access_key" # MinIO 或 S3 的秘密访问密钥
|
||||
bucket_name = "your_bucket_name" # MinIO 或 S3 的存储桶名称
|
||||
use_ssl = true # 是否使用 SSL, 默认为 true
|
||||
base_path = "/path/to/minio" # MinIO 中的基础路径, 所有文件将存储在此路径下
|
||||
```
|
||||
|
||||
## Telegram
|
||||
|
||||
`type=telegram`
|
||||
|
||||
不支持 Stream 模式.
|
||||
|
||||
```toml
|
||||
chat_id = "123456789" # Telegram 聊天 ID, Bot 将把文件发送到这个聊天
|
||||
```
|
||||
145
docs/content/zh/deployment/installation.md
Normal file
145
docs/content/zh/deployment/installation.md
Normal file
@@ -0,0 +1,145 @@
|
||||
---
|
||||
title: "安装与更新"
|
||||
---
|
||||
|
||||
# 安装与更新
|
||||
|
||||
## 从预编译文件部署
|
||||
|
||||
在 [Release](https://github.com/krau/SaveAny-Bot/releases) 页面下载对应平台的二进制文件.
|
||||
|
||||
在解压后目录新建 `config.toml` 文件, 参考 [配置说明](../configuration) 编辑配置文件
|
||||
|
||||
运行:
|
||||
|
||||
```bash
|
||||
chmod +x saveany-bot
|
||||
./saveany-bot
|
||||
```
|
||||
|
||||
### 进程守护
|
||||
|
||||
{{< tabs "daemon" >}}
|
||||
{{< tab "systemd (常规 Linux)" >}}
|
||||
|
||||
创建文件 <code>/etc/systemd/system/saveany-bot.service</code> 并写入以下内容:
|
||||
|
||||
{{< codeblock >}}
|
||||
[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
|
||||
{{< /codeblock >}}
|
||||
|
||||
设为开机启动并启动服务:
|
||||
|
||||
{{< codeblock >}}
|
||||
systemctl enable --now saveany-bot
|
||||
{{< /codeblock >}}
|
||||
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab "procd (OpenWrt)" >}}
|
||||
|
||||
<h4>添加开机自启动服务</h4>
|
||||
|
||||
创建文件 <code>/etc/init.d/saveanybot</code> ，参考 <a href="https://github.com/krau/SaveAny-Bot/blob/main/docs/confs/wrt_init" target="_blank">wrt_init</a> 并自行修改:
|
||||
|
||||
{{< codeblock >}}
|
||||
#!/bin/sh /etc/rc.common
|
||||
|
||||
#This is the OpenWRT init.d script for SaveAnyBot
|
||||
|
||||
START=99
|
||||
STOP=10
|
||||
description="SaveAnyBot"
|
||||
|
||||
WORKING_DIR="/mnt/mmc1-1/SaveAnyBot"
|
||||
EXEC_PATH="$WORKING_DIR/saveany-bot"
|
||||
start() {
|
||||
echo "Starting SaveAnyBot..."
|
||||
cd $WORKING_DIR
|
||||
$EXEC_PATH &
|
||||
}
|
||||
stop() {
|
||||
echo "Stopping SaveAnyBot..."
|
||||
killall saveany-bot
|
||||
}
|
||||
reload() {
|
||||
stop
|
||||
start
|
||||
}
|
||||
|
||||
{{< /codeblock >}}
|
||||
|
||||
赋予权限:
|
||||
|
||||
{{< codeblock >}}
|
||||
chmod +x /etc/init.d/saveanybot
|
||||
{{< /codeblock >}}
|
||||
|
||||
然后将文件复制到 <code>/etc/rc.d</code> 并重命名为 <code>S99saveanybot</code>, 同样赋予权限:
|
||||
|
||||
{{< codeblock >}}
|
||||
chmod +x /etc/rc.d/S99saveanybot
|
||||
{{< /codeblock >}}
|
||||
|
||||
<h4>添加快捷指令</h4>
|
||||
|
||||
创建文件 <code>/usr/bin/sabot</code> ，参考 <a href="https://github.com/krau/SaveAny-Bot/blob/main/docs/confs/wrt_bin" target="_blank">wrt_bin</a> 并自行修改，注意此处文件编码仅支持 ANSI 936 .
|
||||
|
||||
随后赋予权限:
|
||||
|
||||
{{< codeblock >}}
|
||||
chmod +x /usr/bin/sabot
|
||||
{{< /codeblock >}}
|
||||
|
||||
使用: <code>sudo sabot start|stop|restart|status|enable|disable</code>
|
||||
|
||||
{{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
|
||||
|
||||
## 使用 Docker 部署
|
||||
|
||||
### Docker Compose
|
||||
|
||||
下载 [docker-compose.yml](https://github.com/krau/SaveAny-Bot/blob/main/docker-compose.yml) 文件, 在同目录下新建 `config.toml` 文件, 参考 [config.example.toml](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) 编辑配置文件.
|
||||
|
||||
启动:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
## 更新
|
||||
|
||||
使用 `upgrade` 或 `up` 升级到最新版
|
||||
|
||||
```bash
|
||||
./saveany-bot upgrade
|
||||
```
|
||||
|
||||
如果是 Docker 部署, 使用以下命令更新:
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/krau/saveany-bot:latest
|
||||
docker restart saveany-bot
|
||||
```
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: "常见问题"
|
||||
weight: 15
|
||||
---
|
||||
|
||||
# 常见问题
|
||||
|
||||
## 上传 alist 失败也会显示成功
|
||||
@@ -6,11 +11,8 @@
|
||||
|
||||
## Bot 提示下载成功但是 alist 未显示
|
||||
|
||||
alist 缓存了目录结构, 参考文档可以调整缓存时间
|
||||
|
||||
https://alist.nn.ci/zh/guide/drivers/common.html#缓存过期
|
||||
alist 缓存了目录结构, 参考 <a href="https://alist.nn.ci/zh/guide/drivers/common.html#缓存过期" target="_blank">文档</a> 可以调整缓存时间
|
||||
|
||||
## docker部署配置了代理后仍无法连接 telegram (初始化客户端超时)
|
||||
|
||||
docker 不能直接访问宿主机网络, 如果你不熟悉其用法, 请将容器设为 host 模式:
|
||||
|
||||
docker 不能直接访问宿主机网络, 如果你不熟悉其用法, 请将容器设为 host 模式.
|
||||
@@ -1,12 +1,35 @@
|
||||
# 实验性功能
|
||||
---
|
||||
title: "使用帮助"
|
||||
weight: 10
|
||||
---
|
||||
|
||||
# 使用帮助
|
||||
|
||||
## 转存文件
|
||||
|
||||
Bot 接受两种消息: 文件和链接.
|
||||
|
||||
支持以下链接:
|
||||
|
||||
1. Telegram 消息链接, 例如: `https://t.me/acherkrau/1097`. **即使频道禁止了转发和保存, Bot 依然可以下载其文件.**
|
||||
2. Telegra.ph 的文章链接, Bot 将下载其中的所有图片
|
||||
|
||||
## 静默模式 (silent)
|
||||
|
||||
使用 `/silent` 命令可以开关静默模式.
|
||||
|
||||
默认情况下不开启静默模式, Bot 会询问你每个文件的保存位置.
|
||||
|
||||
开启静默模式后, Bot 会直接保存文件到默认位置, 无需确认.
|
||||
|
||||
在开启静默模式之前, 需要使用 `/storage` 命令设置默认保存位置.
|
||||
|
||||
这里的功能不太稳定, 且未来可能会被删除或修改。
|
||||
|
||||
## 存储规则
|
||||
|
||||
允许你为 Bot 在上传文件到存储时设置一些重定向规则, 用于自动整理所保存的文件.
|
||||
|
||||
见: https://github.com/krau/SaveAny-Bot/issues/28
|
||||
见: <a href="https://github.com/krau/SaveAny-Bot/issues/28" target="_blank">#28</a>
|
||||
|
||||
目前支持的规则类型:
|
||||
|
||||
@@ -39,8 +62,4 @@ FILENAME-REGEX (?i)\.(mp4|mkv|ts|avi|flv)$ MyAlist /视频
|
||||
|
||||
### MESSAGE-REGEX
|
||||
|
||||
同上, 根据消息文本内容正则匹配
|
||||
|
||||
## 复制并发送媒体消息
|
||||
|
||||
将接收到的文件(媒体)消息, 或链接对应的消息原样发送到当前聊天, 点击选择存储按钮中的 "发送到当前聊天" 即可.
|
||||
同上, 但是是根据消息本身的文本内容正则匹配
|
||||
@@ -1,11 +0,0 @@
|
||||
# 参与开发
|
||||
|
||||
## 贡献新存储端
|
||||
|
||||
1. Fork 本项目, 克隆到本地
|
||||
2. 在 `config/storage` 目录下定义存储端配置, 并添加到 `config/storage/factory.go` 中
|
||||
3. 在 `types/types.go` 中添加新的存储端类型
|
||||
4. 在 `storage` 目录下新建一个包, 编写存储端实现, 然后在 `storage/storage.go` 中导入并添加它
|
||||
5. 更新 `config.example.toml` 文件, 添加新的示例配置
|
||||
|
||||
*可能确实有点麻烦了 = =*
|
||||
@@ -1,94 +0,0 @@
|
||||
# 部署指南
|
||||
|
||||
## 从二进制文件部署
|
||||
|
||||
在 [Release](https://github.com/krau/SaveAny-Bot/releases) 页面下载对应平台的二进制文件.
|
||||
|
||||
在解压后目录新建 `config.toml` 文件, 参考 [config.example.toml](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) 编辑配置文件.
|
||||
|
||||
运行:
|
||||
|
||||
```bash
|
||||
chmod +x saveany-bot
|
||||
./saveany-bot
|
||||
```
|
||||
|
||||
### 添加为 systemd 服务
|
||||
|
||||
创建文件 `/etc/systemd/system/saveany-bot.service` 并写入以下内容:
|
||||
|
||||
```
|
||||
[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
|
||||
```
|
||||
|
||||
设为开机启动并启动服务:
|
||||
|
||||
```bash
|
||||
systemctl enable --now saveany-bot
|
||||
```
|
||||
|
||||
### 为OpenWrt及衍生系统添加开机自启动服务
|
||||
|
||||
创建文件 ` /etc/init.d/saveanybot` ，参考[saveanybot](https://github.com/krau/SaveAny-Bot/blob/main/docs/saveanybot)自行修改.
|
||||
|
||||
`chmod +x /etc/init.d/saveanybot`
|
||||
|
||||
完成后，将文件复制到 `/etc/rc.d`并重命名为`S99saveanybot`.
|
||||
|
||||
`chmod +x /etc/rc.d/S99saveanybot`
|
||||
|
||||
### 为OpenWrt及衍生系统添加快捷指令
|
||||
|
||||
创建文件` /usr/bin/sabot` ，参考[sabot](https://github.com/krau/SaveAny-Bot/blob/main/docs/sabot)自行配置修改，注意此处文件编码仅支持 ANSI 936 .
|
||||
|
||||
`chmod +x /usr/bin/sabot`
|
||||
|
||||
之后，终端输入`sabot start|stop|restart|status|enable|disable`即可.
|
||||
|
||||
|
||||
## 使用 Docker 部署
|
||||
|
||||
### Docker Compose
|
||||
|
||||
下载 [docker-compose.yml](https://github.com/krau/SaveAny-Bot/blob/main/docker-compose.yml) 文件, 在同目录下新建 `config.toml` 文件, 参考 [config.example.toml](https://github.com/krau/SaveAny-Bot/blob/main/config.example.toml) 编辑配置文件.
|
||||
|
||||
启动:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
## 更新
|
||||
|
||||
使用 `upgrade` 或 `up` 升级到最新版
|
||||
|
||||
```bash
|
||||
./saveany-bot upgrade
|
||||
```
|
||||
|
||||
如果是 Docker 部署, 使用以下命令更新:
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/krau/saveany-bot:latest
|
||||
docker restart saveany-bot
|
||||
```
|
||||
@@ -1,38 +0,0 @@
|
||||
# 使用帮助
|
||||
|
||||
## 保存文件
|
||||
|
||||
Bot 接受两种消息: 文件和链接.
|
||||
|
||||
支持以下链接:
|
||||
|
||||
1. 公开频道 (具有用户名) 的消息链接, 例如: `https://t.me/acherkrau/1097`. **即使频道禁止了转发和保存, Bot 依然可以下载其文件.**
|
||||
2. Telegra.ph 的文章链接, Bot 将下载其中的所有图片
|
||||
|
||||
## 静默模式 (silent)
|
||||
|
||||
使用 `/silent` 命令可以开关静默模式.
|
||||
|
||||
默认情况下不开启静默模式, Bot 会询问你每个文件的保存位置.
|
||||
|
||||
开启静默模式后, Bot 会直接保存文件到默认位置, 无需确认.
|
||||
|
||||
在开启静默模式之前, 需要使用 `/storage` 命令设置默认保存位置.
|
||||
|
||||
## Stream 模式
|
||||
|
||||
在配置文件中将 `stream` 设置为 `true` 可以开启 Stream 模式.
|
||||
|
||||
未开启时, Bot 处理任务分为两步: 下载和上传. Bot 会将文件暂存到本地, 然后上传到对应存储位置, 最后删除本地文件.
|
||||
|
||||
开启后, Bot 将直接将文件流式传输到存储端, 不需要下载到本地.
|
||||
|
||||
该功能对于硬盘空间有限的部署环境十分有用, 然而相较于普通模式也具有一些弊端:
|
||||
|
||||
- 无法使用多线程从 telegram 下载文件, 速度较慢.
|
||||
- 网络不稳定时, 任务失败率高.
|
||||
- 无法在中间层对文件进行处理, 例如自动文件类型识别.
|
||||
|
||||
**不支持** Stream 模式的存储端:
|
||||
|
||||
- alist
|
||||
@@ -1,7 +0,0 @@
|
||||
# SaveAnyBot 文档
|
||||
|
||||
SaveAnyBot 是一个可以保存 Telegram 上的文件到云存储的机器人, 就像 PikPak Bot 一样.
|
||||
|
||||
不同的是, SaveAnyBot 提供更灵活的存储端选择, 并实现一些更强大的功能.
|
||||
|
||||
本项目以 AGPL-3.0 协议开源, 请遵守协议使用.
|
||||
5
docs/go.mod
Normal file
5
docs/go.mod
Normal file
@@ -0,0 +1,5 @@
|
||||
module github.com/krau/SaveAny-Bot/docs
|
||||
|
||||
go 1.24.4
|
||||
|
||||
require github.com/alex-shpak/hugo-book v0.0.0-20250530233833-f2c703e15588 // indirect
|
||||
2
docs/go.sum
Normal file
2
docs/go.sum
Normal file
@@ -0,0 +1,2 @@
|
||||
github.com/alex-shpak/hugo-book v0.0.0-20250530233833-f2c703e15588 h1:pwxkzpzw/iJSxMBgQLWjYMQubhIemLG3UrNjeWoCkSM=
|
||||
github.com/alex-shpak/hugo-book v0.0.0-20250530233833-f2c703e15588/go.mod h1:L4NMyzbn15fpLIpmmtDg9ZFFyTZzw87/lk7M2bMQ7ds=
|
||||
44
docs/hugo.toml
Normal file
44
docs/hugo.toml
Normal file
@@ -0,0 +1,44 @@
|
||||
baseURL = 'https://sabot.unv.app/'
|
||||
title = 'Save Any Bot'
|
||||
disablePathToLower = true
|
||||
enableGitInfo = true
|
||||
defaultContentLanguage = 'zh'
|
||||
|
||||
[module]
|
||||
[[module.imports]]
|
||||
path = 'github.com/alex-shpak/hugo-book'
|
||||
|
||||
[params]
|
||||
BookTheme = 'auto'
|
||||
BookToC = true
|
||||
BookLogo = 'logo.png'
|
||||
BookSection = '*'
|
||||
BookRepo = 'https://github.com/krau/saveany-bot'
|
||||
BookCommitPath = 'commit'
|
||||
BookEditPath = 'edit/main/docs'
|
||||
|
||||
# (Optional, default January 2, 2006) Configure the date format used on the pages
|
||||
# - In git information
|
||||
# - In blog posts
|
||||
BookDateFormat = '2006/01/02'
|
||||
|
||||
# (Optional, default true) Enables search function with flexsearch,
|
||||
# Index is built on fly, therefore it might slowdown your website.
|
||||
# Configuration for indexing can be adjusted in i18n folder per language.
|
||||
BookSearch = false
|
||||
|
||||
[languages]
|
||||
|
||||
[languages.zh]
|
||||
languageName = "简体中文"
|
||||
contentDir = "content/zh"
|
||||
weight = 1
|
||||
|
||||
[languages.en]
|
||||
languageName = "English"
|
||||
contentDir = "content/en"
|
||||
weight = 2
|
||||
|
||||
[markup]
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
3
docs/layouts/shortcodes/codeblock.html
Normal file
3
docs/layouts/shortcodes/codeblock.html
Normal file
@@ -0,0 +1,3 @@
|
||||
{{- $lang := .Get "lang" | default "text" -}}
|
||||
{{- $content := .Inner | strings.TrimSpace | htmlEscape -}}
|
||||
<pre><code class="language-{{ $lang }}">{{ $content }}</code></pre>
|
||||
@@ -1,35 +0,0 @@
|
||||
site_name: SaveAnyBot 官方文档
|
||||
site_author: Krau
|
||||
site_description: SaveAnyBot 是一个可以保存 Telegram 上的文件到多种云存储的机器人, 本文档将帮助你了解如何部署和使用它.
|
||||
repo_name: krau/saveany-bot
|
||||
repo_url: https://github.com/krau/saveany-bot
|
||||
copyright: CC BY-NC-SA 4.0
|
||||
theme:
|
||||
name: material
|
||||
language: zh
|
||||
highlightjs: true
|
||||
palette:
|
||||
- media: "(prefers-color-scheme)"
|
||||
toggle:
|
||||
icon: material/brightness-auto
|
||||
name: 切换主题
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: indigo
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: 暗色模式
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: blue grey
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: 亮色模式
|
||||
|
||||
nav:
|
||||
- index.md
|
||||
- deploy.md
|
||||
- help.md
|
||||
- experimental.md
|
||||
- faq.md
|
||||
- contribute.md
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
|
||||
{"Target":"book.min.27c601ff251cc5c9796bb272aace960013cf351d0c28a7e1301487b32d4800ee.css","MediaType":"text/css","Data":{"Integrity":"sha256-J8YB/yUcxcl5a7Jyqs6WABPPNR0MKKfhMBSHsy1IAO4="}}
|
||||
0
docs/logo.jpg → docs/static/logo.png
vendored
0
docs/logo.jpg → docs/static/logo.png
vendored
|
Before Width: | Height: | Size: 3.1 KiB After Width: | Height: | Size: 3.1 KiB |
Reference in New Issue
Block a user