docs: update zh-tw (#265)

Reviewed-on: https://gitea.com/gitea/docs/pulls/265
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: ifurther <[email protected]>
Co-committed-by: ifurther <[email protected]>
This commit is contained in:
ifurther
2025-09-03 21:00:35 +00:00
committed by techknowlogick
parent 908a27589d
commit cb462089e9
88 changed files with 3545 additions and 3423 deletions
@@ -11,17 +11,17 @@ aliases:
## 用法
`gitea [全局项] 命令 [命令或全局项] [参数...]`
`gitea [全局项] 命令 [命令或全局项] [參數...]`
## 全局
## 全局
所有全局项均可被放置在命令级别。
所有全局项均可被放置在命令级别。
- `--help``-h`:显示帮助文本退出。可
- `--version``-v`:显示版本信息退出。可。 (示例:`Gitea version 1.1.0+218-g7b907ed built with: bindata, sqlite`)。
- `--custom-path path``-C path`Gitea 自定义文件夹的路径。可。 (默认值:`AppWorkPath`/custom 或 `$GITEA_CUSTOM`)。
- `--config path``-c path`Gitea 配置文件的路径。可。 (默认值:`custom`/conf/app.ini)。
- `--work-path path``-w path`Gitea 的 `AppWorkPath`。可。 (默认值:LOCATION_OF_GITEA_BINARY 或 `$GITEA_WORK_DIR`)
- `--help``-h`:显示帮助文本退出。可
- `--version``-v`:显示版本信息退出。可。 (示例:`Gitea version 1.1.0+218-g7b907ed built with: bindata, sqlite`)。
- `--custom-path path``-C path`Gitea 自定义文件夹的路径。可。 (默认值:`AppWorkPath`/custom 或 `$GITEA_CUSTOM`)。
- `--config path``-c path`Gitea 配置文件的路径。可。 (默认值:`custom`/conf/app.ini)。
- `--work-path path``-w path`Gitea 的 `AppWorkPath`。可。 (默认值:LOCATION_OF_GITEA_BINARY 或 `$GITEA_WORK_DIR`)
注意:默认的 custom-path、config 和 work-path 也可以在构建时更改(如果需要)。
@@ -31,10 +31,10 @@ aliases:
启动服务器:
- 项:
- `--port number``-p number`:端口号。可。 (默认值:3000)。覆盖配置文件中的设置。
- `--install-port number`:运行安页面的端口号。可。 (默认值:3000)。覆盖配置文件中的设置。
- `--pid path``-P path`Pid 文件的路径。可
- 项:
- `--port number``-p number`:端口号。可。 (默认值:3000)。覆盖配置文件中的设置。
- `--install-port number`:运行安页面的端口号。可。 (默认值:3000)。覆盖配置文件中的设置。
- `--pid path``-P path`Pid 文件的路径。可
- `--quiet``-q`:只在控制台上输出 Fatal 日志,用于在设置日志之前发出的日志。
- `--verbose`:在控制台上输出跟踪日志,用于在设置日志之前发出的日志。
- 示例:
@@ -42,7 +42,7 @@ aliases:
- `gitea web --port 80`
- `gitea web --config /etc/gitea.ini --pid /some/custom/gitea.pid`
- 注意:
- Gitea 不以 root 用户身份运行。要绑定到低于 1024 的端口,您可以在 Linux 上使用 setcap 命令:`sudo setcap 'cap_net_bind_service=+ep' /path/to/gitea`。每次更新 Gitea 都需要重新行此操作。
- Gitea 不以 root 使用者身份运行。要绑定到低于 1024 的端口,您可以在 Linux 上使用 setcap 命令:`sudo setcap 'cap_net_bind_service=+ep' /path/to/gitea`。每次更新 Gitea 都需要重新行此操作。
### admin
@@ -51,278 +51,278 @@ aliases:
- 命令:
- `user`
- `list`
- 项:
- `--admin`列出管理员用户。可
- 描述:列出所有现有用户
- 项:
- `--admin`列出管理员使用者。可
- 描述:列出所有現有使用者
- 示例:
- `gitea admin user list`
- `delete`
- 项:
- `--email`:要删除的用户的电子邮件。
- `--username`:要删除的用户的用户名。
- `--id`:要删除的用户的 ID。
-提供 `--id``--username``--email` 中的一个。如果提供多个,则所有条件必匹配。
- 项:
- `--email`:要删除的使用者的电子邮件。
- `--username`:要删除的使用者的使用者名。
- `--id`:要删除的使用者的 ID。
-提供 `--id``--username``--email` 中的一个。如果提供多个,则所有条件必匹配。
- 示例:
- `gitea admin user delete --id 1`
- `create`
- 项:
- `--name value`用户名。必填。自 Gitea 1.9.0 版本起,改用 `--username` 标志。
- `--username value`用户名。必填。Gitea 1.9.0 新增。
- `--password value`:密。必填。
- 项:
- `--name value`使用者名。必填。自 Gitea 1.9.0 版本起,改用 `--username` 标志。
- `--username value`使用者名。必填。Gitea 1.9.0 新增。
- `--password value`:密。必填。
- `--email value`:邮箱。必填。
- `--admin`:如果提供此项,将建一个管理员用户。可
- `--access-token`:如果提供,将为用户创建访问令牌。可。(默认值:false)。
- `--must-change-password`:如果提供,创建的用户将在初始登后需要择一个新密。可。(默认值:true)。
- `--random-password`:如果提供,将使用随机生成的密码作为创建用户的密`--password` 的值将被忽略。可
- `--random-password-length`:如果提供,将用于配置随机生成密的长度。可。(默认值:12
- `--admin`:如果提供此项,将建一个管理员使用者。可
- `--access-token`:如果提供,将為使用者建立访问令牌。可。(默认值:false)。
- `--must-change-password`:如果提供,建立的使用者将在初始登后需要择一个新密。可。(默认值:true)。
- `--random-password`:如果提供,将使用随机生成的密碼作為建立使用者的密`--password` 的值将被忽略。可
- `--random-password-length`:如果提供,将用于配置随机生成密的长度。可。(默认值:12
- 示例:
- `gitea admin user create --username myname --password asecurepassword --email [email protected]`
- `change-password`
- 项:
- `--username value``-u value`用户名。必填。
- `--password value``-p value`:新密。必填。
- 项:
- `--username value``-u value`使用者名。必填。
- `--password value``-p value`:新密。必填。
- 示例:
- `gitea admin user change-password --username myname --password asecurepassword`
- `must-change-password`
- 参数
- `[username...]`:需要更改密码的用户
- 项:
- `--all``-A`:强制所有用户更改密
- `--exclude username``-e username`:排除给定的用户。可以多次设置。
- `--unset`:撤销对给定用户的强制密更改
- 參數
- `[username...]`:需要更改密碼的使用者
- 项:
- `--all``-A`:强制所有使用者更改密
- `--exclude username``-e username`:排除给定的使用者。可以多次设置。
- `--unset`:撤销对给定使用者的强制密更改
- `regenerate`
- 项:
- `hooks`:重新生成所有仓库的 Git Hooks。
- 项:
- `hooks`:重新生成所有存放庫的 Git Hooks。
- `keys`:重新生成 authorized_keys 文件。
- 示例:
- `gitea admin regenerate hooks`
- `gitea admin regenerate keys`
- `auth`
- `list`
- 描述:列出所有存在的外部认证源。
- 描述:列出所有存在的外部認證源。
- 示例:
- `gitea admin auth list`
- `delete`
- 项:
- 项:
- `--id`:要删除的源的 ID。必填。
- 示例:
- `gitea admin auth delete --id 1`
- `add-oauth`
- 项:
- `--name`用程序名
- 项:
- `--name`用程序名
- `--provider`OAuth2 提供者。
- `--key`:客户端 IDKey)。
- `--secret`:客户端密钥。
- `--auto-discover-url`OpenID Connect 自动发 URL在使用 OpenID Connect 作提供程序时需要)。
- `--auto-discover-url`OpenID Connect 自动发 URL在使用 OpenID Connect 作提供程序时需要)。
- `--use-custom-urls`:在 GitLab/GitHub OAuth 端点上使用自定义 URL。
- `--custom-tenant-id`:在 OAuth 端点上使用自定义租户 ID。
- `--custom-auth-url`:使用自定义授权 URLGitLab/GitHub 的项)。
- `--custom-token-url`:使用自定义令牌 URLGitLab/GitHub 的项)。
- `--custom-profile-url`:使用自定义配置文件 URLGitLab/GitHub 的项)。
- `--custom-email-url`:使用自定义电子邮件 URL(GitHub 的项)。
- `--icon-url`OAuth2 登源的自定义图标 URL。
- `--skip-local-2fa`:允许源覆盖本地 2FA。(可
- `--scopes`求此 OAuth2 源的附加范围。(可
- `--required-claim-name`:必设置的声明名,以允许用户使用此源登。(可
- `--required-claim-value`:必设置的声明值,以允许用户使用此源登。(可
- `--group-claim-name`:提供此源的组名的声明名。(可
- `--admin-group`:管理员用户的组声明值。(可
- `--restricted-group`:受限用户的组声明值。(可
- `--group-team-map`:组与组织团队之间的 JSON 映射。(可
- `--group-team-map-removal`:根据组自动激活团队成员资格的删除。(可
- `--custom-auth-url`:使用自定义授权 URLGitLab/GitHub 的项)。
- `--custom-token-url`:使用自定义令牌 URLGitLab/GitHub 的项)。
- `--custom-profile-url`:使用自定义配置文件 URLGitLab/GitHub 的项)。
- `--custom-email-url`:使用自定义电子邮件 URL(GitHub 的项)。
- `--icon-url`OAuth2 登源的自定义图标 URL。
- `--skip-local-2fa`:允许源覆盖本地 2FA。(可
- `--scopes`求此 OAuth2 源的附加范围。(可
- `--required-claim-name`:必设置的声明名,以允许使用者使用此源登。(可
- `--required-claim-value`:必设置的声明值,以允许使用者使用此源登。(可
- `--group-claim-name`:提供此源的组名的声明名。(可
- `--admin-group`:管理员使用者的组声明值。(可
- `--restricted-group`:受限使用者的组声明值。(可
- `--group-team-map`:组与組織团队之间的 JSON 映射。(可
- `--group-team-map-removal`:根据组自动激活团队成员资格的删除。(可
- 示例:
- `gitea admin auth add-oauth --name external-github --provider github --key OBTAIN_FROM_SOURCE --secret OBTAIN_FROM_SOURCE`
- `update-oauth`
- 项:
- 项:
- `--id`:要更新的源的 ID。必填。
- `--name`用程序名
- `--name`用程序名
- `--provider`OAuth2 提供者。
- `--key`:客户端 IDKey)。
- `--secret`:客户端密钥。
- `--auto-discover-url`OpenID Connect 自动发 URL在使用 OpenID Connect 作提供程序时需要)。
- `--auto-discover-url`OpenID Connect 自动发 URL在使用 OpenID Connect 作提供程序时需要)。
- `--use-custom-urls`:在 GitLab/GitHub OAuth 端点上使用自定义 URL。
- `--custom-tenant-id`:在 OAuth 端点上使用自定义租户 ID。
- `--custom-auth-url`:使用自定义授权 URLGitLab/GitHub 的项)。
- `--custom-token-url`:使用自定义令牌 URLGitLab/GitHub 的项)。
- `--custom-profile-url`:使用自定义配置文件 URLGitLab/GitHub 的项)。
- `--custom-email-url`:使用自定义电子邮件 URL(GitHub 的项)。
- `--icon-url`OAuth2 登源的自定义图标 URL。
- `--skip-local-2fa`:允许源覆盖本地 2FA。(可
- `--scopes`求此 OAuth2 源的附加范围。
- `--required-claim-name`:必设置的声明名,以允许用户使用此源登。(可
- `--required-claim-value`:必设置的声明值,以允许用户使用此源登。(可
- `--group-claim-name`:提供此源的组名的声明名。(可
- `--admin-group`:管理员用户的组声明值。(可
- `--restricted-group`:受限用户的组声明值。(可
- `--custom-auth-url`:使用自定义授权 URLGitLab/GitHub 的项)。
- `--custom-token-url`:使用自定义令牌 URLGitLab/GitHub 的项)。
- `--custom-profile-url`:使用自定义配置文件 URLGitLab/GitHub 的项)。
- `--custom-email-url`:使用自定义电子邮件 URL(GitHub 的项)。
- `--icon-url`OAuth2 登源的自定义图标 URL。
- `--skip-local-2fa`:允许源覆盖本地 2FA。(可
- `--scopes`求此 OAuth2 源的附加范围。
- `--required-claim-name`:必设置的声明名,以允许使用者使用此源登。(可
- `--required-claim-value`:必设置的声明值,以允许使用者使用此源登。(可
- `--group-claim-name`:提供此源的组名的声明名。(可
- `--admin-group`:管理员使用者的组声明值。(可
- `--restricted-group`:受限使用者的组声明值。(可
- 示例:
- `gitea admin auth update-oauth --id 1 --name external-github-updated`
- `add-smtp`
- 项:
- `--name`用程序名。必填。
- `--auth-type`SMTP 认证类型(PLAIN/LOGIN/CRAM-MD5)。默认 PLAIN。
- 项:
- `--name`用程序名。必填。
- `--auth-type`SMTP 認證類型(PLAIN/LOGIN/CRAM-MD5)。默认 PLAIN。
- `--host`SMTP 主机。必填。
- `--port`SMTP 端口。必填。
- `--force-smtps`:SMTPS 始终在端口 465 上使用。设置此项以强制在其他端口上使用 SMTPS。
- `--skip-verify`:跳 TLS 验证
- `--force-smtps`:SMTPS 始终在端口 465 上使用。设置此项以强制在其他端口上使用 SMTPS。
- `--skip-verify`:跳 TLS 驗證
- `--helo-hostname`:发送 HELO 时使用的主机名。留空以发送当前主机名。
- `--disable-helo`:禁用 SMTP helo。
- `--allowed-domains`:留空以允许所有域。使用逗号(',')分隔多个域。
- `--skip-local-2fa`:跳 2FA 登
- `--active`:启用此认证源。
- `--skip-local-2fa`:跳 2FA 登
- `--active`:启用此認證源。
备注:
`--force-smtps``--skip-verify``--disable-helo``--skip-local-2fs``--active` 项可以采用以下形式使用:
- `--option``--option=true` 以启用
- `--option=false` 以禁用
如果未指定这些项,则在 `update-smtp` 中不会更改值,或者在 `add-smtp` 中将使用默认的 `false` 值。
`--force-smtps``--skip-verify``--disable-helo``--skip-local-2fs``--active` 项可以采用以下形式使用:
- `--option``--option=true` 以启用
- `--option=false` 以禁用
如果未指定这些项,则在 `update-smtp` 中不会更改值,或者在 `add-smtp` 中将使用默认的 `false` 值。
- 示例:
- `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active`
- `update-smtp`
- 项:
- 项:
- `--id`:要更新的源的 ID。必填。
- 其他项与 `add-smtp` 共享
- 其他项与 `add-smtp` 共享
- 示例:
- `gitea admin auth update-smtp --id 1 --host smtp.mydomain.org --port 587 --skip-verify=false`
- `gitea admin auth update-smtp --id 1 --active=false`
- `add-ldap`:添加新的 LDAP(通 Bind DN认证
- 项:
- `--name value`认证名称。必填。
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名。必填。
- `--skip-tls-verify`:禁用 TLS 验证
- `add-ldap`:添加新的 LDAP(通 Bind DN認證
- 项:
- `--name value`認證名稱。必填。
- `--not-active`:停用認證源。
- `--security-protocol value`:安全协议名。必填。
- `--skip-tls-verify`:禁用 TLS 驗證
- `--host value`LDAP 服务器的地址。必填。
- `--port value`:连接到 LDAP 服务器时使用的端口。必填。
- `--user-search-base value`用户帐户将在其中搜索的 LDAP 基础路径。必填。
- `--user-filter value`:声明如何查找试图行身份验证的用户记录的 LDAP 滤器。必填。
- `--admin-filter value`:指定是否授予用户管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否应将用户设置受限状态的 LDAP 滤器。
- `--username-attribute value`用户 LDAP 记录中包含用户名的属性。
- `--firstname-attribute value`用户 LDAP 记录中包含用户名字的属性。
- `--surname-attribute value`用户 LDAP 记录中包含用户姓氏的属性。
- `--email-attribute value`用户 LDAP 记录中包含用户电子邮件地址的属性。必填。
- `--public-ssh-key-attribute value`用户 LDAP 记录中包含用户公共 SSH 密钥的属性。
- `--avatar-attribute value`用户 LDAP 记录中包含用户头像的属性。
- `--bind-dn value`:在搜索用户时绑定到 LDAP 服务器的 DN。
- `--bind-password value`:绑定 DN 的密(如果有)。
- `--user-search-base value`使用者帳戶将在其中搜索的 LDAP 基础路径。必填。
- `--user-filter value`:声明如何查找试图行身份驗證的使用者记录的 LDAP 滤器。必填。
- `--admin-filter value`:指定是否授予使用者管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否應将使用者设置受限状态的 LDAP 滤器。
- `--username-attribute value`使用者 LDAP 记录中包含使用者名的属性。
- `--firstname-attribute value`使用者 LDAP 记录中包含使用者名字的属性。
- `--surname-attribute value`使用者 LDAP 记录中包含使用者姓氏的属性。
- `--email-attribute value`使用者 LDAP 记录中包含使用者电子邮件地址的属性。必填。
- `--public-ssh-key-attribute value`使用者 LDAP 记录中包含使用者公共 SSH 密钥的属性。
- `--avatar-attribute value`使用者 LDAP 记录中包含使用者头像的属性。
- `--bind-dn value`:在搜索使用者时绑定到 LDAP 服务器的 DN。
- `--bind-password value`:绑定 DN 的密(如果有)。
- `--attributes-in-bind`:在绑定 DN 上下文中获取属性。
- `--synchronize-users`:启用用户同步。
- `--synchronize-users`:启用使用者同步。
- `--page-size value`:搜索页面大小。
- 示例:
- `gitea admin auth add-ldap --name ldap --security-protocol unencrypted --host mydomain.org --port 389 --user-search-base "ou=Users,dc=mydomain,dc=org" --user-filter "(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))" --email-attribute mail`
- `update-ldap`:更新有的 LDAP(通 Bind DN认证
- 项:
- `--id value`认证源的 ID。必填。
- `--name value`认证名称
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名
- `--skip-tls-verify`:禁用 TLS 验证
- `update-ldap`:更新有的 LDAP(通 Bind DN認證
- 项:
- `--id value`認證源的 ID。必填。
- `--name value`認證名稱
- `--not-active`:停用認證源。
- `--security-protocol value`:安全协议名
- `--skip-tls-verify`:禁用 TLS 驗證
- `--host value`LDAP 服务器的地址。
- `--port value`:连接到 LDAP 服务器时使用的端口。
- `--user-search-base value`用户帐户将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图行身份验证的用户记录的 LDAP 滤器。
- `--admin-filter value`:指定是否授予用户管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否应将用户设置受限状态的 LDAP 滤器。
- `--username-attribute value`用户 LDAP 记录中包含用户名的属性。
- `--firstname-attribute value`用户 LDAP 记录中包含用户名字的属性。
- `--surname-attribute value`用户 LDAP 记录中包含用户姓氏的属性。
- `--email-attribute value`用户 LDAP 记录中包含用户电子邮件地址的属性。
- `--public-ssh-key-attribute value`用户 LDAP 记录中包含用户公共 SSH 密钥的属性。
- `--avatar-attribute value`用户 LDAP 记录中包含用户头像的属性。
- `--bind-dn value`:在搜索用户时绑定到 LDAP 服务器的 DN。
- `--bind-password value`:绑定 DN 的密(如果有)。
- `--user-search-base value`使用者帳戶将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图行身份驗證的使用者记录的 LDAP 滤器。
- `--admin-filter value`:指定是否授予使用者管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否應将使用者设置受限状态的 LDAP 滤器。
- `--username-attribute value`使用者 LDAP 记录中包含使用者名的属性。
- `--firstname-attribute value`使用者 LDAP 记录中包含使用者名字的属性。
- `--surname-attribute value`使用者 LDAP 记录中包含使用者姓氏的属性。
- `--email-attribute value`使用者 LDAP 记录中包含使用者电子邮件地址的属性。
- `--public-ssh-key-attribute value`使用者 LDAP 记录中包含使用者公共 SSH 密钥的属性。
- `--avatar-attribute value`使用者 LDAP 记录中包含使用者头像的属性。
- `--bind-dn value`:在搜索使用者时绑定到 LDAP 服务器的 DN。
- `--bind-password value`:绑定 DN 的密(如果有)。
- `--attributes-in-bind`:在绑定 DN 上下文中获取属性。
- `--synchronize-users`:启用用户同步。
- `--synchronize-users`:启用使用者同步。
- `--page-size value`:搜索页面大小。
- 示例:
- `gitea admin auth update-ldap --id 1 --name "my ldap auth source"`
- `gitea admin auth update-ldap --id 1 --username-attribute uid --firstname-attribute givenName --surname-attribute sn`
- `add-ldap-simple`:添加新的 LDAP(简身份验证)认证
- 项:
- `--name value`认证名称。必填。
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名。必填。
- `--skip-tls-verify`:禁用 TLS 验证
- `add-ldap-simple`:添加新的 LDAP(简身份驗證)認證
- 项:
- `--name value`認證名稱。必填。
- `--not-active`:停用認證源。
- `--security-protocol value`:安全协议名。必填。
- `--skip-tls-verify`:禁用 TLS 驗證
- `--host value`LDAP 服务器的地址。必填。
- `--port value`:连接到 LDAP 服务器时使用的端口。必填。
- `--user-search-base value`用户帐户将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图行身份验证的用户记录的 LDAP 滤器。必填。
- `--admin-filter value`:指定是否授予用户管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否应将用户设置受限状态的 LDAP 滤器。
- `--username-attribute value`用户 LDAP 记录中包含用户名的属性。
- `--firstname-attribute value`用户 LDAP 记录中包含用户名字的属性。
- `--surname-attribute value`用户 LDAP 记录中包含用户姓氏的属性。
- `--email-attribute value`用户 LDAP 记录中包含用户电子邮件地址的属性。必填。
- `--public-ssh-key-attribute value`用户 LDAP 记录中包含用户公共 SSH 密钥的属性。
- `--avatar-attribute value`用户 LDAP 记录中包含用户头像的属性。
- `--user-dn value`用户的 DN。必填。
- `--user-search-base value`使用者帳戶将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图行身份驗證的使用者记录的 LDAP 滤器。必填。
- `--admin-filter value`:指定是否授予使用者管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否應将使用者设置受限状态的 LDAP 滤器。
- `--username-attribute value`使用者 LDAP 记录中包含使用者名的属性。
- `--firstname-attribute value`使用者 LDAP 记录中包含使用者名字的属性。
- `--surname-attribute value`使用者 LDAP 记录中包含使用者姓氏的属性。
- `--email-attribute value`使用者 LDAP 记录中包含使用者电子邮件地址的属性。必填。
- `--public-ssh-key-attribute value`使用者 LDAP 记录中包含使用者公共 SSH 密钥的属性。
- `--avatar-attribute value`使用者 LDAP 记录中包含使用者头像的属性。
- `--user-dn value`使用者的 DN。必填。
- 示例:
- `gitea admin auth add-ldap-simple --name ldap --security-protocol unencrypted --host mydomain.org --port 389 --user-dn "cn=%s,ou=Users,dc=mydomain,dc=org" --user-filter "(&(objectClass=posixAccount)(cn=%s))" --email-attribute mail`
- `update-ldap-simple`:更新有的 LDAP(简身份验证)认证
- 项:
- `--id value`认证源的 ID。必填。
- `--name value`认证名称
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名
- `--skip-tls-verify`:禁用 TLS 验证
- `update-ldap-simple`:更新有的 LDAP(简身份驗證)認證
- 项:
- `--id value`認證源的 ID。必填。
- `--name value`認證名稱
- `--not-active`:停用認證源。
- `--security-protocol value`:安全协议名
- `--skip-tls-verify`:禁用 TLS 驗證
- `--host value`LDAP 服务器的地址。
- `--port value`:连接到 LDAP 服务器时使用的端口。
- `--user-search-base value`用户帐户将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图行身份验证的用户记录的 LDAP 滤器。
- `--admin-filter value`:指定是否授予用户管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否应将用户设置受限状态的 LDAP 滤器。
- `--username-attribute value`用户 LDAP 记录中包含用户名的属性。
- `--firstname-attribute value`用户 LDAP 记录中包含用户名字的属性。
- `--surname-attribute value`用户 LDAP 记录中包含用户姓氏的属性。
- `--email-attribute value`用户 LDAP 记录中包含用户电子邮件地址的属性。
- `--public-ssh-key-attribute value`用户 LDAP 记录中包含用户公共 SSH 密钥的属性。
- `--avatar-attribute value`用户 LDAP 记录中包含用户头像的属性。
- `--user-dn value`用户的 DN。
- `--user-search-base value`使用者帳戶将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图行身份驗證的使用者记录的 LDAP 滤器。
- `--admin-filter value`:指定是否授予使用者管理员特权的 LDAP 滤器。
- `--restricted-filter value`:指定是否應将使用者设置受限状态的 LDAP 滤器。
- `--username-attribute value`使用者 LDAP 记录中包含使用者名的属性。
- `--firstname-attribute value`使用者 LDAP 记录中包含使用者名字的属性。
- `--surname-attribute value`使用者 LDAP 记录中包含使用者姓氏的属性。
- `--email-attribute value`使用者 LDAP 记录中包含使用者电子邮件地址的属性。
- `--public-ssh-key-attribute value`使用者 LDAP 记录中包含使用者公共 SSH 密钥的属性。
- `--avatar-attribute value`使用者 LDAP 记录中包含使用者头像的属性。
- `--user-dn value`使用者的 DN。
- 示例:
- `gitea admin auth update-ldap-simple --id 1 --name "my ldap auth source"`
- `gitea admin auth update-ldap-simple --id 1 --username-attribute uid --firstname-attribute givenName --surname-attribute sn`
### cert
生成自签名的 SSL 证书。将输出到当前目下的`cert.pem``key.pem`文件中,且会覆盖任何有文件。
生成自签名的 SSL 证书。将输出到当前目下的`cert.pem``key.pem`文件中,且会覆盖任何有文件。
- 项:
- 项:
- `--host value`:逗号分隔的主机名和 IP 地址列表,此证书适用于这些主机。支持使用通配符。必填。
- `--ecdsa-curve value`:用于生成密钥的 ECDSA 曲线。可。有效选项为 P224、P256、P384、P521。
- `--rsa-bits value`:要生成的 RSA 密钥的大小。可。如果设置了--ecdsa-curve,则忽略此项。(默认值:3072)。
- `--start-date value`:证书的建日期。可。(格式:`Jan 1 15:04:05 2011`)。
- `--duration value`:证书有效期。可。(默认值:8760h0m0s
- `--ca`:如果提供此项,则证书将生成自己的证书颁发机构。可
- `--ecdsa-curve value`:用于生成密钥的 ECDSA 曲线。可。有效選项為 P224、P256、P384、P521。
- `--rsa-bits value`:要生成的 RSA 密钥的大小。可。如果设置了--ecdsa-curve,则忽略此项。(默认值:3072)。
- `--start-date value`:证书的建日期。可。(格式:`Jan 1 15:04:05 2011`)。
- `--duration value`:证书有效期。可。(默认值:8760h0m0s
- `--ca`:如果提供此项,则证书将生成自己的证书颁发机构。可
- 示例:
- `gitea cert --host git.example.com,example.com,www.example.com --ca`
### dump
将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目下,类似于`gitea-dump-1482906742.zip`
将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目下,类似于`gitea-dump-1482906742.zip`
- 项:
- `--file name``-f name`:指定要建的导出文件的名。可。(默认值:gitea-dump-[timestamp].zip)。
- `--tempdir path``-t path`:指定临时目的路径。可。(默认值:/tmp)。
- `--skip-repository``-R`:跳过仓库的导出。可
- `--skip-custom-dir`:跳自定义目的导出。可
- `--skip-lfs-data`:跳 LFS 数据的导出。可
- `--skip-attachment-data`:跳附件数据的导出。可
- `--skip-package-data`:跳包数据的导出。可
- `--skip-log`:跳日志数据的导出。可
- `--database``-d`:指定数据库的 SQL 语法。可
- `--verbose``-V`:如果提供此项,显示附加详细信息。可
- `--type`:设置导出的格式。可。(默认值:zip
- 项:
- `--file name``-f name`:指定要建的导出文件的名。可。(默认值:gitea-dump-[timestamp].zip)。
- `--tempdir path``-t path`:指定临时目的路径。可。(默认值:/tmp)。
- `--skip-repository``-R`:跳過存放庫的导出。可
- `--skip-custom-dir`:跳自定义目的导出。可
- `--skip-lfs-data`:跳 LFS 数据的导出。可
- `--skip-attachment-data`:跳附件数据的导出。可
- `--skip-package-data`:跳包数据的导出。可
- `--skip-log`:跳日志数据的导出。可
- `--database``-d`:指定数据库的 SQL 语法。可
- `--verbose``-V`:如果提供此项,显示附加详细信息。可
- `--type`:设置导出的格式。可。(默认值:zip
- 示例:
- `gitea dump`
- `gitea dump --verbose`
### generate
用于在配置文件中生成随机值和令牌。对于自动部署时生成值非常有用。
用于在配置文件中生成随机值和令牌。對於自动部署时生成值非常有用。
- 命令:
- `secret`:
- 项:
- `INTERNAL_TOKEN`: 用于内部 API 调用身份验证的令牌。
- `JWT_SECRET`: 用于 LFS 和 OAUTH2 JWT 身份验证的密钥(LFS_JWT_SECRET 是此项的别名,用于向后兼容)。
- 项:
- `INTERNAL_TOKEN`: 用于内部 API 调用身份驗證的令牌。
- `JWT_SECRET`: 用于 LFS 和 OAUTH2 JWT 身份驗證的密钥(LFS_JWT_SECRET 是此项的别名,用于向后兼容)。
- `SECRET_KEY`: 全局密钥。
- 示例:
- `gitea generate secret INTERNAL_TOKEN`
@@ -331,27 +331,27 @@ aliases:
### keys
提供一个 SSHD AuthorizedKeysCommand。需要在 sshd 配置文件中行配置:
提供一个 SSHD AuthorizedKeysCommand。需要在 sshd 配置文件中行配置:
```ini
...
# -e 的值和 AuthorizedKeysCommandUser 与运行 Gitea 的用户名匹配
# -e 的值和 AuthorizedKeysCommandUser 与运行 Gitea 的使用者名匹配
AuthorizedKeysCommandUser git
AuthorizedKeysCommand /path/to/gitea keys -e git -u %u -t %t -k %k
```
命令将返回适用于提供的密钥的合适 authorized_keys 行。您还应`app.ini``[server]` 部分设置值 `SSH_CREATE_AUTHORIZED_KEYS_FILE=false`
命令将返回适用于提供的密钥的合适 authorized_keys 行。您還應`app.ini``[server]` 部分设置值 `SSH_CREATE_AUTHORIZED_KEYS_FILE=false`
注意: opensshd 要求 Gitea 程序由 root 拥有,且不可由组或其他人写入。程序必使用绝对路径指定。
注意: Gitea 必在运行此命令时处于运行状态才能成功。
注意: opensshd 要求 Gitea 程序由 root 拥有,且不可由组或其他人写入。程序必使用绝对路径指定。
注意: Gitea 必在运行此命令时处于运行状态才能成功。
### migrate
迁移数据库。命令可用于在首次启动服务器之前运行其他命令。此命令是幂等的。
迁移数据库。命令可用于在首次启动服务器之前运行其他命令。此命令是幂等的。
### doctor check
对 Gitea 实例行诊断,可以修复一些可修复的问题。
对 Gitea 实例行诊断,可以修复一些可修复的问题。
默认只运行部分检查,额外的检查可以参考:
- `gitea doctor check --list` - 列出所有可用的检查
@@ -359,8 +359,8 @@ AuthorizedKeysCommand /path/to/gitea keys -e git -u %u -t %t -k %k
- `gitea doctor check --default` - 运行默认的检查
- `gitea doctor check --run [check(s),]...` - 运行指定的名字的检查
有些问题可以通设置 `--fix` 选项进行自动修复。
额外的日志可以通 `--log-file=...` 行设置。
有些问题可以通设置 `--fix` 選项進行自动修复。
额外的日志可以通 `--log-file=...` 行设置。
#### doctor recreate-table
@@ -370,19 +370,19 @@ AuthorizedKeysCommand /path/to/gitea keys -e git -u %u -t %t -k %k
2020/08/02 11:32:29 ...rm/session_schema.go:360:Sync() [W] Table user Column keep_activity_private db default is , struct default is 0
```
您可以通以下方式让 Gitea 重新建这些表,将旧数据复制到新表中,适当设置默认值:
您可以通以下方式让 Gitea 重新建这些表,将旧数据复制到新表中,适当设置默认值:
```
gitea doctor recreate-table user
```
您可以使用以下方式让 Gitea 重新建多个表:
您可以使用以下方式让 Gitea 重新建多个表:
```
gitea doctor recreate-table table1 table2 ...
```
如果您希望 Gitea 重新建所有表,直接调用:
如果您希望 Gitea 重新建所有表,直接调用:
```
gitea doctor recreate-table
@@ -392,47 +392,47 @@ gitea doctor recreate-table
### doctor convert
有的 MySQL 数据库从 utf8 转换 utf8mb4,或者把 MSSQL 数据库从 varchar 转换 nvarchar。
有的 MySQL 数据库从 utf8 转换 utf8mb4,或者把 MSSQL 数据库从 varchar 转换 nvarchar。
### manager
管理运行中的服务器操作:
- 命令:
- `shutdown`: 优雅地关闭运行中的
- `restart`: 优雅地重新启动运行中的程(对于 Windows 服务器尚未实
- `flush-queues`: 刷新运行中的程中的队列
- 项:
- `--timeout value`: 刷新程的超时时间(默认值: 1m0s
- `--non-blocking`: 设置 true,以在返回之前不等待刷新完成
- `shutdown`: 优雅地关闭运行中的
- `restart`: 优雅地重新启动运行中的程(對於 Windows 服务器尚未实
- `flush-queues`: 刷新运行中的程中的队列
- 项:
- `--timeout value`: 刷新程的超时时间(默认值: 1m0s
- `--non-blocking`: 设置 true,以在返回之前不等待刷新完成
- `logging`: 调整日志命令
- 命令:
- `pause`: 暂停日志记录
- 注意:
- 如果日志级别低于此级别,日志级别将被临时提升 INFO。
- Gitea 将在一定程度上缓冲日志,在超过该点后丢弃日志。
- 如果日志级别低于此级别,日志级别将被临时提升 INFO。
- Gitea 将在一定程度上缓冲日志,在超過該点后丢弃日志。
- `resume`: 恢复日志记录
- `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接(相当于向 Gitea 发送 SIGUSR1 信号)。
- `remove name`: 删除指定的日志记录器
- 项:
- `--group group`, `-g group`: 从中删除子记录器的组(默认`default`
- 项:
- `--group group`, `-g group`: 从中删除子记录器的组(默认`default`
- `add`: 添加日志记录器
- 命令:
- `console`: 添加控制台日志记录器
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- `--level value`, `-l value`: 新日志记录器的日志级别
- `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别
- `--flags value`, `-F value`: 日志记录器的标志
- `--expression value`, `-e value`: 日志记录器的匹配表达式
- `--prefix value`, `-p value`: 日志记录器的前缀
- `--color`: 在日志中使用颜色
- `--stderr`: 将控制台日志输出到 stderr - 适用于控制台
- `--stderr`: 将控制台日志输出到 stderr - 适用于控制台
- `file`: 添加文件日志记录器
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- `--level value`, `-l value`: 新日志记录器的日志级别
- `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别
- `--flags value`, `-F value`: 日志记录器的标志
@@ -441,79 +441,79 @@ gitea doctor recreate-table
- `--color`: 在日志中使用颜色
- `--filename value`, `-f value`: 日志记录器的文件名
- `--rotate`, `-r`: 轮转日志
- `--max-size value`, `-s value`: 在轮转之前的最大大小(以字节为单位)
- `--max-size value`, `-s value`: 在轮转之前的最大大小(以字节為單位)
- `--daily`, `-d`: 每天轮转日志
- `--max-days value`, `-D value`: 保留的每日日志的最大数量
- `--compress`, `-z`: 压缩轮转的日志
- `--compression-level value`, `-Z value`: 使用的压缩级别
- `conn`: 添加网络连接日志记录器
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- `--level value`, `-l value`: 新日志记录器的日志级别
- `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别
- `--flags value`, `-F value`: 日志记录器的标志
- `--expression value`, `-e value`: 日志记录器的匹配表达式
- `--prefix value`, `-p value`: 日志记录器的前缀
- `--color`: 在日志中使用颜色
- `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机
- `--reconnect-on-message`, `-R`: 對於每个消息重新连接主机
- `--reconnect`, `-r`: 连接中断时重新连接主机
- `--protocol value`, `-P value`: 设置要使用的协议:tcp、unix 或 udp(默认 tcp
- `--address value`, `-a value`: 要连接到的主机地址和端口(默认:7020
- `--protocol value`, `-P value`: 设置要使用的协议:tcp、unix 或 udp(默认 tcp
- `--address value`, `-a value`: 要连接到的主机地址和端口(默认:7020
- `smtp`: 添加 SMTP 日志记录器
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- 项:
- `--group value`, `-g value`: 要添加日志记录器的组 - 默认"default"
- `--name value`, `-n value`: 新日志记录器的名 - 默认模式
- `--level value`, `-l value`: 新日志记录器的日志级别
- `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别
- `--flags value`, `-F value`: 日志记录器的标志
- `--expression value`, `-e value`: 日志记录器的匹配表达式
- `--prefix value`, `-p value`: 日志记录器的前缀
- `--color`: 在日志中使用颜色
- `--username value`, `-u value`: 邮件服务器用户
- `--password value`, `-P value`: 邮件服务器密
- `--host value`, `-H value`: 邮件服务器主机(默认: 127.0.0.1:25
- `--username value`, `-u value`: 邮件服务器使用者
- `--password value`, `-P value`: 邮件服务器密
- `--host value`, `-H value`: 邮件服务器主机(默认: 127.0.0.1:25
- `--send-to value`, `-s value`: 要发送到的电子邮件地址
- `--subject value`, `-S value`: 发送电子邮件的主题标题
- `processes`: 显示 Gitea 程和 Goroutine 信息
- 项:
- `--flat`: 以平面表格形式显示程,而不是树形结构
- `--no-system`: 不显示系统
- `--stacktraces`: 显示与程关联的 Goroutine 的堆栈跟踪
- `--json`: 输出 JSON 格式
- `--cancel PID`: 向具有 PID 的程发送取消命令(适用于非系统程)
- `processes`: 显示 Gitea 程和 Goroutine 信息
- 项:
- `--flat`: 以平面表格形式显示程,而不是树形结构
- `--no-system`: 不显示系统
- `--stacktraces`: 显示与程关联的 Goroutine 的堆栈跟踪
- `--json`: 输出 JSON 格式
- `--cancel PID`: 向具有 PID 的程发送取消命令(适用于非系统程)
### dump-repo
`dump-repo` 从 Git/GitHub/Gitea/GitLab 中转储存储库数据:
`dump-repo` 从 Git/GitHub/Gitea/GitLab 中转儲存儲库数据:
- 项:
- `--git_service service`Git 服务,可以是 `git``github``gitea``gitlab`。如果 `clone_addr` 可以被识别,则可以忽略此项。
- `--repo_dir dir``-r dir`:存数据的存库目路径。
- 项:
- `--git_service service`Git 服务,可以是 `git``github``gitea``gitlab`。如果 `clone_addr` 可以被识别,则可以忽略此项。
- `--repo_dir dir``-r dir`:存数据的存库目路径。
- `--clone_addr addr`:将被克隆的 URL,目前可以是 git/github/gitea/gitlab 的 http/https URL。例如:https://github.com/lunny/tango.git
- `--auth_username lunny`:访问 `clone_addr`用户名。
- `--auth_password <password>`:访问 `clone_addr` 的密
- `--auth_username lunny`:访问 `clone_addr`使用者名。
- `--auth_password <password>`:访问 `clone_addr` 的密
- `--auth_token <token>`:访问 `clone_addr` 的个人令牌。
- `--owner_name lunny`:如果非空,数据将存在具有所有者名的目中。
- `--repo_name tango`:如果非空,数据将存在具有存库名的目中。
- `--units <units>`:要迁移的项目,一个或多个项目以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果空,则表示所有项目。
- `--owner_name lunny`:如果非空,数据将存在具有所有者名的目中。
- `--repo_name tango`:如果非空,数据将存在具有存库名的目中。
- `--units <units>`:要迁移的项目,一个或多个项目以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果空,则表示所有项目。
### restore-repo
`restore-repo`磁盘目录中还原存库数据:
`restore-repo`硬碟目錄中還原存库数据:
- 项:
- `--repo_dir dir``-r dir`原数据的存库目路径。
- `--owner_name lunny`原目标所有者名
- `--repo_name tango`原目标存库名
- `--units <units>`:要原的项目,一个或多个项目以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果空,则表示所有项目。
- 项:
- `--repo_dir dir``-r dir`原数据的存库目路径。
- `--owner_name lunny`原目标所有者名
- `--repo_name tango`原目标存库名
- `--units <units>`:要原的项目,一个或多个项目以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果空,则表示所有项目。
### actions generate-runner-token
生成一个供 Runner 使用的新令牌,用于向服务器注册。
- 项:
- `--scope {owner}[/{repo}]``-s {owner}[/{repo}]`:限制 Runner 的范围,没有范围表示 Runner 可用于所有仓库,但你也可以将其限制特定的仓库或所有者。
- 项:
- `--scope {owner}[/{repo}]``-s {owner}[/{repo}]`:限制 Runner 的范围,没有范围表示 Runner 可用于所有存放庫,但你也可以将其限制特定的存放庫或所有者。
要注册全局 Runner
@@ -521,13 +521,13 @@ gitea doctor recreate-table
gitea actions generate-runner-token
```
要注册特定组织的 Runner,例如 `org`
要注册特定組織的 Runner,例如 `org`
```
gitea actions generate-runner-token -s org
```
要注册特定仓库的 Runner,例如 `username/test-repo`
要注册特定存放庫的 Runner,例如 `username/test-repo`
```
gitea actions generate-runner-token -s username/test-repo