Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add chinese documentations for Packages (#24914) #25016

Merged
merged 6 commits into from
May 31, 2023
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
133 changes: 133 additions & 0 deletions docs/content/doc/packages/alpine.zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
date: "2023-03-25T00:00:00+00:00"
title: "Alpine 软件包注册表"
slug: "alpine"
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Alpine"
weight: 4
identifier: "alpine"
---

# Alpine 软件包注册表

在您的用户或组织中发布 [Alpine](https://pkgs.alpinelinux.org/) 软件包。

**目录**

{{< toc >}}

## 要求

要使用 Alpine 注册表,您需要使用像 curl 这样的 HTTP 客户端来上传包,并使用像 apk 这样的包管理器来消费包。

以下示例使用 `apk`。

## 配置软件包注册表

要注册 Alpine 注册表,请将 URL 添加到已知的 apk 源列表中 (`/etc/apk/repositories`):

```
https://gitea.example.com/api/packages/{owner}/alpine/<branch>/<repository>
```

| 占位符 | 描述 |
| ------------ | -------------- |
| `owner` | 软件包所有者 |
| `branch` | 要使用的分支名 |
| `repository` | 要使用的仓库名 |

如果注册表是私有的,请在 URL 中提供凭据。您可以使用密码或[个人访问令牌]({{< relref "doc/development/api-usage.zh-cn.md#通过-api-认证" >}}):

```
https://{username}:{your_password_or_token}@gitea.example.com/api/packages/{owner}/alpine/<branch>/<repository>
```

Alpine 注册表文件使用 RSA 密钥进行签名,apk 必须知道该密钥。下载公钥并将其存储在 `/etc/apk/keys/` 目录中:

```shell
curl -JO https://gitea.example.com/api/packages/{owner}/alpine/key
```

之后,更新本地软件包索引:

```shell
apk update
```

## 发布软件包

要发布一个 Alpine 包(`*.apk`),请执行带有包内容的 HTTP `PUT` 操作,将其放在请求体中。

```
PUT https://gitea.example.com/api/packages/{owner}/alpine/{branch}/{repository}
```

| 参数 | 描述 |
| ------------ | --------------------------------------------------------------------------------------------------- |
| `owner` | 包的所有者。 |
| `branch` | 分支可以与操作系统的发行版本匹配,例如:v3.17。 |
| `repository` | 仓库可以用于[分组包](https://wiki.alpinelinux.org/wiki/Repositories) 或者只是 `main` 或类似的名称。 |

使用 HTTP 基本身份验证的示例请求:

```shell
curl --user your_username:your_password_or_token \
--upload-file path/to/file.apk \
https://gitea.example.com/api/packages/testuser/alpine/v3.17/main
```

如果您使用的是双重身份验证或 OAuth,请使用[个人访问令牌]({{< relref "doc/development/api-usage.zh-cn.md#通过-api-认证" >}})代替密码。
您不能将具有相同名称的文件两次发布到一个包中。您必须首先删除现有的包文件。

服务器将以以下的 HTTP 状态码响应:

| HTTP 状态码 | 含义 |
| ----------------- | ------------------------------------------ |
| `201 Created` | 软件包已发布。 |
| `400 Bad Request` | 软件包的名称、版本、分支、仓库或架构无效。 |
| `409 Conflict` | 具有相同参数组合的包文件已存在于软件包中。 |

## 删除软件包

要删除 Alpine 包,执行 HTTP 的 DELETE 操作。如果没有文件,这将同时删除包版本。

```
DELETE https://gitea.example.com/api/packages/{owner}/alpine/{branch}/{repository}/{architecture}/{filename}
```

| 参数 | 描述 |
| -------------- | -------------- |
| `owner` | 软件包的所有者 |
| `branch` | 要使用的分支名 |
| `repository` | 要使用的仓库名 |
| `architecture` | 软件包的架构 |
| `filename` | 要删除的文件名 |

使用 HTTP 基本身份验证的示例请求:

```shell
curl --user your_username:your_token_or_password -X DELETE \
https://gitea.example.com/api/packages/testuser/alpine/v3.17/main/test-package-1.0.0.apk
```

服务器将以以下的 HTTP 状态码响应:

| HTTP 状态码 | 含义 |
| ---------------- | ------------------ |
| `204 No Content` | 成功 |
| `404 Not Found` | 未找到软件包或文件 |

## 安装软件包

要从 Alpine 注册表安装软件包,请执行以下命令:

```shell
# use latest version
apk add {package_name}
# use specific version
apk add {package_name}={package_version}
```
110 changes: 110 additions & 0 deletions docs/content/doc/packages/cargo.zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
date: "2022-11-20T00:00:00+00:00"
title: "Cargo 软件包注册表"
slug: "cargo"
weight: 5
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Cargo"
weight: 5
identifier: "cargo"
---

# Cargo 软件包注册表

为您的用户或组织发布 [Cargo](https://doc.rust-lang.org/stable/cargo/) 软件包。

**目录**

{{< toc >}}

## 要求

若要使用 Cargo 软件包注册表, 您需要安装 [Rust 和 Cargo](https://www.rust-lang.org/tools/install).

Cargo 将可用软件包的信息存储在一个存储在 git 仓库中的软件包索引中。
这个仓库是与注册表交互所必需的。
下面的部分将介绍如何创建它。

## 索引仓库

Cargo 将可用软件包的信息存储在一个存储在 git 仓库中的软件包索引中。
在 Gitea 中,这个仓库有一个特殊的名称叫做 `_cargo-index`。
在上传软件包之后,它的元数据会自动写入索引中。
不应手动修改这个注册表的内容。

用户或组织软件包设置页面允许创建这个索引仓库以及配置文件。
如果需要,此操作将重写配置文件。
例如,如果 Gitea 实例的域名已更改,这将非常有用。

如果存储在 Gitea 中的软件包与索引注册表中的信息不同步,设置页面允许重建这个索引注册表。
这个操作将遍历注册表中的所有软件包,并将它们的信息写入索引中。
如果有很多软件包,这个过程可能需要一些时间。

## 配置软件包注册表

要注册这个软件包注册表,必须更新 Cargo 的配置。
将以下文本添加到位于当前用户主目录中的配置文件中(例如 `~/.cargo/config.toml`):

```
[registry]
default = "gitea"

[registries.gitea]
index = "https://gitea.example.com/{owner}/_cargo-index.git"

[net]
git-fetch-with-cli = true
```

| 参数 | 描述 |
| ------- | ---------------- |
| `owner` | 软件包的所有者。 |

如果这个注册表是私有的或者您想要发布新的软件包,您必须配置您的凭据。
将凭据部分添加到位于当前用户主目录中的凭据文件中(例如 `~/.cargo/credentials.toml`):

```
[registries.gitea]
token = "Bearer {token}"
```

| 参数 | 描述 |
| ------- | ------------------------------------------------------------------------------------- |
| `token` | 您的[个人访问令牌]({{< relref "doc/development/api-usage.zh-cn.md#通过-api-认证" >}}) |

## 发布软件包

在项目中运行以下命令来发布软件包:

```shell
cargo publish
```

如果已经存在同名和版本的软件包,您将无法发布新的软件包。您必须先删除现有的软件包。

## 安装软件包

要从软件包注册表安装软件包,请执行以下命令:

```shell
cargo add {package_name}
```

| 参数 | 描述 |
| -------------- | ------------ |
| `package_name` | 软件包名称。 |

## 支持的命令

```
cargo publish
cargo add
cargo install
cargo yank
cargo unyank
cargo search
```
97 changes: 97 additions & 0 deletions docs/content/doc/packages/chef.zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
date: "2023-01-20T00:00:00+00:00"
title: "Chef 软件包注册表"
slug: "chef"
weight: 5
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Chef"
weight: 5
identifier: "chef"
---

# Chef Package Registry

为您的用户或组织发布 [Chef](https://chef.io/) cookbooks。

**目录**

{{< toc >}}

## 要求

要使用 Chef 软件包注册表,您需要使用 [`knife`](https://docs.chef.io/workstation/knife/).

## 认证

Chef 软件包注册表不使用用户名和密码进行身份验证,而是使用私钥和公钥对请求进行签名。
请访问软件包所有者设置页面以创建必要的密钥对。
只有公钥存储在Gitea中。如果您丢失了私钥的访问权限,您必须重新生成密钥对。
[配置 `knife`](https://docs.chef.io/workstation/knife_setup/),使用下载的私钥,并将 Gitea 用户名设置为 `client_name`。

## 配置软件包注册表

要将 [`knife` 配置](https://docs.chef.io/workstation/knife_setup/)为使用 Gitea 软件包注册表,请将 URL 添加到 `~/.chef/config.rb` 文件中。

```
knife[:supermarket_site] = 'https://gitea.example.com/api/packages/{owner}/chef'
```

| 参数 | 描述 |
| ------- | -------------- |
| `owner` | 软件包的所有者 |

## 发布软件包

若要发布 Chef 软件包,请执行以下命令:

```shell
knife supermarket share {package_name}
```

| 参数 | 描述 |
| -------------- | ---------- |
| `package_name` | 软件包名称 |

如果已经存在同名和版本的软件包,则无法发布新的软件包。您必须先删除现有的软件包。

## 安装软件包

要从软件包注册表中安装软件包,请执行以下命令:

```shell
knife supermarket install {package_name}
```

您可以指定软件包的版本,这是可选的:

```shell
knife supermarket install {package_name} {package_version}
```

| 参数 | 描述 |
| ----------------- | ---------- |
| `package_name` | 软件包名称 |
| `package_version` | 软件包版本 |

## 删除软件包

如果您想要从注册表中删除软件包,请执行以下命令:

```shell
knife supermarket unshare {package_name}
```

可选地,您可以指定软件包的版本:

```shell
knife supermarket unshare {package_name}/versions/{package_version}
```

| 参数 | 描述 |
| ----------------- | ---------- |
| `package_name` | 软件包名称 |
| `package_version` | 软件包版本 |
Loading