mirror of
https://github.com/krau/SaveAny-Bot.git
synced 2026-05-11 20:49:41 +08:00
docs: add en translate
This commit is contained in:
krau
141
docs/content/en/deployment/configuration/_index.md
Normal file
141
docs/content/en/deployment/configuration/_index.md
Normal file
@@ -0,0 +1,141 @@
|
||||
---
|
||||
title: "Configuration Guide"
|
||||
---
|
||||
|
||||
# Configuration Guide
|
||||
|
||||
SaveAnyBot uses the toml format for its configuration files. You can learn more about toml syntax on the [TOML official website](https://toml.io/).
|
||||
|
||||
SaveAnyBot needs to read a `config.toml` file in the working directory as its configuration file. If this file is missing, a default file will be created, and the bot will attempt to load configuration from environment variables.
|
||||
|
||||
Here is an example of a minimal configuration file:
|
||||
|
||||
```toml
|
||||
[telegram]
|
||||
token = "1234567890:ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
||||
|
||||
[[users]]
|
||||
# telegram user id
|
||||
id = 777000
|
||||
blacklist = true
|
||||
|
||||
[[storages]]
|
||||
name = "Local Storage"
|
||||
type = "local"
|
||||
enable = true
|
||||
base_path = "./downloads"
|
||||
```
|
||||
|
||||
## Detailed Configuration
|
||||
|
||||
### Global Configuration
|
||||
|
||||
- `stream`: Whether to enable Stream mode, default is `false`. When enabled, the Bot will stream files directly to storage endpoints (if supported), without downloading them locally.
|
||||
{{< hint warning >}}
|
||||
Stream mode is very useful for deployment environments with limited disk space, but it also has some drawbacks:
|
||||
<br />
|
||||
<ul>
|
||||
<li>Cannot use multi-threading to download files from Telegram, resulting in slower speeds.</li>
|
||||
<li>Higher task failure rate when the network is unstable.</li>
|
||||
<li>Cannot process files in the middle layer, such as automatic file type identification.</li>
|
||||
<li>Not supported by all storage endpoints; unsupported endpoints may downgrade to normal mode or fail to upload.</li>
|
||||
</ul>
|
||||
{{< /hint >}}
|
||||
- `workers`: Number of tasks to process simultaneously, default is 3.
|
||||
- `threads`: Number of threads used when downloading files, default is 4. Only effective when Stream mode is not enabled.
|
||||
- `retry`: Number of retries when a task fails, default is 3.
|
||||
|
||||
### Telegram Configuration
|
||||
|
||||
- `token`: Your Telegram Bot Token, which can be obtained by creating a Bot through [BotFather](https://t.me/botfather).
|
||||
- `app_id`, `app_hash`: Telegram API ID & Hash, obtained by creating an application at [Telegram API](https://my.telegram.org/apps). Default values will be used if not provided.
|
||||
- `flood_retry`: Number of retries for flood control, default is 5.
|
||||
- `rpc_retry`: Number of retries for RPC requests, default is 5.
|
||||
- `proxy`: Proxy configuration, optional.
|
||||
- `enable`: Whether to enable the proxy.
|
||||
- `url`: Proxy address, only supports `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"
|
||||
```
|
||||
|
||||
### Storage Endpoints List
|
||||
|
||||
The storage endpoints list is used to define the storage locations supported by the Bot. Each storage endpoint needs to specify a name, type, and related configuration, using the double bracket syntax `[[storages]]`.
|
||||
|
||||
Each storage endpoint requires at least the following fields:
|
||||
|
||||
- `name`: Storage endpoint name, used for identification in the Bot, must be unique.
|
||||
- `enable`: Whether to enable this storage endpoint, default is `true`.
|
||||
- `type`: Storage endpoint type, currently supports the following types:
|
||||
- `local`: Local disk
|
||||
- `alist`: Alist
|
||||
- `webdav`: WebDAV
|
||||
- `minio`: MinIO (compatible with S3 API)
|
||||
- `telegram`: Upload to Telegram
|
||||
|
||||
Example, this is a configuration that includes local storage and webdav storage:
|
||||
|
||||
```toml
|
||||
[[storages]]
|
||||
name = "Local Storage"
|
||||
type = "local"
|
||||
enable = true
|
||||
# Custom configuration for local type storage
|
||||
base_path = "./downloads"
|
||||
|
||||
[[storages]]
|
||||
name = "WebDAV"
|
||||
type = "webdav"
|
||||
enable = true
|
||||
# Custom configuration for webdav type storage
|
||||
url = "https://example.com/webdav"
|
||||
base_path = "/path/to/webdav"
|
||||
username = "your_username"
|
||||
password = "your_password"
|
||||
```
|
||||
|
||||
For custom configuration items for all storage endpoints, see [Storage Configuration](./storages)
|
||||
|
||||
### User List
|
||||
|
||||
The user list is used to define access control for storage endpoints. Each user needs to specify a Telegram User ID, defined using the double bracket syntax `[[users]]`.
|
||||
|
||||
- `id`: The user's Telegram User ID
|
||||
- `storages`: Filtered list of storage endpoints, defined by storage endpoint names, default is whitelist mode (i.e., only allows access to storage endpoints in the list)
|
||||
- `blacklist`: Whether to enable blacklist mode, default is `false`. If blacklist mode is enabled, the user is allowed to access only storage endpoints that are **not** in the list.
|
||||
|
||||
Example, this is a configuration containing three users: user `123123` can only access local storage, user `456456` can only access storage other than WebDAV, and user `789789` has blacklist mode enabled but no storage endpoints specified, so they can access all storage:
|
||||
|
||||
```toml
|
||||
[[users]]
|
||||
id = 123123
|
||||
storages = ["Local Storage"]
|
||||
|
||||
[[users]]
|
||||
id = 456456
|
||||
storages = ["WebDAV"]
|
||||
blacklist = true
|
||||
|
||||
[[users]]
|
||||
id = 789789
|
||||
storages = []
|
||||
blacklist = true
|
||||
```
|
||||
|
||||
### Miscellaneous
|
||||
|
||||
```toml
|
||||
no_clean_cache = false # Whether not to clear the cache folder when exiting
|
||||
# Temporary download folder configuration
|
||||
[temp]
|
||||
base_path = "./cache"
|
||||
```
|
||||
65
docs/content/en/deployment/configuration/storages.md
Normal file
65
docs/content/en/deployment/configuration/storages.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: "Storage Configuration"
|
||||
---
|
||||
|
||||
# Storage Configuration
|
||||
|
||||
Please first read the [Configuration Guide](../) to understand the basic format of the configuration file.
|
||||
|
||||
## Alist
|
||||
|
||||
`type=alist`
|
||||
|
||||
Stream mode is not supported.
|
||||
|
||||
```toml
|
||||
url = "https://alist.example.com" # URL of Alist
|
||||
username = "your_username" # Username for Alist
|
||||
password = "your_password" # Password for Alist
|
||||
base_path = "/path/saveanybot" # Base path in Alist, all files will be stored under this path
|
||||
token_exp = 3600 # Auto-refresh time for Alist access token, in seconds
|
||||
token = "your_token"
|
||||
# Access token for Alist, optional, if not set, username and password will be used for authentication.
|
||||
# When using token authentication, the token cannot be automatically refreshed
|
||||
```
|
||||
|
||||
## Local Disk
|
||||
|
||||
`type=local`
|
||||
|
||||
```toml
|
||||
base_path = "./downloads" # Base path for local storage, all files will be stored under this path
|
||||
```
|
||||
|
||||
## WebDAV
|
||||
`type=webdav`
|
||||
|
||||
```toml
|
||||
url = "https://webdav.example.com" # URL of WebDAV
|
||||
username = "your_username" # Username for WebDAV
|
||||
password = "your_password" # Password for WebDAV
|
||||
base_path = "/path/to/webdav" # Base path in WebDAV, all files will be stored under this path
|
||||
```
|
||||
|
||||
## MinIO (S3)
|
||||
|
||||
`type=minio`
|
||||
|
||||
```toml
|
||||
endpoint = "minio.example.com" # Endpoint for MinIO or S3
|
||||
access_key_id = "your_access_key_id" # Access key ID for MinIO or S3
|
||||
secret_access_key = "your_secret_access_key" # Secret access key for MinIO or S3
|
||||
bucket_name = "your_bucket_name" # Bucket name for MinIO or S3
|
||||
use_ssl = true # Whether to use SSL, default is true
|
||||
base_path = "/path/to/minio" # Base path in MinIO, all files will be stored under this path
|
||||
```
|
||||
|
||||
## Telegram
|
||||
|
||||
`type=telegram`
|
||||
|
||||
Stream mode is not supported.
|
||||
|
||||
```toml
|
||||
chat_id = "123456789" # Telegram chat ID, the Bot will send files to this chat
|
||||
```
|
||||
Reference in New Issue
Block a user