Skip to content
Merged
Show file tree
Hide file tree
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
131 changes: 131 additions & 0 deletions docs/guide/drivers/github_releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
---
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 41
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Storage
- Guide
- "302"
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---
# GitHub Releases

:::tip
GitHub API rate limits: The primary rate limit for unauthenticated requests is 60 requests per hour. Making API requests using a personal access token counts toward your personal rate limit of 5,000 requests per hour.
:::

## Repo Structure

:::tabs#UrlTree
@tab 1

The simplest usage is to directly write `owner/repository`, only one can be filled in.

##### Input

```
alistGo/alist
```

The effect is the same as the following:
```
/:alistGo/alist
```

@tab 2

Mount to a subdirectory, you can mount multiple repositories

##### Input

```
/alist-gh:alistGo/alist
/alist-web-gh:alistGo/alist-web
```

The leading `/` can be omitted:

```
alist-gh:alistGo/alist
alist-web-gh:alistGo/alist-web
```

:::

## Show README file

Off switch:
```
alist/
├── alist-linux-amd64.tar.gz
└── alist-windows-amd64.zip
```

On switch:
```
alist/
├── alist-linux-amd64.tar.gz
├── alist-windows-amd64.zip
├── README.md
├── README_cn.md
└── LICENSE
```

If enabled, the total size and modification time of the folder will not be displayed.

## Token

Required when accessing private repositories, and can also reduce the impact of rate limits.

Log in GitHub and visit: <https://github.com/settings/tokens>

## Show all version

Off switch:
```
alist/
├── alist-linux-amd64.tar.gz
└── alist-windows-amd64.zip
```

On switch:
```
alist/
├── v3.41.0/
│ ├── alist-linux-amd64.tar.gz
│ └── alist-windows-amd64.zip
├── v3.40.0/
│ ├── alist-linux-amd64.tar.gz
│ └── alist-windows-amd64.zip
└── v3.39.4/
├── alist-linux-amd64.tar.gz
└── alist-windows-amd64.zip
```

### **The default download method used**

```mermaid
---
title: Which download method is used by default?
---
flowchart TB
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
subgraph ide1 [ ]
a1
end
a1[302]:::someclass====|default|a2[user equipment]
classDef someclass fill:#f96
c1[local proxy]-.alternative.->a2[user equipment]
click a1 "../drivers/common.html#webdav-policy"
click b1 "../drivers/common.html#webdav-policy"
```

129 changes: 129 additions & 0 deletions docs/zh/guide/drivers/github_releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
---
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 41
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Storage
- Guide
- "302"
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---
# GitHub Releases

:::tip
GitHub API 速率限制:未经身份验证的请求的主要速率限制为每小时 60 个请求。使用个人访问令牌发出 API 请求计入您每小时 5000 个请求的个人速率限制。
:::

## 仓库结构

:::tabs#UrlTree
@tab 1

最简单的用法,直接写 `所有者/仓库`,只能填一个

##### 输入

```
alistGo/alist
```

与下面的写法效果一致:
```
/:alistGo/alist
```

@tab 2

挂载到子目录,可以挂多个仓库

##### 输入

```
/alist-gh:alistGo/alist
/alist-web-gh:alistGo/alist-web
```

最前面的 `/` 可以省略:

```
alist-gh:alistGo/alist
alist-web-gh:alistGo/alist-web
```

:::

## 显示 README、LICENSE 文件

开启前:
```
alist/
├── alist-linux-amd64.tar.gz
└── alist-windows-amd64.zip
```

开启后:
```
alist/
├── alist-linux-amd64.tar.gz
├── alist-windows-amd64.zip
├── README.md
├── README_cn.md
└── LICENSE
```

开启后,不显示文件夹总大小和修改时间。

## 令牌

访问私有仓库时需要,也可减少速率访问限制的影响。访问:<https://github.com/settings/tokens>

## 显示所有版本

开启前:
```
alist/
├── alist-linux-amd64.tar.gz
└── alist-windows-amd64.zip
```

开启后:
```
alist/
├── v3.41.0/
│ ├── alist-linux-amd64.tar.gz
│ └── alist-windows-amd64.zip
├── v3.40.0/
│ ├── alist-linux-amd64.tar.gz
│ └── alist-windows-amd64.zip
└── v3.39.4/
├── alist-linux-amd64.tar.gz
└── alist-windows-amd64.zip
```

### **默认使用的下载方式**

```mermaid
---
title: 默认使用的哪种下载方式?
---
flowchart TB
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
subgraph ide1 [ ]
a1
end
a1[302]:::someclass====|默认|a2[用户设备]
classDef someclass fill:#f96
c1[本机代理]-.备选.->a2[用户设备]
click a1 "../drivers/common.html#webdav-策略"
click b1 "../drivers/common.html#webdav-策略"
```