Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 72 additions & 12 deletions pages/guide/drivers/github_releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,52 @@ openlist/
启用后,所有可用的发布版本都会显示在单独的目录中。
:::

### Pagination Control (Show All Versions) { lang="en" }

### 分页控制(显示所有版本) { lang="zh-CN" }

::: en
When "Show All Versions" is enabled, you can control the number of releases fetched via pagination:

- **`per_page`**: Number of releases per page (default: `30`, max: `100`)
- **`max_page`**: Maximum number of pages to fetch (`0` means unlimited)

These settings help you avoid hitting API rate limits when repositories have a large number of releases.

**Example:**

To fetch at most 2 pages with 50 releases per page (up to 100 releases total):

```text
per_page = 50
max_page = 2
```

::: tip
A single unauthenticated request counts as 1 toward the 60 requests/hour limit. With `per_page=100` and `max_page=1`, fetching releases for a single repository costs only 1 request.
:::

::: zh-CN
当启用"显示所有版本"时,您可以通过分页控制获取的发布数量:

- **`per_page`**:每页 release 数量(默认:`30`,最大:`100`)
- **`max_page`**:最大请求页数(`0` 表示不限页数)

当仓库有大量发布版本时,这些设置可以帮助您避免触发 API 速率限制。

**配置示例:**

最多请求 2 页,每页 50 个 release(最多获取 100 个 release):

```text
per_page = 50
max_page = 2
```

::: tip
单次未认证请求计为 1 次,占每小时 60 次限额。设 `per_page=100`、`max_page=1` 时,获取单个仓库的 release 仅消耗 1 次请求。
:::

### Show README Files { lang="en" }

### 显示 README 文件 { lang="zh-CN" }
Expand Down Expand Up @@ -299,16 +345,23 @@ Use GitHub proxy services to accelerate downloads in regions with limited GitHub
Replace the GitHub domain with a proxy service URL:

```text
https://gh-proxy.com/github.com
https://gh-proxy.com/https://github.com
```

**Available Proxy Services:**

| Service | URL |
| -------- | --------------------------------- |
| GH-Proxy | `https://gh-proxy.com/github.com` |
| GHFast | `https://ghfast.top/github.com` |
| GHProxy | `https://ghproxy.net/github.com` |
| Service | URL |
| ----------- | ----------------------------------------- |
| GH-Proxy | `https://gh-proxy.com/https://github.com` |
| GHProxy.net | `https://ghproxy.net/https://github.com` |
| GHFast | `https://ghfast.top/https://github.com` |

Example:

```
Before: https://github.com/owner/repo/releases/download/v1.0/file.zip
After: https://ghproxy.net/https://github.com/owner/repo/releases/download/v1.0/file.zip
```

::: warning
Proxy services are third-party and may have varying availability and performance.
Expand All @@ -321,16 +374,23 @@ Proxy services are third-party and may have varying availability and performance
将 GitHub 域名替换为代理服务 URL:

```text
https://gh-proxy.com/github.com
https://gh-proxy.com/https://github.com
```

**可用代理服务:**

| 服务 | URL |
| -------- | --------------------------------- |
| GH-Proxy | `https://gh-proxy.com/github.com` |
| GHFast | `https://ghfast.top/github.com` |
| GHProxy | `https://ghproxy.net/github.com` |
| 服务 | URL |
| ----------- | ----------------------------------------- |
| GH-Proxy | `https://gh-proxy.com/https://github.com` |
| GHProxy.net | `https://ghproxy.net/https://github.com` |
| GHFast | `https://ghfast.top/https://github.com` |

示例:

```
转换前:https://github.com/owner/repo/releases/download/v1.0/file.zip
转换后:https://ghproxy.net/https://github.com/owner/repo/releases/download/v1.0/file.zip
```

::: warning
代理服务为第三方提供,可用性和性能可能存在差异。
Expand Down