当前中文文档翻译不是最新版,访问英文版本查看最新内容,或帮助我们翻译
命令行
用法
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
)
注意:默认的 custom-path、config 和 work-path 也可以在构建时更改(如果需要)。
命令
web
启动服务器:
- 选项:
--port number
,-p number
:端口号。可选。 (默认值:3000)。覆盖配置文件中的设置。--install-port number
:运行安装页面的端口号。可选。 (默认值:3000)。覆盖配置文件中的设置。--pid path
,-P path
:Pid 文件的路径。可选。--quiet
,-q
:只在控制台上输出 Fatal 日志,用于在设置日志之前发出的日志。--verbose
:在控制台上输出跟踪日志,用于在设置日志之前发出的日志。
- 示例:
gitea web
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 命令:
admin
管理员操作:
- 命令:
user
:list
:- 选项:
--admin
:仅列出管理员用户。可选。
- 描述:列出所有现有用户。
- 示例:
gitea admin user list
- 选项:
delete
:- 选项:
--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
:密码。必填。--email value
:邮箱。必填。--admin
:如果提供此选项,将创建一个管理员用户。可选。--access-token
:如果提供,将为用户创建访问令牌。可选。(默认值:false)。--must-change-password
:如果提供,创建的用户将在初始登录后需要选择一个新密码。可选。(默认值:true)。--random-password
:如果提供,将使用随机生成的密码作为创建用户的密码。--password
的值将被忽略。可选。--random-password-length
:如果提供,将用于配置随机生成密码的长度。可选。(默认值:12)
- 示例:
gitea admin user create --username myname --password asecurepassword --email me@example.com
- 选项:
change-password
:- 选项:
--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
:撤销对给定用户的强制密码更改
- 参数:
regenerate
:- 选项:
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
:应用程序名称。--provider
:OAuth2 提供者。--key
:客户端 ID(Key)。--secret
:客户端密钥 。--auto-discover-url
:OpenID Connect 自动发现 URL(仅在使用 OpenID Connect 作为提供程序时需要)。--use-custom-urls
:在 GitLab/GitHub OAuth 端点上使用自定义 URL。--custom-tenant-id
:在 OAuth 端点上使用自定义租户 ID。--custom-auth-url
:使用自定义授权 URL(GitLab/GitHub 的选项)。--custom-token-url
:使用自定义令牌 URL(GitLab/GitHub 的选项)。--custom-profile-url
:使用自定义配置文件 URL(GitLab/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
:应用程序名称。--provider
:OAuth2 提供者。--key
:客户端 ID(Key)。--secret
:客户端密钥。--auto-discover-url
:OpenID Connect 自动发现 URL(仅在使用 OpenID Connect 作为提供程序时需要)。--use-custom-urls
:在 GitLab/GitHub OAuth 端点上使用自定义 URL。--custom-tenant-id
:在 OAuth 端点上使用自定义租户 ID。--custom-auth-url
:使用自定义授权 URL(GitLab/GitHub 的选项)。--custom-token-url
:使用自定义令牌 URL(GitLab/GitHub 的选项)。--custom-profile-url
:使用自定义配置文件 URL(GitLab/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。--host
:SMTP 主机。必填。--port
:SMTP 端口。必填。--force-smtps
:SMTPS 始终在端口 465 上使用。设置此选项以强制在其他端口上使用 SMTPS。--skip-verify
:跳过 TLS 验证。--helo-hostname
:发送 HELO 时使用的主机名。留空以发送当前主机名。--disable-helo
:禁用 SMTP helo。--allowed-domains
:留空以允许所有域。使用逗号(',')分隔多个域。--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
值。
- 示例:
gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active
- 选项:
update-smtp
:- 选项:
--id
:要更新的源的 ID。必填。- 其他选项与
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 验证。--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 的密码(如果有)。--attributes-in-bind
:在绑定 DN 上下文中获取属性。--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 验证。--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 的密码(如果有)。--attributes-in-bind
- 选项: