diff --git a/docs/administration/config-cheat-sheet.md b/docs/administration/config-cheat-sheet.md index eecf8f13..dd64a9cc 100644 --- a/docs/administration/config-cheat-sheet.md +++ b/docs/administration/config-cheat-sheet.md @@ -977,7 +977,7 @@ Release attachment has its own config options in `[repository.release]` section. - `PATH`: **attachments**: Path to store attachments only available when STORAGE_TYPE is `local`, relative paths will be resolved to `{AppDataPath}/{attachment.PATH}`. - For `STORAGE_TYPE = minio`, the configurations can be found at [Storage Minio](#storage_minio), you can override some configurations like below. + For `STORAGE_TYPE = minio`, the configurations can be found at [Storage Minio](#minio-storage-configuration-storage_minio), you can override some configurations like below. - `MINIO_BASE_PATH`: **attachments/**: Minio base path on the bucket only available when STORAGE_TYPE is `minio` @@ -1496,7 +1496,7 @@ is `data/lfs` and the default of `MINIO_BASE_PATH` is `lfs/`. - `PATH`: **./data/lfs**: Where to store LFS files, only available when `STORAGE_TYPE` is `local`. If not set it fall back to deprecated LFS_CONTENT_PATH value in [server] section. - For `STORAGE_TYPE = minio`, the configurations can be found at [Storage Minio](#storage_minio), you can also define configurations like below to override derived or default values. + For `STORAGE_TYPE = minio`, the configurations can be found at [Storage Minio](#minio-storage-configuration-storage_minio), you can also define configurations like below to override derived or default values. - `MINIO_BASE_PATH`: **attachments/**: Minio base path on the bucket only available when STORAGE_TYPE is `minio` @@ -1647,7 +1647,7 @@ is `data/repo-archive` and the default of `MINIO_BASE_PATH` is `repo-archive/`. - `PATH`: **./data/repo-archive**: Where to store archive files, only available when `STORAGE_TYPE` is `local`. - For `STORAGE_TYPE = minio`, the configurations can be found at [Storage Minio](#storage_minio), you can override some configurations like below. + For `STORAGE_TYPE = minio`, the configurations can be found at [Storage Minio](#minio-storage-configuration-storage_minio), you can override some configurations like below. - `MINIO_BASE_PATH`: **repo-archive/**: Minio base path on the bucket only available when `STORAGE_TYPE` is `minio` diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current.json b/i18n/zh-tw/docusaurus-plugin-content-docs/current.json index bfe59f8a..308f90fa 100644 --- a/i18n/zh-tw/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current.json @@ -12,7 +12,7 @@ "message": "Actions" }, "sidebar.docs.category.packages": { - "message": "軟體包" + "message": "套件" }, "sidebar.docs.category.Development": { "message": "開發" diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md index e4c81127..ba5b65f0 100644 --- a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md @@ -13,19 +13,19 @@ aliases: ## 獲取頁面 -Gitea 源代碼附帶了示例頁面,位於 `contrib/legal` 目錄中。將它們複製到 `custom/public/assets/` 目錄下。例如,如果要添加隱私政策: +Gitea 源程式碼附帶了範例頁面,位於 `contrib/legal` 目錄中。將它們複製到 `custom/public/assets/` 目錄下。例如,如果要添加隱私政策: ``` wget -O /path/to/custom/public/assets/privacy.html https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/legal/privacy.html.sample ``` -現在,你需要編輯該頁面以滿足你的需求。特別是,你必須更改電子郵件地址、網址以及與 "Your Gitea Instance" 相關的引用,以匹配你的情況。 +現在,你需要編輯該頁面以滿足你的需求。特別是,你必須更改電子電子郵件地址、網址以及與 "Your Gitea Instance" 相關的引用,以匹配你的情況。 -請務必不要放置會暗示 Gitea 項目對你的服務器負責的一般服務條款或隱私聲明。 +請務必不要放置會暗示 Gitea 專案對你的伺服器負責的一般服務條款或隱私聲明。 ## 使其可見 -創建或追加到 `/path/to/custom/templates/custom/extra_links_footer.tmpl` 文件中: +建立或追加到 `/path/to/custom/templates/custom/extra_links_footer.tmpl` 文件中: ```go 隱私政策 diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/authentication.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/authentication.md index b82066d3..6d0bc854 100644 --- a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/authentication.md +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/authentication.md @@ -6,208 +6,208 @@ aliases: - /zh-tw/authentication --- -# 认证 +# 認證 -## 轻量级目录访问协议(Lightweight Directory Access Protocol,LDAP) +## 輕量級目錄訪問協議(Lightweight Directory Access Protocol,LDAP) -通过 BindDN 的 LDAP 和简单认证方式 LDAP 共享以下字段: +透過 BindDN 的 LDAP 和簡單認證方式 LDAP 共享以下欄位: -- 认证名称 **(必选)** +- 認證名稱 **(必選)** - - 分配给新授权方法的名称。 + - 分配給新授權方法的名稱。 -- 主机名 **(必选)** +- 主機名 **(必選)** - - LDAP 服务的主机地址. + - LDAP 服務的主機地址. - 例如:`mydomain.com` -- 端口号 **(必选)** +- 端口號 **(必選)** - - LDAP 服务的端口号. + - LDAP 服務的端口號. - 例如: LDAP `389`/ LDAPs `636` -- 安全协议 (可选) +- 安全協議 (可選) - - 连接 LDAP 服务器时是否使用 TLS 协议。 + - 連接 LDAP 伺服器時是否使用 TLS 協議。 -- 管理员过滤规则 (可选) +- 管理員過濾規則 (可選) - - 一个 LDAP 过滤器,用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件,则该用户将被授予管理员权限。 - - 示例:`(objectClass=adminAccount)` - - 适用于 Microsoft Active Directory(AD)的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` + - 一個 LDAP 過濾器,用於指定哪些使用者應該被賦予管理員特權。如果使用者帳戶符合過濾器條件,則該使用者將被授予管理員權限。 + - 範例:`(objectClass=adminAccount)` + - 適用於 Microsoft Active Directory(AD)的範例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` -- 用户名属性(可选) +- 使用者名稱屬性(可選) - - 用户 LDAP 记录中包含用户名称的属性。在第一次成功登录后,将使用指定的属性值作为新的 Gitea 账户用户名。若留空,则使用登录表单上提供的用户名。 - - 当提供的登录名与多个属性匹配时,这一选项非常有用,但是只有一个特定属性应该用于 Gitea 账户名称,请参阅"用户过滤器"。 - - 示例:uid - - 适用于 Microsoft Active Directory(AD)的示例:`sAMAccountName` + - 使用者 LDAP 記錄中包含使用者名稱稱的屬性。在第一次成功登入後,將使用指定的屬性值作為新的 Gitea 帳號名稱。若留空,則使用登入表單上提供的使用者名稱。 + - 當提供的登入名與多個屬性匹配時,這一選項非常有用,但是隻有一個特定屬性應該用於 Gitea 帳號名稱,請參閱"使用者過濾器"。 + - 範例:uid + - 適用於 Microsoft Active Directory(AD)的範例:`sAMAccountName` -- 名字属性(可选) +- 名字屬性(可選) - - 用户 LDAP 记录中包含用户名字的属性。将用于填充他们的账户信息。 - - 示例:givenName + - 使用者 LDAP 記錄中包含使用者名稱字的屬性。將用於填充他們的帳號資訊。 + - 範例:givenName -- 姓氏属性(可选) +- 姓氏屬性(可選) - - 用户 LDAP 记录中包含用户姓氏的属性。将用于填充他们的账户信息。 - - 示例:`sn` + - 使用者 LDAP 記錄中包含使用者姓氏的屬性。將用於填充他們的帳號資訊。 + - 範例:`sn` -- 电子邮件属性 **(必选)** - - 用户 LDAP 记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 - - 示例:`mail` +- 電子郵件屬性 **(必選)** + - 使用者 LDAP 記錄中包含使用者電子電子郵件地址的屬性。將用於填充他們的帳號資訊。 + - 範例:`mail` ### LDAP(via BindDN) -需要额外设置以下字段: +需要額外設定以下欄位: -- 绑定 DN (可选) +- 綁定 DN (可選) - - 搜索用户时绑定到 LDAP 服务器的 DN。这可以留空以执行匿名搜索。 - - 示例: `cn=Search,dc=mydomain,dc=com` + - 搜索使用者時綁定到 LDAP 伺服器的 DN。這可以留空以執行匿名搜索。 + - 範例: `cn=Search,dc=mydomain,dc=com` -- 绑定密码 (可选) +- 綁定密碼 (可選) - - 上述指定的 Bind DN(绑定区别名)的密码,如果有的话。注意:该密码在服务器上使用 SECRET_KEY 进行加密存储。仍然建议确保 Bind DN 具有尽可能少的权限。 + - 上述指定的 Bind DN(綁定區別名)的密碼,如果有的話。注意:該密碼在伺服器上使用 SECRET_KEY 進行加密儲存。仍然建議確保 Bind DN 具有儘可能少的權限。 -- 用户搜索基准 **(必选)** +- 使用者搜索基準 **(必選)** - - 这是用于搜索用户帐户的 LDAP 基础路径. - - 示例: `ou=Users,dc=mydomain,dc=com` + - 這是用於搜索使用者帳戶的 LDAP 基礎路徑. + - 範例: `ou=Users,dc=mydomain,dc=com` -- 用户过滤规则 **(必选)** - - LDAP 过滤器声明如何查找试图进行身份验证的用户记录 - `%[1]s`匹配参数将替换为登录表单中给出的登录名 - - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` - - 示例 for Microsoft Active Directory (AD): `(&(objectCategory=Person)(memberOf=CN=user-group,OU=example,DC=example,DC=org)(sAMAccountName=%s)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))` - - 如需多次替换,应使用 `%[1]s`,例如在将提供的登录名与多个属性(如用户标识符、电子邮件甚至电话号码)进行匹配时。 - - 示例: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` -- 启用用户同步 - - 这个选项启用了一个周期性任务,用于将 Gitea 用户与 LDAP 服务器进行同步。默认的同步周期是每 24 小时, - 但您可以在 app.ini 文件中进行更改。 - 有关此部分的详细说明,请参阅[sample +- 使用者過濾規則 **(必選)** + - LDAP 過濾器聲明如何查找試圖進行身份驗證的使用者記錄 + `%[1]s`匹配參數將替換為登入表單中給出的登入名 + - 範例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` + - 範例 for Microsoft Active Directory (AD): `(&(objectCategory=Person)(memberOf=CN=user-group,OU=example,DC=example,DC=org)(sAMAccountName=%s)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))` + - 如需多次替換,應使用 `%[1]s`,例如在將提供的登入名與多個屬性(如使用者標識符、電子郵件甚至電話號碼)進行匹配時。 + - 範例: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` +- 啟用使用者同步 + - 這個選項啟用了一個週期性任務,用於將 Gitea 使用者與 LDAP 伺服器進行同步。預設的同步週期是每 24 小時, + 但您可以在 app.ini 文件中進行更改。 + 有關此部分的詳細說明,請參閱[sample app.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) - 的*cron.sync_external_users* 部分的注释。前面提到的*User Search Base*和*User Filter* - 设置将限制哪些用户可以使用 Gitea 以及哪些用户将被同步。 - 在初始运行任务时,将根据给定的设置创建所有与 LDAP 匹配的用户,因此在使用大型企业 LDAP 目录时需要小心。 + 的*cron.sync_external_users* 部分的註釋。前面提到的*User Search Base*和*User Filter* + 設定將限制哪些使用者可以使用 Gitea 以及哪些使用者將被同步。 + 在初始運行任務時,將根據給定的設定建立所有與 LDAP 匹配的使用者,因此在使用大型企業 LDAP 目錄時需要小心。 ### LDAP(simple auth) -需要额外设置以下字段: +需要額外設定以下欄位: -- 用户 DN **(必选)** +- 使用者 DN **(必選)** - - 用作用户 DN 的模板。匹配参数 `%s` 将替换为登录表单中的登录名。 - - 示例: `cn=%s,ou=Users,dc=mydomain,dc=com` - - 示例: `uid=%s,ou=Users,dc=mydomain,dc=com` + - 用作使用者 DN 的模板。匹配參數 `%s` 將替換為登入表單中的登入名。 + - 範例: `cn=%s,ou=Users,dc=mydomain,dc=com` + - 範例: `uid=%s,ou=Users,dc=mydomain,dc=com` -- 用户搜索基准 (可选) +- 使用者搜索基準 (可選) - - 用户搜索基准声明哪些用户帐户将被搜索. - - 示例: `ou=Users,dc=mydomain,dc=com` + - 使用者搜索基準聲明哪些使用者帳戶將被搜索. + - 範例: `ou=Users,dc=mydomain,dc=com` -- 用户过滤规则 **(必选)** - - LDAP 过滤器声明何时允许用户登录 - `%[1]s`匹配参数将替换为登录表单中给出的登录名。 - - 示例: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))` - - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` +- 使用者過濾規則 **(必選)** + - LDAP 過濾器聲明何時允許使用者登入 + `%[1]s`匹配參數將替換為登入表單中給出的登入名。 + - 範例: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))` + - 範例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` -### 使用 LDAP 验证分组成员 +### 使用 LDAP 驗證分組成員 -使用以下字段: +使用以下欄位: -- 群组搜索基础 DN(可选) +- 群組搜索基礎 DN(可選) - - 组使用的 LDAP DN。 - - 示例: `ou=group,dc=mydomain,dc=com` + - 組使用的 LDAP DN。 + - 範例: `ou=group,dc=mydomain,dc=com` -- 组名过滤器 (可选) +- 組名過濾器 (可選) - - LDAP 过滤器,声明如何在上述 DN 中查找有效组。 - - 示例: `(|(cn=gitea_users)(cn=admins))` + - LDAP 過濾器,聲明如何在上述 DN 中查找有效組。 + - 範例: `(|(cn=gitea_users)(cn=admins))` -- 组中的用户属性 (可选) +- 組中的使用者屬性 (可選) - - 组中列出了哪个用户的 LDAP 属性。 - - 示例: `uid` + - 組中列出了哪個使用者的 LDAP 屬性。 + - 範例: `uid` -- 用户组属性 (可选) - - 哪个组的 LDAP 属性包含一个高于用户属性名称的数组。 - - 示例: `memberUid` +- 使用者組屬性 (可選) + - 哪個組的 LDAP 屬性包含一個高於使用者屬性名稱的數組。 + - 範例: `memberUid` -## 可插拔式认证模块(Pluggable Authentication Module,PAM) +## 可插拔式認證模組(Pluggable Authentication Module,PAM) -这个过程启用了 PAM(Pluggable Authentication Modules)认证。用户仍然可以通过用户管理手动添加到系统中。 -PAM 提供了一种机制,通过对用户进行 PAM 认证来自动将其添加到当前数据库中。为了与普通的 Linux 密码一起使用, -运行 Gitea 的用户还必须具有对`/etc/shadow`的读取权限,以便在使用公钥登录时检查账户的有效性。 +這個過程啟用了 PAM(Pluggable Authentication Modules)認證。使用者仍然可以透過使用者管理手動添加到系統中。 +PAM 提供了一種機制,通過對使用者進行 PAM 認證來自動將其添加到當前資料庫中。為了與普通的 Linux 密碼一起使用, +運行 Gitea 的使用者還必須具有對`/etc/shadow`的讀取權限,以便在使用公鑰登入時檢查帳號的有效性。 -**注意**:如果用户已将 SSH 公钥添加到 Gitea 中,使用这些密钥可能会绕过登录检查系统。因此, -如果您希望禁用使用 PAM 进行身份验证的用户,应该在 Gitea 中手动禁用该账户,使用内置的用户管理功能。 +**注意**:如果使用者已將 SSH 公鑰添加到 Gitea 中,使用這些密鑰可能會繞過登入檢查系統。因此, +如果您希望禁用使用 PAM 進行身份驗證的使用者,應該在 Gitea 中手動禁用該帳號,使用內置的使用者管理功能。 -1. 配置和安装准备. - - 建议您创建一个管理用户. - - 建议取消自动注册. -1. 一旦数据库已初始化完成,使用新创建的管理员账户登录. -1. 导航至用户设置(右上角的图标),然后选择 - `Site Administration` -> `Authentication Sources`, 并选择 +1. 設定和安裝準備. + - 建議您建立一個管理使用者. + - 建議取消自動註冊. +1. 一旦資料庫已初始化完成,使用新建立的管理員帳號登入. +1. 導航至使用者設定(右上角的圖標),然後選擇 + `Site Administration` -> `Authentication Sources`, 並選擇 `Add Authentication Source`. -1. 填写字段如下: - - 认证类型:`PAM`。 - - 名称:任何有效的值都可以,如果您愿意,可以使用"System Authentication"。 - - PAM 服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 - - PAM 电子邮件域:用户认证时要附加的电子邮件后缀。例如,如果登录系统期望一个名为 gituse 的用户, - 并且将此字段设置为 mail.com,那么 Gitea 在验证一个 GIT 实例的用户时将期望 user emai 字段为gituser@mail.com[^2]。 +1. 填寫欄位如下: + - 認證類型:`PAM`。 + - 名稱:任何有效的值都可以,如果您願意,可以使用"System Authentication"。 + - PAM 服務名稱:從/etc/pam.d/目錄下選擇適用於所需認證的正確文件[^1]。 + - PAM 電子郵件域:使用者認證時要附加的電子郵件後綴。例如,如果登入系統期望一個名為 gituse 的使用者, + 並且將此欄位設定為 mail.com,那麼 Gitea 在驗證一個 GIT 實例的使用者時將期望 user emai 欄位為gituser@mail.com[^2]。 -**Note**: PAM 支持通过[build-time flags](installation/from-source.md#build)添加, -而官方提供的二进制文件通常不会默认启用此功能。PAM 需要确保系统上有必要的 libpam 动态库,并且编译器可以访问必要的 PAM 开发头文件。 +**Note**: PAM 支援通過[build-time flags](installation/from-source.md)添加, +而官方提供的二進制文件通常不會預設啟用此功能。PAM 需要確保系統上有必要的 libpam 動態庫,並且編譯器可以訪問必要的 PAM 開發頭文件。 [^1]: - 例如,在 Debian "Bullseye"上使用标准 Linux 登录,可以使用`common-session-noninteractive`。这个值对于其他版本的 Debian, - 包括 Ubuntu 和 Mint,可能也是有效的,请查阅您所使用发行版的文档以确认。 + 例如,在 Debian "Bullseye"上使用標準 Linux 登入,可以使用`common-session-noninteractive`。這個值對於其他版本的 Debian, + 包括 Ubuntu 和 Mint,可能也是有效的,請查閱您所使用發行版的文件以確認。 -[^2]: **PAM 的必选项** 请注意:在上面的示例中,用户将作为`gituser`而不是`gituser@mail.com`登录到 Gitea 的 Web 界面。 +[^2]: **PAM 的必選項** 請注意:在上面的範例中,使用者將作為`gituser`而不是`gituser@mail.com`登入到 Gitea 的 Web 介面。 -## 简单邮件传输协议(Simple Mail Transfer Protocol,SMTP) +## 簡單郵件傳輸協議(Simple Mail Transfer Protocol,SMTP) -此选项允许 Gitea 以 Gitea 用户身份登录 SMTP 主机。请设置以下字段: +此選項允許 Gitea 以 Gitea 使用者身份登入 SMTP 主機。請設定以下欄位: -- 身份验证名称 **(必选)** +- 身份驗證名稱 **(必選)** - - 分配给新授权方法的名称 + - 分配給新授權方法的名稱 -- SMTP 验证类型 **(必选)** +- SMTP 驗證類型 **(必選)** - - 用于连接 SMTP 主机的验证类型,plain 或 login + - 用於連接 SMTP 主機的驗證類型,plain 或 login -- 主机名 **(必选)** +- 主機名 **(必選)** - - SMTP 服务的主机地址 + - SMTP 服務的主機地址 - 例如:`smtp.mydomain.com` -- 端口号 **(必选)** +- 端口號 **(必選)** - - SMTP 服务的端口号 + - SMTP 服務的端口號 - 例如: `587` -- 允许的域名 +- 允許的域名 - - 如果使用公共 SMTP 主机或有多个域的 SMTP 主机,限制哪些域可以登录 - 限制哪些域可以登录。 - - 示例: `gitea.com,mydomain.com,mydomain2.com` + - 如果使用公共 SMTP 主機或有多個域的 SMTP 主機,限制哪些域可以登入 + 限制哪些域可以登入。 + - 範例: `gitea.com,mydomain.com,mydomain2.com` -- 强制使用 SMTPS - - 默认情况下将使用 SMTPS 连接到端口 465.如果您希望将 smtp 用于其他端口,自行设置 - - 否则,如果服务器提供' STARTTLS '扩展名,则将使用此扩展名 -- 跳过 TLS 验证 - - 禁用 TLS 验证身份. -- 该认证源处于激活状态 - - 启用或禁用此身份验证源 +- 強制使用 SMTPS + - 預設情況下將使用 SMTPS 連接到端口 465.如果您希望將 smtp 用於其他端口,自行設定 + - 否則,如果伺服器提供' STARTTLS '擴展名,則將使用此擴展名 +- 跳過 TLS 驗證 + - 禁用 TLS 驗證身份. +- 該認證源處於激活狀態 + - 啟用或禁用此身份驗證源 ## FreeIPA -- 要使用 FreeIPA 凭据登录 Gitea,需要为 Gitea 创建一个绑定帐户。 - 创建一个绑定帐户: -- 在 FreeIPA 服务器上创建一个 gitea.ldif 文件,并将`dc=example,dc=com`替换为您的`dn`,然后提供一个适当安全的密码。 +- 要使用 FreeIPA 憑據登入 Gitea,需要為 Gitea 建立一個綁定帳戶。 + 建立一個綁定帳戶: +- 在 FreeIPA 伺服器上建立一個 gitea.ldif 文件,並將`dc=example,dc=com`替換為您的`dn`,然後提供一個適當安全的密碼。 ```sh dn: uid=gitea,cn=sysaccounts,cn=etc,dc=example,dc=com @@ -220,76 +220,76 @@ PAM 提供了一种机制,通过对用户进行 PAM 认证来自动将其添 nsIdleTimeout: 0 ``` -- 导入 LDIF 文件(如果需要,请将 localhost 更改为 IPA 服务器)。系统会提示您输入 Directory Manager 的密码。: +- 導入 LDIF 文件(如果需要,請將 localhost 更改為 IPA 伺服器)。系統會提示您輸入 Directory Manager 的密碼。: ```sh ldapmodify -h localhost -p 389 -x -D \ "cn=Directory Manager" -W -f gitea.ldif ``` -- 为`gitea_users`添加 IPA 组: +- 為`gitea_users`添加 IPA 組: ```sh ipa group-add --desc="Gitea Users" gitea_users ``` -- **提示**:对于 IPA 凭证错误,运行' kinit admin '并提供域管理帐户密码. -- 以管理员身份登录 Gitea,点击 Admin Panel 下的`Authentication`。然后单击`Add New Source`并填写详细信息,更改所有适当的地方。 +- **提示**:對於 IPA 憑證錯誤,運行' kinit admin '並提供域管理帳戶密碼. +- 以管理員身份登入 Gitea,點擊 Admin Panel 下的`Authentication`。然後單擊`Add New Source`並填寫詳細資訊,更改所有適當的地方。 ## SPNEGO with SSPI (Kerberos/NTLM, for Windows only) -Gitea 支持通过 Windows 内置的安全支持提供程序接口(Security Support Provider Interface,SSPI)实现 SPNEGO 单点登录认证(由 RFC4559 定义的方案),用于服务器的 Web 部分。SSPI 仅在 Windows 环境中工作,即当服务器和客户端都在 Windows 操作系统上运行时。 +Gitea 支援通過 Windows 內置的安全支援提供程式介面(Security Support Provider Interface,SSPI)實現 SPNEGO 單點登入認證(由 RFC4559 定義的方案),用於伺服器的 Web 部分。SSPI 僅在 Windows 環境中工作,即當伺服器和客戶端都在 Windows 操作系統上運行時。 -在激活 SSPI 单点登录认证(SSO)之前,您需要准备您的环境: +在激活 SSPI 單點登入認證(SSO)之前,您需要準備您的環境: -- 在 Active Directory 中创建一个单独的用户账户,gitea.exe 进程将在该账户下运行(例如,在 domain.local 域下创建一个名为 user 的账户: -- 为运行 gitea.exe 的主机创建一个服务主体名称(Service Principal Name,SPN),其类别为 HTTP: +- 在 Active Directory 中建立一個單獨的使用者帳號,gitea.exe 進程將在該帳號下運行(例如,在 domain.local 域下建立一個名為 user 的帳號: +- 為運行 gitea.exe 的主機建立一個服務主體名稱(Service Principal Name,SPN),其類別為 HTTP: - - 以特权域用户(例如域管理员)的身份启动“命令提示符”或“PowerShell”。 - - 运行下面的命令,将 host.domain.local 替换为 Web 应用程序将运行的服务器的完全限定域名(FQDN),将 domain\user 替换为在前一步中创建的账户名称: + - 以特權域使用者(例如域管理員)的身份啟動“命令提示符”或“PowerShell”。 + - 運行下面的命令,將 host.domain.local 替換為 Web 應用程式將運行的伺服器的完全限定域名(FQDN),將 domain\user 替換為在前一步中建立的帳號名稱: ```sh setspn -A HTTP/host.domain.local domain\user ``` -在遵循上述步骤之前,请确保您按照以下流程进行操作: +在遵循上述步驟之前,請確保您按照以下流程進行操作: -1. 用之前创建的用户登录(如果已经登录,请先注销)。 -2. 确保在`custom/conf/app.ini`文件的`[server]`部分中,`ROOT_URL`设置为 Web 应用程序将运行的服务器的完全限定域名(FQDN),与之前创建服务主体名称时使用的一致(例如,`host.domain.local`)。 -3. 启动 Web 服务器(运行 `gitea.exe web`)。 -4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源,以启用 SSPI 认证。 -5. 在域中的客户端计算机上,使用任何域用户登录(与运行`gitea.exe`的服务器不同)。 -6. 如果您使用 Chrome 或 Edge 浏览器,请将 Web 应用程序的 URL 添加到“本地站点”(`Internet选项 -> 安全 -> 本地站点 -> 站点`)。 -7. 启动 Chrome 或 Edge 浏览器,导航到 Gitea 的 FQDN URL(例如,`http://host.domain.local:3000`)。 -8. 在控制面板中点击“Sign In”按钮,然后选择 SSPI,将会自动使用当前登录到计算机的用户进行登录。 -9. 如果无法正常工作,请确保: - - 您不是在运行`gitea.exe`的同一台服务器上运行 Web 浏览器。应该在与服务器不同的域加入计算机(客户端)上运行 Web 浏览器。如果客户端和服务器都在同一台计算机上运行,则 NTLM 将优先于 Kerberos。 - - 主机上只有一个`HTTP/...`的 SPN。 - - SPN 中只包含主机名,不包含端口号。 - - 将 Web 应用程序的 URL 添加到"本地站点"。 - - 服务器和客户端的时钟差异不超过 5 分钟(取决于组策略)。 - - 在 Internet Explorer 中启用了"集成 Windows 身份验证"(在"高级设置"下)。 +1. 用之前建立的使用者登入(如果已經登入,請先註銷)。 +2. 確保在`custom/conf/app.ini`文件的`[server]`部分中,`ROOT_URL`設定為 Web 應用程式將運行的伺服器的完全限定域名(FQDN),與之前建立服務主體名稱時使用的一致(例如,`host.domain.local`)。 +3. 啟動 Web 伺服器(運行 `gitea.exe web`)。 +4. 在 `Site Administration -> Authentication Sources` 中添加一個 `SPNEGO with SSPI` 認證源,以啟用 SSPI 認證。 +5. 在域中的客戶端計算機上,使用任何域使用者登入(與運行`gitea.exe`的伺服器不同)。 +6. 如果您使用 Chrome 或 Edge 瀏覽器,請將 Web 應用程式的 URL 添加到“本地站點”(`Internet選項 -> 安全 -> 本地站點 -> 站點`)。 +7. 啟動 Chrome 或 Edge 瀏覽器,導航到 Gitea 的 FQDN URL(例如,`http://host.domain.local:3000`)。 +8. 在控制面板中點擊“Sign In”按鈕,然後選擇 SSPI,將會自動使用當前登入到計算機的使用者進行登入。 +9. 如果無法正常工作,請確保: + - 您不是在運行`gitea.exe`的同一臺伺服器上運行 Web 瀏覽器。應該在與伺服器不同的域加入計算機(客戶端)上運行 Web 瀏覽器。如果客戶端和伺服器都在同一臺計算機上運行,則 NTLM 將優先於 Kerberos。 + - 主機上只有一個`HTTP/...`的 SPN。 + - SPN 中只包含主機名,不包含端口號。 + - 將 Web 應用程式的 URL 添加到"本地站點"。 + - 伺服器和客戶端的時鐘差異不超過 5 分鐘(取決於組策略)。 + - 在 Internet Explorer 中啟用了"整合 Windows 身份驗證"(在"高級設定"下)。 -遵循这些步骤,您应该能够成功启用和使用 SSPI 单点登录认证(SSO)。 +遵循這些步驟,您應該能夠成功啟用和使用 SSPI 單點登入認證(SSO)。 -## 反向代理认证 +## 反向代理認證 -Gitea 支持通过读取反向代理传递的 HTTP 头中的登录名或者 email 地址来支持反向代理来认证。默认是不启用的,你可以用以下配置启用。 +Gitea 支援通過讀取反向代理傳遞的 HTTP 頭中的登入名或者 email 地址來支援反向代理來認證。預設是不啟用的,你可以用以下設定啟用。 ```ini [service] ENABLE_REVERSE_PROXY_AUTHENTICATION = true ``` -默认的登录用户名的 HTTP 头是 `X-WEBAUTH-USER`,你可以通过修改 `REVERSE_PROXY_AUTHENTICATION_USER` 来变更它。如果用户不存在,可以自动创建用户,当然你需要修改 `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true` 来启用它。 +預設的登入使用者名稱的 HTTP 頭是 `X-WEBAUTH-USER`,你可以透過修改 `REVERSE_PROXY_AUTHENTICATION_USER` 來變更它。如果使用者不存在,可以自動建立使用者,當然你需要修改 `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true` 來啟用它。 -默认的登录用户 Email 的 HTTP 头是 `X-WEBAUTH-EMAIL`,你可以通过修改 `REVERSE_PROXY_AUTHENTICATION_EMAIL` 来变更它。如果用户不存在,可以自动创建用户,当然你需要修改 `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true` 来启用它。你也可以通过修改 `ENABLE_REVERSE_PROXY_EMAIL` 来启用或停用这个 HTTP 头。 +預設的登入使用者 Email 的 HTTP 頭是 `X-WEBAUTH-EMAIL`,你可以透過修改 `REVERSE_PROXY_AUTHENTICATION_EMAIL` 來變更它。如果使用者不存在,可以自動建立使用者,當然你需要修改 `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true` 來啟用它。你也可以透過修改 `ENABLE_REVERSE_PROXY_EMAIL` 來啟用或停用這個 HTTP 頭。 -如果设置了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`,则用户的全名会从 `X-WEBAUTH-FULLNAME` 读取,这样在自动创建用户时将使用这个字段作为用户全名,你也可以通过修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 来变更 HTTP 头。 +如果設定了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`,則使用者的全名會從 `X-WEBAUTH-FULLNAME` 讀取,這樣在自動建立使用者時將使用這個欄位作為使用者全名,你也可以透過修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 來變更 HTTP 頭。 -你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的 IP 地址范围,加强安全性,默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`, 可以设置最多信任几级反向代理。 +你也可以透過修改 `REVERSE_PROXY_TRUSTED_PROXIES` 來設定反向代理的 IP 地址範圍,加強安全性,預設值是 `127.0.0.0/8,::1/128`。 通過 `REVERSE_PROXY_LIMIT`, 可以設定最多信任幾級反向代理。 -你可以通过以下配置为 API 启用此认证方法: +你可以透過以下設定為 API 啟用此認證方法: ```ini [service] @@ -297,5 +297,5 @@ ENABLE_REVERSE_PROXY_AUTHENTICATION_API = true ``` :::note -当此方法用于 API 时,反向代理负责处理 CSRF 保护。 +當此方法用於 API 時,反向代理負責處理 CSRF 保護。 ::: diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md index 6fd97126..3e623146 100644 --- a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md @@ -7,19 +7,19 @@ aliases: - /zh-tw/backup-and-restore --- -# 备份与恢复 +# 備份與恢復 -Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个 zip 压缩文件。该压缩文件可以被用来进行数据恢复。 +Gitea 已經實現了 `dump` 命令可以用來備份所有需要的文件到一個 zip 壓縮文件。該壓縮文件可以被用來進行資料恢復。 -## 备份一致性 +## 備份一致性 -为了确保 Gitea 实例的一致性,在备份期间必须关闭它。 +為了確保 Gitea 實例的一致性,在備份期間必須關閉它。 -Gitea 包括数据库、文件和 Git 仓库,当它被使用时所有这些都会发生变化。例如,当迁移正在进行时,在数据库中创建一个事务,而 Git 仓库正在被复制。如果备份发生在迁移的中间,Git 仓库可能是不完整的,尽管数据库声称它是完整的,因为它是在之后被转储的。避免这种竞争条件的唯一方法是在备份期间停止 Gitea 实例。 +Gitea 包括資料庫、文件和 Git 儲存庫,當它被使用時所有這些都會發生變化。例如,當遷移正在進行時,在資料庫中建立一個事務,而 Git 儲存庫正在被複制。如果備份發生在遷移的中間,Git 儲存庫可能是不完整的,儘管資料庫聲稱它是完整的,因為它是在之後被轉儲的。避免這種競爭條件的唯一方法是在備份期間停止 Gitea 實例。 -## 备份命令 (`dump`) +## 備份命令 (`dump`) -先转到 git 用户的权限: `su git`. 再 Gitea 目录运行 `./gitea dump`。一般会显示类似如下的输出: +先轉到 git 使用者的權限: `su git`. 再 Gitea 目錄運行 `./gitea dump`。一般會顯示類似如下的輸出: ``` 2016/12/27 22:32:09 Creating tmp work dir: /tmp/gitea-dump-417443001 @@ -30,20 +30,20 @@ Gitea 包括数据库、文件和 Git 仓库,当它被使用时所有这些都 2016/12/27 22:32:34 Finish dumping in file gitea-dump-1482906742.zip ``` -最后生成的 `gitea-dump-1482906742.zip` 文件将会包含如下内容: +最後生成的 `gitea-dump-1482906742.zip` 文件將會包含如下內容: -- `app.ini` - 如果原先存储在默认的 custom/ 目录之外,则是配置文件的可选副本 -- `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 -- `data/` - 数据目录(APP_DATA_PATH),如果使用文件会话,则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 -- `repos/` - 仓库目录的完整副本。 -- `gitea-db.sql` - 数据库 dump 出来的 SQL。 -- `log/` - Logs 文件,如果用作迁移不是必须的。 +- `app.ini` - 如果原先儲存在預設的 custom/ 目錄之外,則是設定文件的可選副本 +- `custom/` - 所有保存在 `custom/` 目錄下的設定和自訂的文件。 +- `data/` - 資料目錄(APP_DATA_PATH),如果使用文件會話,則不包括會話。該目錄包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 則包括 SQLite 文件。 +- `repos/` - 儲存庫目錄的完整副本。 +- `gitea-db.sql` - 資料庫 dump 出來的 SQL。 +- `log/` - Logs 文件,如果用作遷移不是必須的。 -中间备份文件将会在临时目录进行创建,如果您要重新指定临时目录,可以用 `--tempdir` 参数,或者用 `TMPDIR` 环境变量。 +中間備份文件將會在臨時目錄進行建立,如果您要重新指定臨時目錄,可以用 `--tempdir` 參數,或者用 `TMPDIR` 環境變量。 -## 备份数据库 +## 備份資料庫 -`gitea dump` 创建的 SQL 转储使用 XORM,Gitea 管理员可能更喜欢使用本地的 MySQL 和 PostgreSQL 转储工具。使用 XORM 转储数据库时仍然存在一些问题,可能会导致在尝试恢复时出现问题。 +`gitea dump` 建立的 SQL 轉儲使用 XORM,Gitea 管理員可能更喜歡使用本地的 MySQL 和 PostgreSQL 轉儲工具。使用 XORM 轉儲資料庫時仍然存在一些問題,可能會導致在嘗試恢復時出現問題。 ```sh # mysql @@ -54,23 +54,23 @@ pg_dump -U $USER $DATABASE > gitea-db.sql ### 使用 Docker (`dump`) -在使用 Docker 时,使用 `dump` 命令有一些注意事项。 +在使用 Docker 時,使用 `dump` 命令有一些注意事項。 -必须以 `gitea/conf/app.ini` 中指定的 `RUN_USER = ` 执行该命令;并且,为了让备份文件夹的压缩过程能够顺利执行,`docker exec` 命令必须在 `--tempdir` 内部执行。 +必須以 `gitea/conf/app.ini` 中指定的 `RUN_USER = ` 執行該命令;並且,為了讓備份文件夾的壓縮過程能夠順利執行,`docker exec` 命令必須在 `--tempdir` 內部執行。 -示例: +範例: ```none docker exec -u -it -w <--tempdir> $(docker ps -qf 'name=^$') bash -c '/usr/local/bin/gitea dump -c ' ``` -\*注意:`--tempdir` 指的是 Gitea 使用的 Docker 环境的临时目录;如果您没有指定自定义的 `--tempdir`,那么 Gitea 将使用 `/tmp` 或 Docker 容器的 `TMPDIR` 环境变量。对于 `--tempdir`,请相应调整您的 `docker exec` 命令选项。 +\*注意:`--tempdir` 指的是 Gitea 使用的 Docker 環境的臨時目錄;如果您沒有指定自訂的 `--tempdir`,那麼 Gitea 將使用 `/tmp` 或 Docker 容器的 `TMPDIR` 環境變量。對於 `--tempdir`,請相應調整您的 `docker exec` 命令選項。 -结果应该是一个文件,存储在指定的 `--tempdir` 中,类似于:`gitea-dump-1482906742.zip` +結果應該是一個文件,儲存在指定的 `--tempdir` 中,類似於:`gitea-dump-1482906742.zip` -## 恢复命令 (`restore`) +## 恢復命令 (`restore`) -当前还没有恢复命令,恢复需要人工进行。主要是把文件和数据库进行恢复。 +當前還沒有恢復命令,恢復需要人工進行。主要是把文件和資料庫進行恢復。 例如: @@ -93,54 +93,54 @@ psql -U $USER -d $DATABASE < gitea-db.sql service gitea restart ``` -如果安装方式发生了变化(例如 二进制 -> Docker),或者 Gitea 安装到了与之前安装不同的目录,则需要重新生成仓库 Git 钩子。 +如果安裝方式發生了變化(例如 二進制 -> Docker),或者 Gitea 安裝到了與之前安裝不同的目錄,則需要重新生成儲存庫 Git 鉤子。 -在 Gitea 运行时,并从 Gitea 二进制文件所在的目录执行:`./gitea admin regenerate hooks` +在 Gitea 運行時,並從 Gitea 二進制文件所在的目錄執行:`./gitea admin regenerate hooks` -这样可以确保仓库 Git 钩子中的应用程序和配置文件路径与当前安装一致。如果这些路径没有更新,仓库的 `push` 操作将失败。 +這樣可以確保儲存庫 Git 鉤子中的應用程式和設定文件路徑與當前安裝一致。如果這些路徑沒有更新,儲存庫的 `push` 操作將失敗。 ### 使用 Docker (`restore`) -在基于 Docker 的 Gitea 实例中,也没有恢复命令的支持。恢复过程与前面描述的步骤相同,但路径不同。 +在基於 Docker 的 Gitea 實例中,也沒有恢復命令的支援。恢復過程與前面描述的步驟相同,但路徑不同。 -示例: +範例: ```sh -# 在容器中打开 bash 会话 +# 在容器中打開 bash 會話 docker exec --user git -it 2a83b293548e bash -# 在容器内解压您的备份文件 +# 在容器內解壓您的備份文件 unzip gitea-dump-1610949662.zip cd gitea-dump-1610949662 -# 恢复 Gitea 数据 +# 恢復 Gitea 數據 mv data/* /data/gitea -# 恢复仓库本身 +# 恢復倉庫本身 mv repos/* /data/git/repositories/ -# 调整文件权限 +# 調整文件權限 chown -R git:git /data -# 重新生成 Git 钩子 +# 重新生成 Git 鉤子 /usr/local/bin/gitea -c '/data/gitea/conf/app.ini' admin regenerate hooks ``` -Gitea 容器中的默认用户是 `git`(1000:1000)。请用您的 Gitea 容器 ID 或名称替换 `2a83b293548e`。 +Gitea 容器中的預設使用者是 `git`(1000:1000)。請用您的 Gitea 容器 ID 或名稱替換 `2a83b293548e`。 ### 使用 Docker-rootless (`restore`) -在 Docker-rootless 容器中的恢复工作流程只是要使用的目录不同: +在 Docker-rootless 容器中的恢復工作流程只是要使用的目錄不同: ```sh -# 在容器中打开 bash 会话 +# 在容器中打開 bash 會話 docker exec --user git -it 2a83b293548e bash -# 在容器内解压您的备份文件 +# 在容器內解壓您的備份文件 unzip gitea-dump-1610949662.zip cd gitea-dump-1610949662 -# 恢复 app.ini +# 恢復 app.ini mv data/conf/app.ini /etc/gitea/app.ini -# 恢复 Gitea 数据 +# 恢復 Gitea 數據 mv data/* /var/lib/gitea -# 恢复仓库本身 +# 恢復倉庫本身 mv repos/* /var/lib/gitea/git/repositories -# 调整文件权限 +# 調整文件權限 chown -R git:git /etc/gitea/app.ini /var/lib/gitea -# 重新生成 Git 钩子 +# 重新生成 Git 鉤子 /usr/local/bin/gitea -c '/etc/gitea/app.ini' admin regenerate hooks ``` diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md index ba2adb21..b721daab 100644 --- a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md @@ -7,37 +7,37 @@ aliases: - /zh-tw/cmd-embedded --- -# 嵌入资源提取工具 +# 嵌入資源提取工具 -Gitea 的可执行文件包含了运行所需的所有资源:模板、图片、样式表和翻译文件。你可以通过在 `custom` 目录下的相应路径中放置替换文件来覆盖其中的任何资源(详见 [自定义 Gitea 配置](../administration/customizing-gitea.md))。 +Gitea 的可執行文件包含了運行所需的所有資源:模板、圖片、樣式表和翻譯文件。你可以透過在 `custom` 目錄下的相應路徑中放置替換文件來覆蓋其中的任何資源(詳見 [自訂 Gitea 設定](../administration/customizing-gitea.md))。 -要获取嵌入资源的副本以进行编辑,可以使用 CLI 中的 `embedded` 命令,通过操作系统的 shell 执行。 +要獲取嵌入資源的副本以進行編輯,可以使用 CLI 中的 `embedded` 命令,通過操作系統的 shell 執行。 -**注意:** 嵌入资源提取工具包含在 Gitea 1.12 及以上版本中。 +**注意:** 嵌入資源提取工具包含在 Gitea 1.12 及以上版本中。 -## 资源列表 +## 資源列表 -要列出嵌入在 Gitea 可执行文件中的资源,请使用以下语法: +要列出嵌入在 Gitea 可執行文件中的資源,請使用以下語法: ```sh gitea embedded list [--include-vendored] [patterns...] ``` -`--include-vendored` 标志使命令包括被供应的文件,这些文件通常被排除在外;即来自外部库的文件,这些文件是 Gitea 所需的(例如 [octicons](https://octicons.github.com/) 等)。 +`--include-vendored` 標誌使命令包括被供應的文件,這些文件通常被排除在外;即來自外部庫的文件,這些文件是 Gitea 所需的(例如 [octicons](https://octicons.github.com/) 等)。 -可以提供一系列文件搜索模式。Gitea 使用 [gobwas/glob](https://github.com/gobwas/glob) 作为其 glob 语法。以下是一些示例: +可以提供一系列文件搜索模式。Gitea 使用 [gobwas/glob](https://github.com/gobwas/glob) 作為其 glob 語法。以下是一些範例: -- 列出所有模板文件,无论在哪个虚拟目录下:`**.tmpl` -- 列出所有邮件模板文件:`templates/mail/**.tmpl` - 列出 `public/assets/img` 目录下的所有文件:`public/assets/img/**` +- 列出所有模板文件,無論在哪個虛擬目錄下:`**.tmpl` +- 列出所有郵件模板文件:`templates/mail/**.tmpl` + 列出 `public/assets/img` 目錄下的所有文件:`public/assets/img/**` -不要忘记为模式使用引号,因为空格、`*` 和其他字符可能对命令行解释器有特殊含义。 +不要忘記為模式使用引號,因為空格、`*` 和其他字符可能對命令行解釋器有特殊含義。 -如果未提供模式,则列出所有文件。 +如果未提供模式,則列出所有文件。 -### 示例:列出所有嵌入文件 +### 範例:列出所有嵌入文件 -列出所有路径中包含 `openid` 的嵌入文件: +列出所有路徑中包含 `openid` 的嵌入文件: ```sh $ gitea embedded list '**openid**' @@ -51,33 +51,33 @@ templates/user/auth/signup_openid_register.tmpl templates/user/settings/security_openid.tmpl ``` -## 提取资源 +## 提取資源 -要提取嵌入在 Gitea 可执行文件中的资源,请使用以下语法: +要提取嵌入在 Gitea 可執行文件中的資源,請使用以下語法: ```sh gitea [--config {file}] embedded extract [--destination {dir}|--custom] [--overwrite|--rename] [--include-vendored] {patterns...} ``` -`--config` 选项用于告知 Gitea `app.ini` 配置文件的位置(如果不在默认位置)。此选项仅在使用 `--custom` 标志时使用。 +`--config` 選項用於告知 Gitea `app.ini` 設定文件的位置(如果不在預設位置)。此選項僅在使用 `--custom` 標誌時使用。 -`--destination` 选项用于指定提取文件的目标目录。默认为当前目录。 +`--destination` 選項用於指定提取文件的目標目錄。預設為當前目錄。 -`--custom` 标志告知 Gitea 直接将文件提取到 `custom` 目录中。为使其正常工作,该命令需要知道 `app.ini` 配置文件的位置(通过 `--config` 指定),并且根据配置的不同,需要从 Gitea 通常启动的目录运行。有关详细信息,请参阅 [自定义 Gitea 配置](../administration/customizing-gitea.md)。 +`--custom` 標誌告知 Gitea 直接將文件提取到 `custom` 目錄中。為使其正常工作,該命令需要知道 `app.ini` 設定文件的位置(通過 `--config` 指定),並且根據設定的不同,需要從 Gitea 通常啟動的目錄運行。有關詳細資訊,請參閱 [自訂 Gitea 設定](../administration/customizing-gitea.md)。 -`--overwrite` 标志允许覆盖目标目录中的任何现有文件。 +`--overwrite` 標誌允許覆蓋目標目錄中的任何現有文件。 -`--rename` 标志告知 Gitea 将目标目录中的任何现有文件重命名为 `filename.bak`。之前的 `.bak` 文件将被覆盖。 +`--rename` 標誌告知 Gitea 將目標目錄中的任何現有文件重命名為 `filename.bak`。之前的 `.bak` 文件將被覆蓋。 -至少需要提供一个文件搜索模式;有关模式的语法和示例,请参阅上述 `list` 子命令。 +至少需要提供一個文件搜索模式;有關模式的語法和範例,請參閱上述 `list` 子命令。 ### 重要提示 -请确保**只提取需要自定义的文件**。位于 `custom` 目录中的文件不会受到 Gitea 的升级过程的影响。当 Gitea 升级到新版本(通过替换可执行文件)时,许多嵌入文件将发生变化。Gitea 将尊重并使用在 `custom` 目录中找到的任何文件,即使这些文件是旧的和不兼容的。 +請確保**只提取需要自訂的文件**。位於 `custom` 目錄中的文件不會受到 Gitea 的升級過程的影響。當 Gitea 升級到新版本(通過替換可執行文件)時,許多嵌入文件將發生變化。Gitea 將尊重並使用在 `custom` 目錄中找到的任何文件,即使這些文件是舊的和不相容的。 -### 示例:提取邮件模板 +### 範例:提取郵件模板 -将邮件模板提取到临时目录: +將郵件模板提取到臨時目錄: ```sh $ mkdir tempdir diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/command-line.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/command-line.md index e3dbddd4..eccfcc5d 100644 --- a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/command-line.md +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/command-line.md @@ -11,523 +11,523 @@ 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 也可以在构建时更改(如果需要)。 +注意:預設的 custom-path、config 和 work-path 也可以在構建時更改(如果需要)。 ## 命令 ### web -启动服务器: +啟動伺服器: -- 选项: - - `--port number`,`-p number`:端口号。可选。 (默认值:3000)。覆盖配置文件中的设置。 - - `--install-port number`:运行安装页面的端口号。可选。 (默认值:3000)。覆盖配置文件中的设置。 - - `--pid path`,`-P path`:Pid 文件的路径。可选。 - - `--quiet`,`-q`:只在控制台上输出 Fatal 日志,用于在设置日志之前发出的日志。 - - `--verbose`:在控制台上输出跟踪日志,用于在设置日志之前发出的日志。 -- 示例: +- 選項: + - `--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 命令:`sudo setcap 'cap_net_bind_service=+ep' /path/to/gitea`。每次更新 Gitea 都需要重新執行此操作。 ### admin -管理员操作: +管理員操作: - 命令: - `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`:密码。必填。 - - `--email value`:邮箱。必填。 - - `--admin`:如果提供此选项,将创建一个管理员用户。可选。 - - `--access-token`:如果提供,将为用户创建访问令牌。可选。(默认值:false)。 - - `--must-change-password`:如果提供,创建的用户将在初始登录后需要选择一个新密码。可选。(默认值:true)。 - - `--random-password`:如果提供,将使用随机生成的密码作为创建用户的密码。`--password` 的值将被忽略。可选。 - - `--random-password-length`:如果提供,将用于配置随机生成密码的长度。可选。(默认值:12) - - 示例: + - 選項: + - `--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`:新密码。必填。 - - 示例: + - 選項: + - `--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。必填。 - - 示例: + - 選項: + - `--id`:要刪除的源的 ID。必填。 + - 範例: - `gitea admin auth delete --id 1` - `add-oauth`: - - 选项: - - `--name`:应用程序名称。 + - 選項: + - `--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`:根据组自动激活团队成员资格的删除。(可选) - - 示例: + - `--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`:应用程序名称。 + - `--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`:受限用户的组声明值。(可选) - - 示例: + - `--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 主机。必填。 + - 選項: + - `--name`:應用程式名稱。必填。 + - `--auth-type`:SMTP 認證類型(PLAIN/LOGIN/CRAM-MD5)。預設為 PLAIN。 + - `--host`:SMTP 主機。必填。 - `--port`:SMTP 端口。必填。 - - `--force-smtps`:SMTPS 始终在端口 465 上使用。设置此选项以强制在其他端口上使用 SMTPS。 - - `--skip-verify`:跳过 TLS 验证。 - - `--helo-hostname`:发送 HELO 时使用的主机名。留空以发送当前主机名。 + - `--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` 值。 - - 示例: + - `--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` 共享 - - 示例: + - 其他選項與 `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`:搜索页面大小。 - - 示例: + - `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`:在绑定 DN 上下文中获取属性。 - - `--synchronize-users`:启用用户同步。 - - `--page-size value`:搜索页面大小。 - - 示例: + - `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`:在綁定 DN 上下文中獲取屬性。 + - `--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 验证。 - - `--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。必填。 - - 示例: + - `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。必填。 + - 範例: - `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 验证。 - - `--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。 - - 示例: + - `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。 + - 範例: - `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`:如果提供此选项,则证书将生成自己的证书颁发机构。可选。 -- 示例: +- 選項: + - `--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`:如果提供此選項,則證書將生成自己的證書頒發機構。可選。 +- 範例: - `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 是此选项的别名,用于向后兼容)。 - - `SECRET_KEY`: 全局密钥。 - - 示例: + - 選項: + - `INTERNAL_TOKEN`: 用於內部 API 調用身份驗證的令牌。 + - `JWT_SECRET`: 用於 LFS 和 OAUTH2 JWT 身份驗證的密鑰(LFS_JWT_SECRET 是此選項的別名,用於向後相容)。 + - `SECRET_KEY`: 全域密鑰。 + - 範例: - `gitea generate secret INTERNAL_TOKEN` - `gitea generate secret JWT_SECRET` - `gitea generate secret SECRET_KEY` ### 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` - 列出所有可用的检查 -- `gitea doctor check --all` - 运行所有可用的检查 -- `gitea doctor check --default` - 运行默认的检查 -- `gitea doctor check --run [check(s),]...` - 运行指定的名字的检查 +- `gitea doctor check --list` - 列出所有可用的檢查 +- `gitea doctor check --all` - 運行所有可用的檢查 +- `gitea doctor check --default` - 運行預設的檢查 +- `gitea doctor check --run [check(s),]...` - 運行指定的名字的檢查 -有些问题可以通过设置 `--fix` 选项进行自动修复。 -额外的日志可以通过 `--log-file=...` 进行设置。 +有些問題可以透過設定 `--fix` 選項進行自動修復。 +額外的日誌可以透過 `--log-file=...` 進行設定。 #### doctor recreate-table -有时,在迁移时,旧的列和默认值可能会在数据库模式中保持不变。这可能会导致警告,如下所示: +有時,在遷移時,舊的列和預設值可能會在資料庫模式中保持不變。這可能會導致警告,如下所示: ``` 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 ``` -强烈建议在运行这些命令之前备份您的数据库。 +強烈建議在運行這些命令之前備份您的資料庫。 ### 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,以在返回之前不等待刷新完成 - - `logging`: 调整日志命令 + - `shutdown`: 優雅地關閉運行中的進程 + - `restart`: 優雅地重新啟動運行中的進程(對於 Windows 伺服器尚未實現) + - `flush-queues`: 刷新運行中的進程中的隊列 + - 選項: + - `--timeout value`: 刷新過程的超時時間(預設值: 1m0s) + - `--non-blocking`: 設定為 true,以在返回之前不等待刷新完成 + - `logging`: 調整日誌命令 - 命令: - - `pause`: 暂停日志记录 + - `pause`: 暫停日誌記錄 - 注意: - - 如果日志级别低于此级别,日志级别将被临时提升为 INFO。 - - Gitea 将在一定程度上缓冲日志,并在超过该点后丢弃日志。 - - `resume`: 恢复日志记录 - - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接(相当于向 Gitea 发送 SIGUSR1 信号)。 - - `remove name`: 删除指定的日志记录器 - - 选项: - - `--group group`, `-g group`: 从中删除子记录器的组(默认为`default`) - - `add`: 添加日志记录器 + - 如果日誌級別低於此級別,日誌級別將被臨時提升為 INFO。 + - Gitea 將在一定程度上緩衝日誌,並在超過該點後丟棄日誌。 + - `resume`: 恢復日誌記錄 + - `release-and-reopen`: 使 Gitea 釋放和重新打開用於日誌記錄的文件和連接(相當於向 Gitea 發送 SIGUSR1 信號)。 + - `remove name`: 刪除指定的日誌記錄器 + - 選項: + - `--group group`, `-g group`: 從中刪除子記錄器的組(預設為`default`) + - `add`: 添加日誌記錄器 - 命令: - - `console`: 添加控制台日志记录器 - - 选项: - - `--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 - 仅适用于控制台 - - `file`: 添加文件日志记录器 - - 选项: - - `--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`: 在日志中使用颜色 - - `--filename value`, `-f value`: 日志记录器的文件名 - - `--rotate`, `-r`: 轮转日志 - - `--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`: 新日志记录器的名称 - 默认为模式 - - `--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`, `-r`: 连接中断时重新连接主机 - - `--protocol value`, `-P value`: 设置要使用的协议:tcp、unix 或 udp(默认为 tcp) - - `--address value`, `-a value`: 要连接到的主机地址和端口(默认为:7020) - - `smtp`: 添加 SMTP 日志记录器 - - 选项: - - `--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) - - `--send-to value`, `-s value`: 要发送到的电子邮件地址 - - `--subject value`, `-S value`: 发送电子邮件的主题标题 - - `processes`: 显示 Gitea 进程和 Goroutine 信息 - - 选项: - - `--flat`: 以平面表格形式显示进程,而不是树形结构 - - `--no-system`: 不显示系统进程 - - `--stacktraces`: 显示与进程关联的 Goroutine 的堆栈跟踪 - - `--json`: 输出为 JSON 格式 - - `--cancel PID`: 向具有 PID 的进程发送取消命令(仅适用于非系统进程) + - `console`: 添加控制檯日誌記錄器 + - 選項: + - `--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 - 僅適用於控制檯 + - `file`: 添加文件日誌記錄器 + - 選項: + - `--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`: 在日誌中使用顏色 + - `--filename value`, `-f value`: 日誌記錄器的文件名 + - `--rotate`, `-r`: 輪轉日誌 + - `--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`: 新日誌記錄器的名稱 - 預設為模式 + - `--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`, `-r`: 連接中斷時重新連接主機 + - `--protocol value`, `-P value`: 設定要使用的協議:tcp、unix 或 udp(預設為 tcp) + - `--address value`, `-a value`: 要連接到的主機地址和端口(預設為:7020) + - `smtp`: 添加 SMTP 日誌記錄器 + - 選項: + - `--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) + - `--send-to value`, `-s value`: 要發送到的電子電子郵件地址 + - `--subject value`, `-S value`: 發送電子郵件的主題標題 + - `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`:存储数据的存储库目录路径。 - - `--clone_addr addr`:将被克隆的 URL,目前可以是 git/github/gitea/gitlab 的 http/https URL。例如:https://github.com/lunny/tango.git - - `--auth_username lunny`:访问 `clone_addr` 的用户名。 - - `--auth_password `:访问 `clone_addr` 的密码。 - - `--auth_token `:访问 `clone_addr` 的个人令牌。 - - `--owner_name lunny`:如果非空,数据将存储在具有所有者名称的目录中。 - - `--repo_name tango`:如果非空,数据将存储在具有存储库名称的目录中。 - - `--units `:要迁移的项目,一个或多个项目应以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果为空,则表示所有项目。 +- 選項: + - `--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 `:訪問 `clone_addr` 的密碼。 + - `--auth_token `:訪問 `clone_addr` 的個人令牌。 + - `--owner_name lunny`:如果非空,資料將儲存在具有所有者名稱的目錄中。 + - `--repo_name tango`:如果非空,資料將儲存在具有儲存庫名稱的目錄中。 + - `--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 `:要还原的项目,一个或多个项目应以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果为空,则表示所有项目。 +- 選項: + - `--repo_dir dir`,`-r dir`:還原資料的儲存庫目錄路徑。 + - `--owner_name lunny`:還原目標所有者名稱。 + - `--repo_name tango`:還原目標儲存庫名稱。 + - `--units `:要還原的專案,一個或多個專案應以逗號分隔。允許的專案有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果為空,則表示所有專案。 ### actions generate-runner-token -生成一个供 Runner 使用的新令牌,用于向服务器注册。 +生成一個供 Runner 使用的新令牌,用於向伺服器註冊。 -- 选项: - - `--scope {owner}[/{repo}]`,`-s {owner}[/{repo}]`:限制 Runner 的范围,没有范围表示该 Runner 可用于所有仓库,但你也可以将其限制为特定的仓库或所有者。 +- 選項: + - `--scope {owner}[/{repo}]`,`-s {owner}[/{repo}]`:限制 Runner 的範圍,沒有範圍表示該 Runner 可用於所有儲存庫,但你也可以將其限制為特定的儲存庫或所有者。 -要注册全局 Runner: +要註冊全域 Runner: ``` 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 diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md index bb3b0608..c98f5570 100644 --- a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md @@ -7,83 +7,84 @@ aliases: - /zh-tw/config-cheat-sheet --- -# 配置说明 +# 設定說明 -这是针对 Gitea 配置文件的说明, -你可以了解 Gitea 的强大配置。 +這是針對 Gitea 設定文件的說明, +你可以瞭解 Gitea 的強大設定。 -需要说明的是,你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 -如果是从发行版本完成的安装, -配置文件的路径为`/etc/gitea/conf/app.ini`。 +需要說明的是,你的所有改變請修改 `custom/conf/app.ini` 文件而不是源文件。 +如果是從發行版本完成的安裝, +設定文件的路徑為`/etc/gitea/conf/app.ini`。 -所有默认值可以通过 [app.example.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) 查看到。 -标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义,否则最好使用默认值。 +所有預設值可以透過 [app.example.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) 查看到。 +標註了 :exclamation: 的設定項表明除非你真的理解這個設定項的意義,否則最好使用預設值。 -包含`#`或者`;`的变量必须使用引号( `` ` `` 或者 `"` )包裹,否则会被解析为注释。 +包含`#`或者`;`的變量必須使用引號( `` ` `` 或者 `"` )包裹,否則會被解析為註釋。 -本文档使用以下约定: +本文件使用以下約定: -* `[section].FOO_BAR` 或 `[section]FOO_BAR`: 一个位于 INI 文件 `[section]` 段中的配置项。 -* `FooBar`: 这是一个 Gitea 内部变量,不是一个配置项,仅用于描述相关逻辑。 -* `$FOO_BAR`: 这是一个环境变量,Gitea 可能会使用它的值,但是它不能直接用于配置文件中。 -* `{FOO_BAR}/something` 或 `{FooBar}/something`: 这个值会默认使用配置项 `FOO_BAR` 或者内部变量 `FooBar`。 +* `[section].FOO_BAR` 或 `[section]FOO_BAR`: 一個位於 INI 文件 `[section]` 段中的設定項。 +* `FooBar`: 這是一個 Gitea 內部變量,不是一個設定項,僅用於描述相關邏輯。 +* `$FOO_BAR`: 這是一個環境變量,Gitea 可能會使用它的值,但是它不能直接用於設定文件中。 +* `{FOO_BAR}/something` 或 `{FooBar}/something`: 這個值會預設使用設定項 `FOO_BAR` 或者內部變量 `FooBar`。 -**注意:** 修改完配置文件后,需要重启 Gitea 服务才能生效。 +**注意:** 修改完設定文件後,需要重啟 Gitea 服務才能生效。 -## 使用环境变量配置 Gitea +## 使用環境變量設定 Gitea -我们提供了 [environment-to-ini](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini) 工具 -来帮助通过环境变量生成 Gitea 的 `app.ini` 配置文件。 +我們提供了 [environment-to-ini](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini) 工具 +來幫助通過環境變量生成 Gitea 的 `app.ini` 設定文件。 -## 默认配置 (非`app.ini`配置文件) +## 預設設定 (非`app.ini`設定文件) -这些值取决于环境,但构成了许多值的基础。当运行 `gitea help`或启动时,它们将 -作为默认配置的一部分进行报告。它们在那里发出的顺序略有不同,但我们将按照设置的顺序在这里列出。 +這些值取決於環境,但構成了許多值的基礎。當運行 `gitea help`或啟動時,它們將 +作為預設設定的一部分進行報告。它們在那裡發出的順序略有不同,但我們將按照設定的順序在這裡列出。 -- _`AppPath`_: Gitea 二进制可执行文件的绝对路径 -- _`AppWorkPath`_: Gitea 可执行文件的工作目录。 该配置可以通过以下几种方式设置,优先级依次递减: - - `app.ini`中的`WORK_PATH`配置项 - - 启动 Gitea 时的`--work-path`命令行参数 - - `$GITEA_WORK_DIR`环境变量 - - 在编译时设置的内置值(参见从源代码编译) - - 默认为 _`AppPath`_ 的目录 - - 如果上述任何路径为相对路径,将自动解析为相对于 _`AppPath`_ 目录的绝对路径 -- _`CustomPath`_: 这是用于自定义模板和其他选项的基础目录。 - 它是通过使用以下层次结构中的第一个设置的内容来确定的: - - 通过传递给二进制文件的`--custom-path`标志 - - 环境变量 `$GITEA_CUSTOM` - - 在构建时设置的内置值(参见从源代码构建) - - 否则,默认为 _`AppWorkPath`_`/custom` - - 如果上述任何路径是相对路径,则会相对于 _`AppWorkPath`_ 目录进行处理, - 使其变为绝对路径。 -- _`CustomConf`_: 这是指向`app.ini`文件的路径。 - - 这是指向`app.ini`文件的路径。 - - 在构建时设置的内置值(参见从源代码构建) - - 否则,默认为 _`CustomPath`_`/conf/app.ini` - - 如果上述任何路径是相对路径,则会相对于*`CustomPath`*目录进行处理。 +- _`AppPath`_: Gitea 二進制可執行文件的絕對路徑 +- _`AppWorkPath`_: Gitea 可執行文件的工作目錄。 該設定可以透過以下幾種方式設定,優先級依次遞減: + - `app.ini`中的`WORK_PATH`設定項 + - 啟動 Gitea 時的`--work-path`命令行參數 + - `$GITEA_WORK_DIR`環境變量 + - 在編譯時設定的內置值(參見從源程式碼編譯) + - 預設為 _`AppPath`_ 的目錄 + - 如果上述任何路徑為相對路徑,將自動解析為相對於 _`AppPath`_ 目錄的絕對路徑 +- _`CustomPath`_: 這是用於自訂模板和其他選項的基礎目錄。 + 它是通過使用以下層次結構中的第一個設定的內容來確定的: + - 通過傳遞給二進制文件的`--custom-path`標誌 + - 環境變量 `$GITEA_CUSTOM` + - 在構建時設定的內置值(參見從源程式碼構建) + - 否則,預設為 _`AppWorkPath`_`/custom` + - 如果上述任何路徑是相對路徑,則會相對於 _`AppWorkPath`_ 目錄進行處理, + 使其變為絕對路徑。 +- _`CustomConf`_: 這是指向`app.ini`文件的路徑。 + - 這是指向`app.ini`文件的路徑。 + - 在構建時設定的內置值(參見從源程式碼構建) + - 否則,預設為 _`CustomPath`_`/conf/app.ini` + - 如果上述任何路徑是相對路徑,則會相對於*`CustomPath`*目錄進行處理。 -此外,还有*`StaticRootPath`*,可以在构建时设置为内置值,否则将默认为 _`AppWorkPath`_。 +此外,還有*`StaticRootPath`*,可以在構建時設定為內置值,否則將預設為 _`AppWorkPath`_。 ## Overall (`DEFAULT`) -- `APP_NAME`: **Gitea: Git with a cup of tea** 应用名称,在网页的标题中显示。 -- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行 Gitea 的用户, - 应当是一个专用的系统账户(非用户使用,推荐创建一个专用的`git`用户). 如果在你自己的个人电脑使用改成你自己的用户名。 - 该配置如果设置不正确,Gitea 可能崩溃。 -- `RUN_MODE`: **prod**: 应用的运行模式,对运行性能和问题排除有影响: `dev` 或者 `prod`,默认为 `prod`。 `dev`模式有助于开发和问题排查, 除设置为`dev` 外,均被视为 `prod`. -- `WORK_PATH`: **_the-work-path_**: 工作目录, 前文有提及. +- `APP_NAME`: **Gitea: Git with a cup of tea** 應用名稱,在網頁的標題中顯示。 +- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 運行 Gitea 的使用者, + 應當是一個專用的系統帳號(非使用者使用,推薦建立一個專用的`git`使用者). 如果在你自己的個人電腦使用改成你自己的使用者名稱。 + 該設定如果設定不正確,Gitea 可能崩潰。 +- `RUN_MODE`: **prod**: 應用的運行模式,對運行性能和問題排除有影響: `dev` 或者 `prod`,預設為 `prod`。 `dev`模式有助於開發和問題排查, 除設定為`dev` 外,均被視為 `prod`. +- `WORK_PATH`: **_the-work-path_**: 工作目錄, 前文有提及. -## 仓库 (`repository`) + +## 儲存庫 (`repository`) -- `ROOT`: **`{APP_DATA_PATH}/gitea-repositories`**: 存放 git 工程的根目录,建议填绝对路径。 - 相对路径将被解析为**`{AppWorkPath}/{ROOT}`**. -- `SCRIPT_TYPE`: **bash**: 服务器支持的 Shell 类型,通常是`bash`, - 但有些服务器也有可能是`sh`。 -- `DETECTED_CHARSETS_ORDER`: **UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, ISO-8859, windows-1252, ISO-8859, windows-1250, ISO-8859, ISO-8859, ISO-8859, windows-1253, ISO-8859, windows-1255, ISO-8859, windows-1251, windows-1256, KOI8-R, ISO-8859, windows-1254, Shift_JIS, GB18030, EUC-JP, EUC-KR, Big5, ISO-2022, ISO-2022, ISO-2022, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr**: 检测到的字符集的决定性顺序 - 如果检测到的字符集具有相等的置信度,则优先选择列表中较早出现的字符集,而不是较晚出现的字符集。添加“defaults”将会将未命名的字符集放置在该点。 -- `ANSI_CHARSET`: **_empty_**: 默认的 ANSI 字符集,用于覆盖非 UTF-8 字符集。 -- `FORCE_PRIVATE`: **false**: 强制使每个新仓库变为私有。 -- `DEFAULT_PRIVATE`: **last**: 创建新仓库时默认为私有:`last`, `private`, `public`。 -- `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 使用推送创建新仓库时默认为私有。 +- `ROOT`: **`{APP_DATA_PATH}/gitea-repositories`**: 存放 git 工程的根目錄,建議填絕對路徑。 + 相對路徑將被解析為**`{AppWorkPath}/{ROOT}`**. +- `SCRIPT_TYPE`: **bash**: 伺服器支援的 Shell 類型,通常是`bash`, + 但有些伺服器也有可能是`sh`。 +- `DETECTED_CHARSETS_ORDER`: **UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, ISO-8859, windows-1252, ISO-8859, windows-1250, ISO-8859, ISO-8859, ISO-8859, windows-1253, ISO-8859, windows-1255, ISO-8859, windows-1251, windows-1256, KOI8-R, ISO-8859, windows-1254, Shift_JIS, GB18030, EUC-JP, EUC-KR, Big5, ISO-2022, ISO-2022, ISO-2022, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr**: 檢測到的字符集的決定性順序 - 如果檢測到的字符集具有相等的置信度,則優先選擇列表中較早出現的字符集,而不是較晚出現的字符集。添加“defaults”將會將未命名的字符集放置在該點。 +- `ANSI_CHARSET`: **_empty_**: 預設的 ANSI 字符集,用於覆蓋非 UTF-8 字符集。 +- `FORCE_PRIVATE`: **false**: 強制使每個新儲存庫變為私有。 +- `DEFAULT_PRIVATE`: **last**: 建立新儲存庫時預設為私有:`last`, `private`, `public`。 +- `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 使用推送建立新儲存庫時預設為私有。 - `MAX_CREATION_LIMIT`: **-1**: 每個使用者/組織的全域儲存庫建立上限, `-1` 代表無限制。當 `USER_MAX_CREATION_LIMIT` 與 `ORG_MAX_CREATION_LIMIT` 未單獨設定時,這兩項的預設值都會繼承自此項。 @@ -91,112 +92,112 @@ aliases: `-1` 代表無限制。設定後優先級高於 `MAX_CREATION_LIMIT`。 - `ORG_MAX_CREATION_LIMIT`: **-1**: 每個組織的全域儲存庫建立上限,在建立儲存庫時生效。 `-1` 代表無限制。設定後優先級高於 `MAX_CREATION_LIMIT`。 -- `PREFERRED_LICENSES`: **Apache License 2.0,MIT License**: 要放置在列表顶部的指定许可证。 - 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 -- `DISABLE_HTTP_GIT`: **false**: 禁用 HTTP 协议与仓库进行 +- `PREFERRED_LICENSES`: **Apache License 2.0,MIT License**: 要放置在列表頂部的指定許可證。 + 名稱必須與 options/license 或 custom/options/license 中的文件名匹配。 +- `DISABLE_HTTP_GIT`: **false**: 禁用 HTTP 協議與儲存庫進行 交互的能力。 -- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的 SSH 端口时,强制使用 ssh://克隆 URL, +- `USE_COMPAT_SSH_URI`: **false**: 當使用預設的 SSH 端口時,強制使用 ssh://克隆 URL, 而不是 scp-style uri。 -- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值,返回仓库的 URL 作为 https 或 ssh, - 默认为 https。 -- `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**:用于 Access-Control-Allow-Origin 标头的值, - 默认不提供。 - 警告:如果您不提供正确的值,这可能对您的网站造成危害。 -- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭,则关闭该问题。 -- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到 Gitea,并为用户自动创建它们。 -- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到 Gitea,并为组织自动创建它们。 -- `DISABLED_REPO_UNITS`: **_empty_**: 逗号分隔的全局禁用的仓库单元列表。允许的值是:: \[repo.issues, repo.ext_issues, repo.pulls, repo.wiki, repo.ext_wiki, repo.projects, repo.packages, repo.actions\] -- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是:: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意:目前无法停用代码和发布。如果您指定了默认的仓库单元,您仍应将它们列出以保持未来的兼容性。外部 wiki 和问题跟踪器不能默认启用,因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中,无论它是否在默认列表中。 -- `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: 逗号分隔的默认分叉仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 -- `DEFAULT_MIRROR_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认镜像仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 -- `DEFAULT_TEMPLATE_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认模板仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 -- `PREFIX_ARCHIVE_FILES`: **true**: 通过将存档文件放置在以仓库命名的目录中来添加前缀。 -- `DISABLE_MIGRATIONS`: **false**: 禁用迁移功能。 -- `DISABLE_STARS`: **false**: 禁用点赞功能。 -- `DEFAULT_BRANCH`: **main**: 所有仓库的默认分支名称。 -- `ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`: **false**: 允许非管理员用户认领未被认领的仓库。 -- `ALLOW_DELETION_OF_UNADOPTED_REPOSITORIES`: **false**: 允许非管理员用户删除未被认领的仓库。 -- `DISABLE_DOWNLOAD_SOURCE_ARCHIVES`: **false**: 不允许从用户界面下载源代码存档文件。 -- `ALLOW_FORK_WITHOUT_MAXIMUM_LIMIT`: **true**: 允许无限制得派生仓库。 -- `ALLOW_FORK_INTO_SAME_OWNER`: **false**: 允许将仓库派生到同一所有者(用户或组织)中。此功能为实验性功能,尚未完全测试,将来可能会更改。 +- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用於 "go get" 請求的值,返回儲存庫的 URL 作為 https 或 ssh, + 預設為 https。 +- `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**:用於 Access-Control-Allow-Origin 標頭的值, + 預設不提供。 + 警告:如果您不提供正確的值,這可能對您的網站造成危害。 +- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非預設分支上的提交將問題標記為已關閉,則關閉該問題。 +- `ENABLE_PUSH_CREATE_USER`: **false**: 允許使用者將本地儲存庫推送到 Gitea,併為使用者自動建立它們。 +- `ENABLE_PUSH_CREATE_ORG`: **false**: 允許使用者將本地儲存庫推送到 Gitea,併為組織自動建立它們。 +- `DISABLED_REPO_UNITS`: **_empty_**: 逗號分隔的全域禁用的儲存庫單元列表。允許的值是:: \[repo.issues, repo.ext_issues, repo.pulls, repo.wiki, repo.ext_wiki, repo.projects, repo.packages, repo.actions\] +- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages,repo.actions**: 逗號分隔的預設新儲存庫單元列表。允許的值是:: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意:目前無法停用程式碼和發佈。如果您指定了預設的儲存庫單元,您仍應將它們列出以保持未來的相容性。外部 wiki 和問題跟蹤器不能預設啟用,因為它需要額外的設定。禁用的儲存庫單元將不會添加到新的儲存庫中,無論它是否在預設列表中。 +- `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: 逗號分隔的預設分叉儲存庫單元列表。允許的值和規則與`DEFAULT_REPO_UNITS`相同。 +- `DEFAULT_MIRROR_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.wiki,repo.projects,repo.packages**: 逗號分隔的預設鏡像儲存庫單元列表。允許的值和規則與`DEFAULT_REPO_UNITS`相同。 +- `DEFAULT_TEMPLATE_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages**: 逗號分隔的預設模板儲存庫單元列表。允許的值和規則與`DEFAULT_REPO_UNITS`相同。 +- `PREFIX_ARCHIVE_FILES`: **true**: 通過將存檔文件放置在以儲存庫命名的目錄中來添加前綴。 +- `DISABLE_MIGRATIONS`: **false**: 禁用遷移功能。 +- `DISABLE_STARS`: **false**: 禁用點贊功能。 +- `DEFAULT_BRANCH`: **main**: 所有儲存庫的預設分支名稱。 +- `ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`: **false**: 允許非管理員使用者認領未被認領的儲存庫。 +- `ALLOW_DELETION_OF_UNADOPTED_REPOSITORIES`: **false**: 允許非管理員使用者刪除未被認領的儲存庫。 +- `DISABLE_DOWNLOAD_SOURCE_ARCHIVES`: **false**: 不允許從使用者介面下載源程式碼存檔文件。 +- `ALLOW_FORK_WITHOUT_MAXIMUM_LIMIT`: **true**: 允許無限制得派生儲存庫。 +- `ALLOW_FORK_INTO_SAME_OWNER`: **false**: 允許將儲存庫派生到同一所有者(使用者或組織)中。此功能為實驗性功能,尚未完全測試,將來可能會更改。 -### 仓库 - 编辑器 (`repository.editor`) +### 儲存庫 - 編輯器 (`repository.editor`) -- `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 编辑器中应该换行的文件扩展名列表。用逗号分隔扩展名。要对没有扩展名的文件进行换行,只需放置一个逗号。 -- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览 API 的有效文件模式,例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配,编辑模式下的预览选项卡将不会显示。 +- `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 編輯器中應該換行的文件擴展名列表。用逗號分隔擴展名。要對沒有擴展名的文件進行換行,只需放置一個逗號。 +- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有預覽 API 的有效文件模式,例如 `api/v1/markdown`。用逗號分隔各個值。如果文件擴展名不匹配,編輯模式下的預覽選項卡將不會顯示。 -### 仓库 - 合并请求 (`repository.pull-request`) +### 儲存庫 - 合併請求 (`repository.pull-request`) -- `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: 在拉取请求标题中用于标记工作正在进行中的前缀列表。 - 这些前缀在不区分大小写的情况下进行匹配。 -- `CLOSE_KEYWORDS`: **close**, **closes**, **closed**, **fix**, **fixes**, **fixed**, **resolve**, **resolves**, **resolved**: 在拉取请求评论中用于自动关闭相关问题的关键词列表。 -- `REOPEN_KEYWORDS`: **reopen**, **reopens**, **reopened**: 在拉取请求评论中用于自动重新打开相关问题的 - 关键词列表。 -- `DEFAULT_MERGE_STYLE`: **merge**: 设置创建仓库的默认合并方式,可选: `merge`, `rebase`, `rebase-merge`, `squash`, `fast-forward-only` -- `DEFAULT_MERGE_MESSAGE_COMMITS_LIMIT`: **50**: 在默认合并消息中,对于`squash`提交,最多包括此数量的提交。设置为 -1 以包括所有提交。 -- `DEFAULT_MERGE_MESSAGE_SIZE`: **5120**: 在默认的合并消息中,对于`squash`提交,限制提交消息的大小。设置为 `-1`以取消限制。仅在`POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`为`true`时使用。 -- `DEFAULT_MERGE_MESSAGE_ALL_AUTHORS`: **false**: 在默认合并消息中,对于`squash`提交,遍历所有提交以包括所有作者的`Co-authored-by`,否则仅使用限定列表中的作者。 -- `DEFAULT_MERGE_MESSAGE_MAX_APPROVERS`: **10**:在默认合并消息中,限制列出的审批者数量为`Reviewed-by`:。设置为 `-1` 以包括所有审批者。 -- `DEFAULT_MERGE_MESSAGE_OFFICIAL_APPROVERS_ONLY`: **true**: 在默认合并消息中,仅包括官方允许审查的审批者。 -- `POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`: **false**: 在默认的 squash 合并消息中,包括构成拉取请求的所有提交的提交消息。 -- `ADD_CO_COMMITTER_TRAILERS`: **true**: 如果提交者与作者不匹配,在合并提交消息中添加`co-authored-by`和`co-committed-by`标记。 -- `RETARGET_CHILDREN_ON_MERGE`: **true**: 当父合并请求被合并时,将子合并请求重新定向到父合并请求的目标分支。仅适用于头分支和基分支指向同一仓库的已合并合并请求。 -- `DEFAULT_DELETE_BRANCH_AFTER_MERGE`: **false**: 为新仓库设置"合并后默认删除合并请求分支"的默认值。 +- `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: 在拉取請求標題中用於標記工作正在進行中的前綴列表。 + 這些前綴在不區分大小寫的情況下進行匹配。 +- `CLOSE_KEYWORDS`: **close**, **closes**, **closed**, **fix**, **fixes**, **fixed**, **resolve**, **resolves**, **resolved**: 在拉取請求評論中用於自動關閉相關問題的關鍵詞列表。 +- `REOPEN_KEYWORDS`: **reopen**, **reopens**, **reopened**: 在拉取請求評論中用於自動重新打開相關問題的 + 關鍵詞列表。 +- `DEFAULT_MERGE_STYLE`: **merge**: 設定建立儲存庫的預設合併方式,可選: `merge`, `rebase`, `rebase-merge`, `squash`, `fast-forward-only` +- `DEFAULT_MERGE_MESSAGE_COMMITS_LIMIT`: **50**: 在預設合併消息中,對於`squash`提交,最多包括此數量的提交。設定為 -1 以包括所有提交。 +- `DEFAULT_MERGE_MESSAGE_SIZE`: **5120**: 在預設的合併消息中,對於`squash`提交,限制提交消息的大小。設定為 `-1`以取消限制。僅在`POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`為`true`時使用。 +- `DEFAULT_MERGE_MESSAGE_ALL_AUTHORS`: **false**: 在預設合併消息中,對於`squash`提交,遍歷所有提交以包括所有作者的`Co-authored-by`,否則僅使用限定列表中的作者。 +- `DEFAULT_MERGE_MESSAGE_MAX_APPROVERS`: **10**:在預設合併消息中,限制列出的審批者數量為`Reviewed-by`:。設定為 `-1` 以包括所有審批者。 +- `DEFAULT_MERGE_MESSAGE_OFFICIAL_APPROVERS_ONLY`: **true**: 在預設合併消息中,僅包括官方允許審查的審批者。 +- `POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`: **false**: 在預設的 squash 合併消息中,包括構成拉取請求的所有提交的提交消息。 +- `ADD_CO_COMMITTER_TRAILERS`: **true**: 如果提交者與作者不匹配,在合併提交消息中添加`co-authored-by`和`co-committed-by`標記。 +- `RETARGET_CHILDREN_ON_MERGE`: **true**: 當父合併請求被合併時,將子合併請求重新定向到父合併請求的目標分支。僅適用於頭分支和基分支指向同一儲存庫的已合併合併請求。 +- `DEFAULT_DELETE_BRANCH_AFTER_MERGE`: **false**: 為新儲存庫設定"合併後預設刪除合併請求分支"的預設值。 -### 仓库 - 工单 (`repository.issue`) +### 儲存庫 - 工單 (`repository.issue`) -- `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合并请求或工单被锁定的原因列表。 -- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为 0 禁用固定工单。 +- `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合併請求或工單被鎖定的原因列表。 +- `MAX_PINNED`: **3**: 每個儲存庫的最大可固定工單數量。設定為 0 禁用固定工單。 -### 仓库 - 文件上传 (`repository.upload`) +### 儲存庫 - 文件上傳 (`repository.upload`) -- `ENABLED`: **true**: 是否启用仓库文件上传。 -- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在 Gitea 重启的时候该目录会被清空)。 -- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表,代表支持上传的文件类型。(`.zip`), mime 类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 -- `FILE_MAX_SIZE`: **50**: 每个文件的最大大小(MB)。 -- `MAX_FILES`: **5**: 每次上传的最大文件数。 +- `ENABLED`: **true**: 是否啟用儲存庫文件上傳。 +- `TEMP_PATH`: **data/tmp/uploads**: 文件上傳的臨時保存路徑(在 Gitea 重啟的時候該目錄會被清空)。 +- `ALLOWED_TYPES`: **_empty_**: 以逗號分割的列表,代表支援上傳的文件類型。(`.zip`), mime 類型 (`text/plain`) or 通配符類型 (`image/*`, `audio/*`, `video/*`). 為空或者 `*/*`代表允許所有類型文件。 +- `FILE_MAX_SIZE`: **50**: 每個文件的最大大小(MB)。 +- `MAX_FILES`: **5**: 每次上傳的最大文件數。 -### 仓库 - 版本发布 (`repository.release`) +### 儲存庫 - 版本發佈 (`repository.release`) -- `ALLOWED_TYPES`: **_empty_**: 允许发布的文件类型列表,用逗号分隔 。如压缩包类型(`.zip`), mime 类型 (`text/plain`) ,也支持通配符 (`image/*`, `audio/*`, `video/*`)。 空值或者 `*/*` 代表允许所有类型。 -- `DEFAULT_PAGING_NUM`: **10**: 默认的发布版本页面分页大小 -- `FILE_MAX_SIZE`: **2048**: 版本发布附件的最大文件大小限制(MB) -- `MAX_FILES`: **5**: 版本发布一次最多上传的附件数量。 -- 关于版本发布相关的附件设置,详见`附件`部分。 +- `ALLOWED_TYPES`: **_empty_**: 允許發佈的文件類型列表,用逗號分隔 。如壓縮包類型(`.zip`), mime 類型 (`text/plain`) ,也支援通配符 (`image/*`, `audio/*`, `video/*`)。 空值或者 `*/*` 代表允許所有類型。 +- `DEFAULT_PAGING_NUM`: **10**: 預設的發佈版本頁面分頁大小 +- `FILE_MAX_SIZE`: **2048**: 版本發佈附件的最大文件大小限制(MB) +- `MAX_FILES`: **5**: 版本發佈一次最多上傳的附件數量。 +- 關於版本發佈相關的附件設定,詳見`附件`部分。 -### 仓库 - Signing (`repository.signing`) +### 儲存庫 - Signing (`repository.signing`) -- `SIGNING_KEY`: **default**: \[none, KEYID, default \]: 用于签名的密钥 -- `SIGNING_NAME` & `SIGNING_EMAIL`: 如果`SIGNING_KEY`提供了一个 KEYID,将使用这些作为签名者的姓名和电子邮件地址。这些应与密钥的公开姓名和电子邮件地址相匹配。 -- `INITIAL_COMMIT`: **always**: \[never, pubkey, twofa, always\]: 签名初始提交。 - - `never`: 永不签名 - - `pubkey`: 仅在用户具有公钥时签名 - - `twofa`: 仅在用户使用双因素身份验证登录时签名 - - `always`: 始终签名 - - 除了 never 和 always 之外的选项可以组合为逗号分隔的列表。 -- `DEFAULT_TRUST_MODEL`: **collaborator**: \[collaborator, committer, collaboratorcommitter\]: 用于验证提交的默认信任模型。 - - `collaborator`: 信任协作者密钥签名的签名。 - - `committer`: 信任与提交者匹配的签名(这与 GitHub 匹配,并会强制 Gitea 签名的提交具有 Gitea 作为提交者)。 - - `collaboratorcommitter`: 信任与提交者匹配的协作者密钥签名的签名。 -- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对 wiki 提交进行签名。 -- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对 CRUD 操作进行签名。 - - 与上面相同的选项,增加了: - - `parentsigned`: 仅在父提交进行了签名时才进行签名。 -- `MERGES`: **pubkey, twofa, basesigned, commitssigned**: \[never, pubkey, twofa, approved, basesigned, commitssigned, always\]: 对合并操作进行签名。 - - `approved`: 仅对已批准的合并操作进行签名,适用于受保护的分支。 - - `basesigned`: 仅在基础仓库的父提交进行了签名时才进行签名。 - - `headsigned`: 仅在头分支的头提交进行了签名时才进行签名。 - - `commitssigned`: 仅在头分支中的所有提交到合并点都进行了签名时才进行签名。 +- `SIGNING_KEY`: **default**: \[none, KEYID, default \]: 用於簽名的密鑰 +- `SIGNING_NAME` & `SIGNING_EMAIL`: 如果`SIGNING_KEY`提供了一個 KEYID,將使用這些作為簽名者的姓名和電子電子郵件地址。這些應與密鑰的公開姓名和電子電子郵件地址相匹配。 +- `INITIAL_COMMIT`: **always**: \[never, pubkey, twofa, always\]: 簽名初始提交。 + - `never`: 永不簽名 + - `pubkey`: 僅在使用者具有公鑰時簽名 + - `twofa`: 僅在使用者使用雙因素身份驗證登入時簽名 + - `always`: 始終簽名 + - 除了 never 和 always 之外的選項可以組合為逗號分隔的列表。 +- `DEFAULT_TRUST_MODEL`: **collaborator**: \[collaborator, committer, collaboratorcommitter\]: 用於驗證提交的預設信任模型。 + - `collaborator`: 信任協作者密鑰簽名的簽名。 + - `committer`: 信任與提交者匹配的簽名(這與 GitHub 匹配,並會強制 Gitea 簽名的提交具有 Gitea 作為提交者)。 + - `collaboratorcommitter`: 信任與提交者匹配的協作者密鑰簽名的簽名。 +- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 對 wiki 提交進行簽名。 +- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 對 CRUD 操作進行簽名。 + - 與上面相同的選項,增加了: + - `parentsigned`: 僅在父提交進行了簽名時才進行簽名。 +- `MERGES`: **pubkey, twofa, basesigned, commitssigned**: \[never, pubkey, twofa, approved, basesigned, commitssigned, always\]: 對合併操作進行簽名。 + - `approved`: 僅對已批准的合併操作進行簽名,適用於受保護的分支。 + - `basesigned`: 僅在基礎儲存庫的父提交進行了簽名時才進行簽名。 + - `headsigned`: 僅在頭分支的頭提交進行了簽名時才進行簽名。 + - `commitssigned`: 僅在頭分支中的所有提交到合併點都進行了簽名時才進行簽名。 -### 仓库 - Local (`repository.local`) +### 儲存庫 - Local (`repository.local`) -- `LOCAL_COPY_PATH`: **tmp/local-repo**:临时本地仓库副本的路径。默认为 tmp/local-repo(内容在 Gitea 重新启动时被删除) +- `LOCAL_COPY_PATH`: **tmp/local-repo**:臨時本地儲存庫副本的路徑。預設為 tmp/local-repo(內容在 Gitea 重新啟動時被刪除) -### 仓库 - MIME type mapping (`repository.mimetype_mapping`) +### 儲存庫 - MIME type mapping (`repository.mimetype_mapping`) -配置用于根据可下载文件的文件扩展名设置预期的 MIME 类型。配置以键值对的形式呈现,文件扩展名以`.`开头。 +設定用於根據可下載文件的文件擴展名設定預期的 MIME 類型。設定以鍵值對的形式呈現,文件擴展名以`.`開頭。 -以下配置在下载具有`.apk`文件扩展名的文件时设置`Content-Type: application/vnd.android.package-archive`头部。 +以下設定在下載具有`.apk`文件擴展名的文件時設定`Content-Type: application/vnd.android.package-archive`頭部。 ```ini .apk=application/vnd.android.package-archive @@ -204,204 +205,206 @@ aliases: ## 跨域 (`cors`) -- `ENABLED`: **false**: 启用 CORS 头部(默认禁用) -- `ALLOW_DOMAIN`: **\***: 允许请求的域名列表 -- `METHODS`: **GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS**: 允许发起的请求方式列表 -- `MAX_AGE`: **10m**: 缓存响应的最大时间 -- `ALLOW_CREDENTIALS`: **false**: 允许带有凭据的请求 -- `HEADERS`: **Content-Type,User-Agent**: 允许请求携带的头部 -- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP 头部. +- `ENABLED`: **false**: 啟用 CORS 頭部(預設禁用) +- `ALLOW_DOMAIN`: **\***: 允許請求的域名列表 +- `METHODS`: **GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS**: 允許發起的請求方式列表 +- `MAX_AGE`: **10m**: 緩存響應的最大時間 +- `ALLOW_CREDENTIALS`: **false**: 允許帶有憑據的請求 +- `HEADERS`: **Content-Type,User-Agent**: 允許請求攜帶的頭部 +- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 詳見 `X-Frame-Options`HTTP 頭部. -## 界面 (`ui`) + +## 介面 (`ui`) -- `EXPLORE_PAGING_NUM`: **20**: 探索页面每页显示的仓库数量。 -- `ISSUE_PAGING_NUM`: **20**: 工单页面每页显示的工单数量。 -- `MEMBERS_PAGING_NUM`: **20**: 组织成员页面每页显示的成员数量。 -- `FEED_MAX_COMMIT_NUM`: **5**: 活动流页面显示的最大提交数量。 -- `FEED_PAGING_NUM`: **20**: 活动流页面显示的最大活动数量。 -- `SITEMAP_PAGING_NUM`: **20**: 在单个子 SiteMap 中显示的项数。 -- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大 commit 数量。 -- `CODE_COMMENT_LINES`: **4**: 在代码评论中能够显示的最大代码行数。 -- `DEFAULT_THEME`: **gitea-auto**: 在 Gitea 安装时候设置的默认主题,自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 -- `SHOW_USER_EMAIL`: **true**: 用户的电子邮件是否应该显示在`Explore Users`页面中。 -- `THEMES`: **_empty_**: 所有可用的主题(由 `{CustomPath}/public/assets/css/theme-*.css` 提供)。允许用户选择个性化的主题, -- `FILE_ICON_THEME`: **material**: 文件图标主题(basic/material)。 -- `FOLDER_ICON_THEME`: **basic**: 文件夹图标主题(basic/material)。 -- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小(默认为 8MiB)。 -- `AMBIGUOUS_UNICODE_DETECTION`: **true**: 检测文件内容中的歧义 Unicode 字符并在界面上显示警告。 -- `REACTIONS`: 用户可以在问题(Issue)、Pull Request(PR)以及评论中选择的所有可选的反应。 - 这些值可以是表情符号别名(例如::smile:)或 Unicode 表情符号。 - 对于自定义的反应,在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像,文件名为 reaction_name.png。 -- `REACTION_MAX_USER_NUM`: **10**: 更改在反应工具提示中显示的用户数量(鼠标悬停时触发)。 -- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 标准中定义的额外表情符号。 - 默认情况下,我们支持 Gitea 表情符号(:gitea:)。要添加更多表情符号,请将它们复制到 public/assets/img/emoji/ 目录下, - 并将其添加到此配置中。 -- `ENABLED_EMOJIS`: **_empty_**: 以逗号分隔的启用表情符号列表,例如:"smile, thumbsup, thumbsdown"。留空以启用所有表情符号。 -- `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情况下显示用户的全名。如果没有设置全名,则将使用用户名。 -- `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索页面上的仓库搜索中搜索描述。 -- `ONLY_SHOW_RELEVANT_REPOS`: **false** 在没有指定关键字并使用默认排序时,是否仅在探索页面上显示相关的仓库。 - 如果一个仓库是分叉或者没有元数据(没有描述、图标、主题),则被视为不相关的仓库。 -- `EXPLORE_PAGING_DEFAULT_SORT`: **recentupdate**: 更改探索页面的排序类型。有效值为 "recentupdate"、"alphabetically"、"reverselastlogin"、"newest" 和 "oldest"。 -- `PREFERRED_TIMESTAMP_TENSE`: **mixed**: 所有时间戳应呈现的时态。可选值为 `absolute` 时间(即 1970-01-01, 11:59)和 `mixed`。`mixed` 表示大部分时间戳以相对时间显示(即 2 天前)。 +- `EXPLORE_PAGING_NUM`: **20**: 探索頁面每頁顯示的儲存庫數量。 +- `ISSUE_PAGING_NUM`: **20**: 工單頁面每頁顯示的工單數量。 +- `MEMBERS_PAGING_NUM`: **20**: 組織成員頁面每頁顯示的成員數量。 +- `FEED_MAX_COMMIT_NUM`: **5**: 活動流頁面顯示的最大提交數量。 +- `FEED_PAGING_NUM`: **20**: 活動流頁面顯示的最大活動數量。 +- `SITEMAP_PAGING_NUM`: **20**: 在單個子 SiteMap 中顯示的項數。 +- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交圖中顯示的最大 commit 數量。 +- `CODE_COMMENT_LINES`: **4**: 在程式碼評論中能夠顯示的最大程式碼行數。 +- `DEFAULT_THEME`: **gitea-auto**: 在 Gitea 安裝時候設定的預設主題,自訂的主題可以透過 `{CustomPath}/public/assets/css/theme-*.css` 提供。 +- `SHOW_USER_EMAIL`: **true**: 使用者的電子郵件是否應該顯示在`Explore Users`頁面中。 +- `THEMES`: **_empty_**: 所有可用的主題(由 `{CustomPath}/public/assets/css/theme-*.css` 提供)。允許使用者選擇個性化的主題, +- `FILE_ICON_THEME`: **material**: 文件圖標主題(basic/material)。 +- `FOLDER_ICON_THEME`: **basic**: 文件夾圖標主題(basic/material)。 +- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能夠顯示文件的最大大小(預設為 8MiB)。 +- `AMBIGUOUS_UNICODE_DETECTION`: **true**: 檢測文件內容中的歧義 Unicode 字符並在介面上顯示警告。 +- `REACTIONS`: 使用者可以在問題(Issue)、Pull Request(PR)以及評論中選擇的所有可選的反應。 + 這些值可以是表情符號別名(例如::smile:)或 Unicode 表情符號。 + 對於自訂的反應,在 public/assets/img/emoji/ 目錄下添加一個緊密裁剪的正方形圖像,文件名為 reaction_name.png。 +- `REACTION_MAX_USER_NUM`: **10**: 更改在反應工具提示中顯示的使用者數量(鼠標懸停時觸發)。 +- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 標準中定義的額外表情符號。 + 預設情況下,我們支援 Gitea 表情符號(:gitea:)。要添加更多表情符號,請將它們複製到 public/assets/img/emoji/ 目錄下, + 並將其添加到此設定中。 +- `ENABLED_EMOJIS`: **_empty_**: 以逗號分隔的啟用表情符號列表,例如:"smile, thumbsup, thumbsdown"。留空以啟用所有表情符號。 +- `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情況下顯示使用者的全名。如果沒有設定全名,則將使用使用者名稱。 +- `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索頁面上的儲存庫搜索中搜索描述。 +- `ONLY_SHOW_RELEVANT_REPOS`: **false** 在沒有指定關鍵字並使用預設排序時,是否僅在探索頁面上顯示相關的儲存庫。 + 如果一個儲存庫是分叉或者沒有元資料(沒有描述、圖標、主題),則被視為不相關的儲存庫。 +- `EXPLORE_PAGING_DEFAULT_SORT`: **recentupdate**: 更改探索頁面的排序類型。有效值為 "recentupdate"、"alphabetically"、"reverselastlogin"、"newest" 和 "oldest"。 +- `PREFERRED_TIMESTAMP_TENSE`: **mixed**: 所有時間戳應呈現的時態。可選值為 `absolute` 時間(即 1970-01-01, 11:59)和 `mixed`。`mixed` 表示大部分時間戳以相對時間顯示(即 2 天前)。 -### 界面 - 管理员 (`ui.admin`) +### 介面 - 管理員 (`ui.admin`) -- `USER_PAGING_NUM`: **50**: 单页显示的用户数量。 -- `REPO_PAGING_NUM`: **50**: 单页显示的仓库数量。 -- `NOTICE_PAGING_NUM`: **25**: 单页显示的通知数量。 -- `ORG_PAGING_NUM`: **50**: 单页显示的组织数量。 +- `USER_PAGING_NUM`: **50**: 單頁顯示的使用者數量。 +- `REPO_PAGING_NUM`: **50**: 單頁顯示的儲存庫數量。 +- `NOTICE_PAGING_NUM`: **25**: 單頁顯示的通知數量。 +- `ORG_PAGING_NUM`: **50**: 單頁顯示的組織數量。 -### 界面 - 用户 (`ui.user`) +### 介面 - 使用者 (`ui.user`) -- `REPO_PAGING_NUM`: **15**: 单页显示的仓库数量。 -- `ORG_PAGING_NUM`: **15**: 个人信息页展示的组织数量。 +- `REPO_PAGING_NUM`: **15**: 單頁顯示的儲存庫數量。 +- `ORG_PAGING_NUM`: **15**: 個人資訊頁展示的組織數量。 -### 界面 - 元信息 (`ui.meta`) +### 介面 - 元資訊 (`ui.meta`) -- `AUTHOR`: **Gitea - Git with a cup of tea**: 主页的作者元标签。 -- `DESCRIPTION`: **Gitea (Git with a cup of tea) is a painless self-hosted Git service written in Go**: 主页的描述元标签。 -- `KEYWORDS`: **go,git,self-hosted,gitea**: 首页关键词元标签。 +- `AUTHOR`: **Gitea - Git with a cup of tea**: 主頁的作者元標籤。 +- `DESCRIPTION`: **Gitea (Git with a cup of tea) is a painless self-hosted Git service written in Go**: 主頁的描述元標籤。 +- `KEYWORDS`: **go,git,self-hosted,gitea**: 首頁關鍵詞元標籤。 -### 界面 - 通知 (`ui.notification`) +### 介面 - 通知 (`ui.notification`) -- `MIN_TIMEOUT`: **10s**: 这些选项控制通知端点定期轮询以更新通知计数。在页面加载后,通知计数将在` MIN_TIMEOUT`之后进行检查。如果通知计数未更改,超时时间将按照`TIMEOUT_STEP`增加到`MAX_TIMEOUT`。将 `MIN_TIMEOUT`设置为 -1 以关闭该功能。 +- `MIN_TIMEOUT`: **10s**: 這些選項控制通知端點定期輪詢以更新通知計數。在頁面加載後,通知計數將在` MIN_TIMEOUT`之後進行檢查。如果通知計數未更改,超時時間將按照`TIMEOUT_STEP`增加到`MAX_TIMEOUT`。將 `MIN_TIMEOUT`設定為 -1 以關閉該功能。 - `MAX_TIMEOUT`: **60s**. - `TIMEOUT_STEP`: **10s**. -- `EVENT_SOURCE_UPDATE_TIME`: **10s**: 该设置确定了查询数据库以更新通知计数的频率。如果浏览器客户端支持`EventSource`和`SharedWorker`,则优先使用`SharedWorker`而不是轮询通知端点。将其设置为 -1 可以禁用 `EventSource`。 +- `EVENT_SOURCE_UPDATE_TIME`: **10s**: 該設定確定了查詢資料庫以更新通知計數的頻率。如果瀏覽器客戶端支援`EventSource`和`SharedWorker`,則優先使用`SharedWorker`而不是輪詢通知端點。將其設定為 -1 可以禁用 `EventSource`。 -### 界面 - SVG Images (`ui.svg`) +### 介面 - SVG Images (`ui.svg`) -- `ENABLE_RENDER`: **true**: 是否将 SVG 文件呈现为图像。如果禁用了 SVG 渲染,SVG 文件将显示为文本,无法作为图像嵌入到 Markdown 文件中。 +- `ENABLE_RENDER`: **true**: 是否將 SVG 文件呈現為圖像。如果禁用了 SVG 渲染,SVG 文件將顯示為文本,無法作為圖像嵌入到 Markdown 文件中。 -### 界面 - CSV Files (`ui.csv`) +### 介面 - CSV Files (`ui.csv`) -- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将 CSV 文件呈现为表格的最大文件大小(将其设置为 0 表示没有限制)。 -- `MAX_ROWS`: **2500** : 最大允许的 CSV 文件行数。 (设置为 0 不限制) +- `MAX_FILE_SIZE`: **524288** (512kb): 以位元組為單位允許將 CSV 文件呈現為表格的最大文件大小(將其設定為 0 表示沒有限制)。 +- `MAX_ROWS`: **2500** : 最大允許的 CSV 文件行數。 (設定為 0 不限制) ## Markdown (`markdown`) -- `RENDER_OPTIONS_COMMENT`: **short-issue-pattern, new-line-hard-break**: 自定义不同上下文的渲染选项。 - 设置为 "none" 以禁用默认值,或使用逗号分隔的列表: - - short-issue-pattern: 识别 "#123" 工单引用并将其渲染为指向工单的链接 - - new-line-hard-break: 将软换行符渲染为硬换行符,这意味着段落之间的单个换行符将导致换行, - 并且不需要在段落后添加尾随空格来强制换行。 -- `RENDER_OPTIONS_WIKI`: **short-issue-pattern**: 参见 RENDER_OPTIONS_COMMENT -- `RENDER_OPTIONS_REPO_FILE`: **_empty_**: 参见 RENDER_OPTIONS_COMMENT -- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表(ftp、git、svn)来指示要在 Markdown 中呈现的附加 URL 超链接。 - 以 http 和 https 开头的 URL 始终显示。 - 如果此条目为空,则允许所有 URL 方案。 -- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为 Markdown 的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为 Markdown,请只需放置一个逗号。 -- `ENABLE_MATH`: **true**: 启用对`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作为数学块的检测。 -- `MATH_CODE_BLOCK_DETECTION`: **inline-dollar,block-dollar**: 启用数学代码块检测的分隔符。 - 设置为 "none" 以禁用全部,或使用逗号分隔的列表:inline-dollar, inline-parentheses, block-dollar, block-square-brackets。 - 默认值遵循 GitHub 的行为。 +- `RENDER_OPTIONS_COMMENT`: **short-issue-pattern, new-line-hard-break**: 自訂不同上下文的渲染選項。 + 設定為 "none" 以禁用預設值,或使用逗號分隔的列表: + - short-issue-pattern: 識別 "#123" 工單引用並將其渲染為指向工單的鏈接 + - new-line-hard-break: 將軟換行符渲染為硬換行符,這意味著段落之間的單個換行符將導致換行, + 並且不需要在段落後添加尾隨空格來強制換行。 +- `RENDER_OPTIONS_WIKI`: **short-issue-pattern**: 參見 RENDER_OPTIONS_COMMENT +- `RENDER_OPTIONS_REPO_FILE`: **_empty_**: 參見 RENDER_OPTIONS_COMMENT +- `CUSTOM_URL_SCHEMES`: 使用逗號分隔的列表(ftp、git、svn)來指示要在 Markdown 中呈現的附加 URL 超鏈接。 + 以 http 和 https 開頭的 URL 始終顯示。 + 如果此條目為空,則允許所有 URL 方案。 +- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 應呈現/編輯為 Markdown 的文件擴展名列表。使用逗號分隔擴展名。要將沒有任何擴展名的文件呈現為 Markdown,請只需放置一個逗號。 +- `ENABLE_MATH`: **true**: 啟用對`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作為數學塊的檢測。 +- `MATH_CODE_BLOCK_DETECTION`: **inline-dollar,block-dollar**: 啟用數學程式碼塊檢測的分隔符。 + 設定為 "none" 以禁用全部,或使用逗號分隔的列表:inline-dollar, inline-parentheses, block-dollar, block-square-brackets。 + 預設值遵循 GitHub 的行為。 -## 服务器 (`server`) + +## 伺服器 (`server`) -- `APP_DATA_PATH`: **_`AppWorkPath`_/data**: 这是存储数据的默认根路径。 +- `APP_DATA_PATH`: **_`AppWorkPath`_/data**: 這是儲存資料的預設根路徑。 - `PROTOCOL`: **http**: \[http, https, fcgi, http+unix, fcgi+unix\] -- `USE_PROXY_PROTOCOL`: **false**: 在连接中预期`PROXY`协议头。 -- `PROXY_PROTOCOL_TLS_BRIDGING`: **false**: 协议为 https 时,在`TLS`协商后预期`PROXY`协议头。 -- `PROXY_PROTOCOL_HEADER_TIMEOUT`: **5s**: 等待`PROXY`协议头的超时时间(设置为`0`表示没有超时)。 -- `PROXY_PROTOCOL_ACCEPT_UNKNOWN`: **false**:接受带有未知类型的`PROXY`协议头。 -- `DOMAIN`: **localhost**: 此服务器的域名。 +- `USE_PROXY_PROTOCOL`: **false**: 在連接中預期`PROXY`協議頭。 +- `PROXY_PROTOCOL_TLS_BRIDGING`: **false**: 協議為 https 時,在`TLS`協商後預期`PROXY`協議頭。 +- `PROXY_PROTOCOL_HEADER_TIMEOUT`: **5s**: 等待`PROXY`協議頭的超時時間(設定為`0`表示沒有超時)。 +- `PROXY_PROTOCOL_ACCEPT_UNKNOWN`: **false**:接受帶有未知類型的`PROXY`協議頭。 +- `DOMAIN`: **localhost**: 此伺服器的域名。 - `ROOT_URL`: **`{PROTOCOL}://{DOMAIN}:{HTTP_PORT}/`**: - 覆盖自动生成的公共 URL。 - 这个选项用于内部 URL 和外部 URL 不匹配的情况(例如 Gitea 运行在反向代理后)。 + 覆蓋自動生成的公共 URL。 + 這個選項用於內部 URL 和外部 URL 不匹配的情況(例如 Gitea 運行在反向代理後)。 - `PUBLIC_URL_DETECTION`: **`legacy`**: 控制如何生成公共 URL。 - 虽然它的默认值是 "legacy"(避免影响老的用户),大多数实例都应当使用 "auto" 行为,尤其是 Gitea 实例需要在容器网络中被访问的场景。 - - "legacy": 当 "X-Forwarded-Proto" 请求头存在的时候,使用 "Host" 请求头生成公共 URL,否则使用 "ROOT_URL"。 - - "auto": 总是使用 "Host" 请求头生成公共 URL,如果 "X-Forwarded-Proto" 请求头存在也会使用它。如果没有 "Host" 请求头则使用 "ROOT_URL"。 - - "never": 总是使用 "ROOT_URL" 生成公共 URL,不从请求头进行检测。 + 雖然它的預設值是 "legacy"(避免影響老的使用者),大多數實例都應當使用 "auto" 行為,尤其是 Gitea 實例需要在容器網路中被訪問的場景。 + - "legacy": 當 "X-Forwarded-Proto" 請求頭存在的時候,使用 "Host" 請求頭生成公共 URL,否則使用 "ROOT_URL"。 + - "auto": 總是使用 "Host" 請求頭生成公共 URL,如果 "X-Forwarded-Proto" 請求頭存在也會使用它。如果沒有 "Host" 請求頭則使用 "ROOT_URL"。 + - "never": 總是使用 "ROOT_URL" 生成公共 URL,不從請求頭進行檢測。 - `STATIC_URL_PREFIX`: **_empty_**: - 覆盖此选项以从不同的 URL 请求静态资源。 - 这包括 CSS 文件、图片、JS 文件和 Web 字体。 - 头像图片是动态资源,仍由 Gitea 提供。 - 选项可以是不同的路径,例如`/static`, 也可以是另一个域,例如`https://cdn.example.com`. - 请求会变成 `{ROOT_URL}/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` - 静态文件位于 Gitea 源代码仓库的`public/`目录中。 - 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源,或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置,例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 + 覆蓋此選項以從不同的 URL 請求靜態資源。 + 這包括 CSS 文件、圖片、JS 文件和 Web 字體。 + 頭像圖片是動態資源,仍由 Gitea 提供。 + 選項可以是不同的路徑,例如`/static`, 也可以是另一個域,例如`https://cdn.example.com`. + 請求會變成 `{ROOT_URL}/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` + 靜態文件位於 Gitea 源程式碼儲存庫的`public/`目錄中。 + 您可以將`STATIC_URL_PREFIX`請求代理到 Gitea 伺服器以提供靜態資源,或者將手動構建的 Gitea 資源從 `$GITEA_BUILD/public`複製到靜態位置,例如`/var/www/assets`。確保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 -- `HTTP_ADDR`: **0.0.0.0**: HTTP 监听地址。 - - 如果 `PROTOCOL` 设置为 `fcgi`,Gitea 将在由 - `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - - 如果 `PROTOCOL` 设置为 `http+unix` 或 `fcgi+unix`,则应该是要使用的 Unix 套接字文件的名称。相对路径将相对于 _`AppWorkPath`_ 被转换为绝对路径。 -- `HTTP_PORT`: **3000**: HTTP 监听端口。 - - 如果 `PROTOCOL` 设置为 `fcgi`,Gitea 将在由 `HTTP_ADDR` 和 `HTTP_PORT` - 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 -- `UNIX_SOCKET_PERMISSION`: **666**: Unix 套接字的权限。 +- `HTTP_ADDR`: **0.0.0.0**: HTTP 監聽地址。 + - 如果 `PROTOCOL` 設定為 `fcgi`,Gitea 將在由 + `HTTP_ADDR` 和 `HTTP_PORT` 設定設定定義的 TCP 套接字上監聽 FastCGI 請求。 + - 如果 `PROTOCOL` 設定為 `http+unix` 或 `fcgi+unix`,則應該是要使用的 Unix 套接字文件的名稱。相對路徑將相對於 _`AppWorkPath`_ 被轉換為絕對路徑。 +- `HTTP_PORT`: **3000**: HTTP 監聽端口。 + - 如果 `PROTOCOL` 設定為 `fcgi`,Gitea 將在由 `HTTP_ADDR` 和 `HTTP_PORT` + 設定設定定義的 TCP 套接字上監聽 FastCGI 請求。 +- `UNIX_SOCKET_PERMISSION`: **666**: Unix 套接字的權限。 - `LOCAL_ROOT_URL`: **`{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`**: - 用于访问网络服务的 Gitea 工作器(例如 SSH 更新)的本地(DMZ)URL。 - 在大多数情况下,您不需要更改默认值。 - 仅在您的 SSH 服务器节点与 HTTP 节点不同的情况下才修改它。对于不同的协议,默认值不同。如果 `PROTOCOL` - 是 `http+unix`,则默认值为 `http://unix/`。如果 `PROTOCOL` 是 `fcgi` 或 `fcgi+unix`,则默认值为 - `{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`。如果监听在 `0.0.0.0`,则默认值为 + 用於訪問網路服務的 Gitea 工作器(例如 SSH 更新)的本地(DMZ)URL。 + 在大多數情況下,您不需要更改預設值。 + 僅在您的 SSH 伺服器節點與 HTTP 節點不同的情況下才修改它。對於不同的協議,預設值不同。如果 `PROTOCOL` + 是 `http+unix`,則預設值為 `http://unix/`。如果 `PROTOCOL` 是 `fcgi` 或 `fcgi+unix`,則預設值為 + `{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`。如果監聽在 `0.0.0.0`,則預設值為 `{PROTOCOL}://localhost:{HTTP_PORT}/`, - 否则默认值为 `{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`。 -- `LOCAL_USE_PROXY_PROTOCOL`: **`{USE_PROXY_PROTOCOL}`**: 在进行本地连接时传递 PROXY 协议头。 - 如果本地连接将经过代理,请将其设置为 false。 -- `PER_WRITE_TIMEOUT`: **30s**: 连接的任何写操作的超时时间。(将其设置为 -1 - 以禁用所有超时。) -- `PER_WRITE_PER_KB_TIMEOUT`: **10s**: 连接每写入 1 KB 的超时时间。 -- `DISABLE_SSH`: **false**: 当 SSH 不可用时禁用 SSH 功能。 -- `START_SSH_SERVER`: **false**: 启用时,使用内置的 SSH 服务器。 -- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置 SSH 服务器建立连接时,期望 PROXY 协议头。 -- `BUILTIN_SSH_SERVER_USER`: **`{RUN_USER}`**: 用于内置 SSH 服务器的用户名。 -- `SSH_USER`: **BUILTIN_SSH_SERVER_USER**: 在克隆 URL 中显示的 SSH 用户名。 - 如果设置为 `(DOER_USERNAME)`,将使用当前登录用户名作为克隆用的 SSH 用户名。 - 此配置项仅为自己配置 SSH 反向代理的高级用户准备, - 大多数用户应当把它留空,或者按需修改 `BUILTIN_SSH_SERVER_USER`。 -- `SSH_DOMAIN`: **`{DOMAIN}`**: 此服务器的域名,用于显示的克隆 URL。 -- `SSH_PORT`: **22**: 显示在克隆 URL 中的 SSH 端口。 -- `SSH_LISTEN_HOST`: **0.0.0.0**: 内置 SSH 服务器的监听地址。 -- `SSH_LISTEN_PORT`: **`{SSH_PORT}`**: 内置 SSH 服务器的端口。 -- `SSH_ROOT_PATH`: **~/.ssh**: SSH 目录的根路径。 -- `SSH_CREATE_AUTHORIZED_KEYS_FILE`: **true**: 当 Gitea 不使用内置 SSH 服务器时,默认情况下 Gitea 会创建一个 authorized_keys 文件。如果您打算使用 AuthorizedKeysCommand 功能,您应该关闭此选项。 -- `SSH_AUTHORIZED_KEYS_BACKUP`: **false**: 在重写所有密钥时启用 SSH 授权密钥备份,默认值为 false。 -- `SSH_TRUSTED_USER_CA_KEYS`: **_empty_**: 指定信任的证书颁发机构的公钥,用于对用户证书进行身份验证。多个密钥应以逗号分隔。例如 `ssh- ` 或 `ssh- , ssh- `。有关详细信息,请参阅 `sshd` 配置手册中的 `TrustedUserCAKeys` 部分。当为空时,不会创建文件,并且 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 默认为 `off`。 -- `SSH_TRUSTED_USER_CA_KEYS_FILENAME`: **`RUN_USER`/.ssh/gitea-trusted-user-ca-keys.pem**: Gitea 将管理的 `TrustedUserCaKeys` 文件的绝对路径。如果您正在运行自己的 SSH 服务器,并且想要使用 Gitea 管理的文件,您还需要修改您的 `sshd_config` 来指向此文件。官方的 Docker 映像将自动工作,无需进一步配置。 -- `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** 或 **username, email**: \[off, username, email, anything\]:指定允许用户用作 principal 的值。当设置为 `anything` 时,对 principal 字符串不执行任何检查。当设置为 `off` 时,不允许设置授权的 principal。 -- `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: 当 Gitea 不使用内置 SSH 服务器且 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不为 `off` 时,默认情况下 Gitea 会创建一个 authorized_principals 文件。 -- `SSH_AUTHORIZED_PRINCIPALS_BACKUP`: **false/true**: 在重写所有密钥时启用 SSH 授权 principal 备份,默认值为 true(如果 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不为 `off`)。 -- `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **`{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}`**: 设置用于传递授权密钥的命令模板。可能的密钥是:AppPath、AppWorkPath、CustomConf、CustomPath、Key,其中 Key 是 `models/asymkey.PublicKey`,其他是 shellquoted 字符串。 -- `SSH_SERVER_CIPHERS`: **chacha20-poly1305@openssh.com, aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, aes256-gcm@openssh.com**: 对于内置的 SSH 服务器,选择支持的 SSH 连接的加密方法,对于系统 SSH,此设置无效。 -- `SSH_SERVER_KEY_EXCHANGES`: **curve25519-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha256, diffie-hellman-group14-sha1**: 对于内置 SSH 服务器,选择支持的 SSH 连接的密钥交换算法,对于系统 SSH,此设置无效。 -- `SSH_SERVER_MACS`: **hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1**: 对于内置 SSH 服务器,选择支持的 SSH 连接的 MAC 算法,对于系统 SSH,此设置无效。 -- `SSH_SERVER_HOST_KEYS`: **ssh/gitea.rsa, ssh/gogs.rsa**: 对于内置 SSH 服务器,选择要提供为主机密钥的密钥对。私钥应在 `SSH_SERVER_HOST_KEY` 中,公钥在 `SSH_SERVER_HOST_KEY.pub` 中。相对路径会相对于 `APP_DATA_PATH` 转为绝对路径。如果不存在密钥,将为您创建一个 4096 位的 RSA 密钥。 -- `SSH_KEY_TEST_PATH`: **/tmp**: 在使用 `ssh-keygen` 测试公共 SSH 密钥时要在其中创建临时文件的目录,默认为系统临时目录。 -- `SSH_KEYGEN_PATH`: **_empty_**: 使用 `ssh-keygen` 解析公共 SSH 密钥。该值将传递给 shell。默认情况下,Gitea 会自行进行解析。 -- `SSH_EXPOSE_ANONYMOUS`: **false**: 启用将 SSH 克隆 URL 暴露给匿名访问者,默认为 false。 -- `SSH_PER_WRITE_TIMEOUT`: **30s**: 对 SSH 连接的任何写入设置超时。(将其设置为 -1 可以禁用所有超时。) -- `SSH_PER_WRITE_PER_KB_TIMEOUT`: **10s**: 对写入 SSH 连接的每 KB 设置超时。 -- `MINIMUM_KEY_SIZE_CHECK`: **true**: 指示是否检查最小密钥大小与相应类型。 -- `OFFLINE_MODE`: **true**: 禁用 CDN 用于静态文件和 Gravatar 用于个人资料图片。 -- `CERT_FILE`: **https/cert.pem**: 用于 HTTPS 的证书文件路径。在链接时,服务器证书必须首先出现,然后是中间 CA 证书(如果有)。如果 `ENABLE_ACME=true`,则此设置会被忽略。路径相对于 `CUSTOM_PATH`。 -- `KEY_FILE`: **https/key.pem**: 用于 HTTPS 的密钥文件路径。如果 `ENABLE_ACME=true`,则此设置会被忽略。路径相对于 `CUSTOM_PATH`。 -- `STATIC_ROOT_PATH`: **_`StaticRootPath`_**: 模板和静态文件路径的上一级。 -- `APP_DATA_PATH`: **data**(在 Docker 上为 **/data/gitea**):应用程序数据的默认路径。相对路径会相对于 _`AppWorkPath`_ 转为绝对路径。 -- `STATIC_CACHE_TIME`: **6h**: 对 `custom/`、`public/` 和所有上传的头像的静态资源的 Web 浏览器缓存时间。请注意,在 `RUN_MODE` 为 "dev" 时,此缓存会被禁用。 -- `ENABLE_GZIP`: **false**: 为运行时生成的内容启用 gzip 压缩,静态资源除外。 -- `ENABLE_PPROF`: **false**: 应用程序分析(内存和 CPU)。对于 "web" 命令,它会在 `localhost:6060` 上监听。对于 "serv" 命令,它会将数据转储到磁盘上的 `PPROF_DATA_PATH` 中,文件名为 `(cpuprofile|memprofile)__`。 -- `PPROF_DATA_PATH`: **_`AppWorkPath`_/data/tmp/pprof**: `PPROF_DATA_PATH`,当您将 Gitea 作为服务启动时,请使用绝对路径。 -- `LANDING_PAGE`: **home**: 未经身份验证用户的登录页面 \[home, explore, organizations, login, **custom**]。其中 custom 可以是任何 URL,例如 "/org/repo" 或甚至是 `https://anotherwebsite.com`。 -- `LFS_START_SERVER`: **false**: 启用 Git LFS 支持。 -- `LFS_ALLOW_PURE_SSH`: **false**: 启用 Git LFS 纯 SSH 协议支持。当前默认禁用,参见 [Git LFS 支持](administration/git-lfs-support.md)。 -- `LFS_CONTENT_PATH`: **`{APP_DATA_PATH}/lfs`**: 默认的 LFS 内容路径(如果它在本地存储中)。**已弃用**,请使用 `[lfs]` 中的设置。 -- `LFS_JWT_SECRET`: **_empty_**: LFS 身份验证密钥,将其更改为唯一的字符串。你可以通过 Gitea 子命令来生成此字符串。转到 [Command Line](administration/command-line.md#generate)。 -- `LFS_JWT_SECRET_URI`: **_empty_**: 代替在配置中定义 LFS_JWT_SECRET,可以使用此配置选项为 Gitea 提供包含密钥的文件的路径(示例值:`file:/etc/gitea/lfs_jwt_secret`)。 -- `LFS_HTTP_AUTH_EXPIRY`: **24h**: LFS 身份验证的有效期,以 time.Duration 表示,超过此期限的推送可能会失败。 -- `LFS_MAX_FILE_SIZE`: **0**: 允许的最大 LFS 文件大小(以字节为单位,设置为 0 为无限制)。 -- `LFS_LOCKS_PAGING_NUM`: **50**: 每页返回的最大 LFS 锁定数。 -- `LFS_MAX_BATCH_SIZE`: **0**: 客户端可通过 LFS 批量 API 请求的最大 LFS 指针数量。零为默认行为,允许任意大小的批量请求。 -- `REDIRECT_OTHER_PORT`: **false**: 如果为 true 并且 `PROTOCOL` 为 https,则允许将 http 请求重定向到 Gitea 监听的 https 端口的 `PORT_TO_REDIRECT`。 -- `REDIRECTOR_USE_PROXY_PROTOCOL`: **`{USE_PROXY_PROTOCOL}`**: 在连接到 https 重定向器时,需要 PROXY 协议头。 -- `PORT_TO_REDIRECT`: **80**: http 重定向服务监听的端口。当 `REDIRECT_OTHER_PORT` 为 true 时使用。 -- `SSL_MIN_VERSION`: **TLSv1.2**: 设置最低支持的 SSL 版本。 -- `SSL_MAX_VERSION`: **_empty_**: 设置最大支持的 SSL 版本。 -- `SSL_CURVE_PREFERENCES`: **X25519,P256**: 设置首选的曲线。 -- `SSL_CIPHER_SUITES`: **ecdhe_ecdsa_with_aes_256_gcm_sha384,ecdhe_rsa_with_aes_256_gcm_sha384,ecdhe_ecdsa_with_aes_128_gcm_sha256,ecdhe_rsa_with_aes_128_gcm_sha256,ecdhe_ecdsa_with_chacha20_poly1305,ecdhe_rsa_with_chacha20_poly1305**: 设置首选的密码套件。 - - 如果没有对 AES 套件的硬件支持,默认情况下,ChaCha 套件将优先于 AES 套件。 - - 根据 Go 1.18 的支持的套件有: + 否則預設值為 `{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`。 +- `LOCAL_USE_PROXY_PROTOCOL`: **`{USE_PROXY_PROTOCOL}`**: 在進行本地連接時傳遞 PROXY 協議頭。 + 如果本地連接將經過代理,請將其設定為 false。 +- `PER_WRITE_TIMEOUT`: **30s**: 連接的任何寫操作的超時時間。(將其設定為 -1 + 以禁用所有超時。) +- `PER_WRITE_PER_KB_TIMEOUT`: **10s**: 連接每寫入 1 KB 的超時時間。 +- `DISABLE_SSH`: **false**: 當 SSH 不可用時禁用 SSH 功能。 +- `START_SSH_SERVER`: **false**: 啟用時,使用內置的 SSH 伺服器。 +- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在與內置 SSH 伺服器建立連接時,期望 PROXY 協議頭。 +- `BUILTIN_SSH_SERVER_USER`: **`{RUN_USER}`**: 用於內置 SSH 伺服器的使用者名稱。 +- `SSH_USER`: **BUILTIN_SSH_SERVER_USER**: 在克隆 URL 中顯示的 SSH 使用者名稱。 + 如果設定為 `(DOER_USERNAME)`,將使用當前登入使用者名稱作為克隆用的 SSH 使用者名稱。 + 此設定項僅為自己設定 SSH 反向代理的高級使用者準備, + 大多數使用者應當把它留空,或者按需修改 `BUILTIN_SSH_SERVER_USER`。 +- `SSH_DOMAIN`: **`{DOMAIN}`**: 此伺服器的域名,用於顯示的克隆 URL。 +- `SSH_PORT`: **22**: 顯示在克隆 URL 中的 SSH 端口。 +- `SSH_LISTEN_HOST`: **0.0.0.0**: 內置 SSH 伺服器的監聽地址。 +- `SSH_LISTEN_PORT`: **`{SSH_PORT}`**: 內置 SSH 伺服器的端口。 +- `SSH_ROOT_PATH`: **~/.ssh**: SSH 目錄的根路徑。 +- `SSH_CREATE_AUTHORIZED_KEYS_FILE`: **true**: 當 Gitea 不使用內置 SSH 伺服器時,預設情況下 Gitea 會建立一個 authorized_keys 文件。如果您打算使用 AuthorizedKeysCommand 功能,您應該關閉此選項。 +- `SSH_AUTHORIZED_KEYS_BACKUP`: **false**: 在重寫所有密鑰時啟用 SSH 授權密鑰備份,預設值為 false。 +- `SSH_TRUSTED_USER_CA_KEYS`: **_empty_**: 指定信任的證書頒發機構的公鑰,用於對使用者證書進行身份驗證。多個密鑰應以逗號分隔。例如 `ssh- ` 或 `ssh- , ssh- `。有關詳細資訊,請參閱 `sshd` 設定手冊中的 `TrustedUserCAKeys` 部分。當為空時,不會建立文件,並且 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 預設為 `off`。 +- `SSH_TRUSTED_USER_CA_KEYS_FILENAME`: **`RUN_USER`/.ssh/gitea-trusted-user-ca-keys.pem**: Gitea 將管理的 `TrustedUserCaKeys` 文件的絕對路徑。如果您正在運行自己的 SSH 伺服器,並且想要使用 Gitea 管理的文件,您還需要修改您的 `sshd_config` 來指向此文件。官方的 Docker 映像將自動工作,無需進一步設定。 +- `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** 或 **username, email**: \[off, username, email, anything\]:指定允許使用者用作 principal 的值。當設定為 `anything` 時,對 principal 字符串不執行任何檢查。當設定為 `off` 時,不允許設定授權的 principal。 +- `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: 當 Gitea 不使用內置 SSH 伺服器且 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不為 `off` 時,預設情況下 Gitea 會建立一個 authorized_principals 文件。 +- `SSH_AUTHORIZED_PRINCIPALS_BACKUP`: **false/true**: 在重寫所有密鑰時啟用 SSH 授權 principal 備份,預設值為 true(如果 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不為 `off`)。 +- `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **`{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}`**: 設定用於傳遞授權密鑰的命令模板。可能的密鑰是:AppPath、AppWorkPath、CustomConf、CustomPath、Key,其中 Key 是 `models/asymkey.PublicKey`,其他是 shellquoted 字符串。 +- `SSH_SERVER_CIPHERS`: **chacha20-poly1305@openssh.com, aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, aes256-gcm@openssh.com**: 對於內置的 SSH 伺服器,選擇支援的 SSH 連接的加密方法,對於系統 SSH,此設定無效。 +- `SSH_SERVER_KEY_EXCHANGES`: **curve25519-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha256, diffie-hellman-group14-sha1**: 對於內置 SSH 伺服器,選擇支援的 SSH 連接的密鑰交換算法,對於系統 SSH,此設定無效。 +- `SSH_SERVER_MACS`: **hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1**: 對於內置 SSH 伺服器,選擇支援的 SSH 連接的 MAC 算法,對於系統 SSH,此設定無效。 +- `SSH_SERVER_HOST_KEYS`: **ssh/gitea.rsa, ssh/gogs.rsa**: 對於內置 SSH 伺服器,選擇要提供為主機密鑰的密鑰對。私鑰應在 `SSH_SERVER_HOST_KEY` 中,公鑰在 `SSH_SERVER_HOST_KEY.pub` 中。相對路徑會相對於 `APP_DATA_PATH` 轉為絕對路徑。如果不存在密鑰,將為您建立一個 4096 位的 RSA 密鑰。 +- `SSH_KEY_TEST_PATH`: **/tmp**: 在使用 `ssh-keygen` 測試公共 SSH 密鑰時要在其中建立臨時文件的目錄,預設為系統臨時目錄。 +- `SSH_KEYGEN_PATH`: **_empty_**: 使用 `ssh-keygen` 解析公共 SSH 密鑰。該值將傳遞給 shell。預設情況下,Gitea 會自行進行解析。 +- `SSH_EXPOSE_ANONYMOUS`: **false**: 啟用將 SSH 克隆 URL 暴露給匿名訪問者,預設為 false。 +- `SSH_PER_WRITE_TIMEOUT`: **30s**: 對 SSH 連接的任何寫入設定超時。(將其設定為 -1 可以禁用所有超時。) +- `SSH_PER_WRITE_PER_KB_TIMEOUT`: **10s**: 對寫入 SSH 連接的每 KB 設定超時。 +- `MINIMUM_KEY_SIZE_CHECK`: **true**: 指示是否檢查最小密鑰大小與相應類型。 +- `OFFLINE_MODE`: **true**: 禁用 CDN 用於靜態文件和 Gravatar 用於個人資料圖片。 +- `CERT_FILE`: **https/cert.pem**: 用於 HTTPS 的證書文件路徑。在鏈接時,伺服器證書必須首先出現,然後是中間 CA 證書(如果有)。如果 `ENABLE_ACME=true`,則此設定會被忽略。路徑相對於 `CUSTOM_PATH`。 +- `KEY_FILE`: **https/key.pem**: 用於 HTTPS 的密鑰文件路徑。如果 `ENABLE_ACME=true`,則此設定會被忽略。路徑相對於 `CUSTOM_PATH`。 +- `STATIC_ROOT_PATH`: **_`StaticRootPath`_**: 模板和靜態文件路徑的上一級。 +- `APP_DATA_PATH`: **data**(在 Docker 上為 **/data/gitea**):應用程式資料的預設路徑。相對路徑會相對於 _`AppWorkPath`_ 轉為絕對路徑。 +- `STATIC_CACHE_TIME`: **6h**: 對 `custom/`、`public/` 和所有上傳的頭像的靜態資源的 Web 瀏覽器緩存時間。請注意,在 `RUN_MODE` 為 "dev" 時,此緩存會被禁用。 +- `ENABLE_GZIP`: **false**: 為運行時生成的內容啟用 gzip 壓縮,靜態資源除外。 +- `ENABLE_PPROF`: **false**: 應用程式分析(內存和 CPU)。對於 "web" 命令,它會在 `localhost:6060` 上監聽。對於 "serv" 命令,它會將資料轉儲到磁盤上的 `PPROF_DATA_PATH` 中,文件名為 `(cpuprofile|memprofile)__`。 +- `PPROF_DATA_PATH`: **_`AppWorkPath`_/data/tmp/pprof**: `PPROF_DATA_PATH`,當您將 Gitea 作為服務啟動時,請使用絕對路徑。 +- `LANDING_PAGE`: **home**: 未經身份驗證使用者的登入頁面 \[home, explore, organizations, login, **custom**]。其中 custom 可以是任何 URL,例如 "/org/repo" 或甚至是 `https://anotherwebsite.com`。 +- `LFS_START_SERVER`: **false**: 啟用 Git LFS 支援。 +- `LFS_ALLOW_PURE_SSH`: **false**: 啟用 Git LFS 純 SSH 協議支援。當前預設禁用,參見 [Git LFS 支援](administration/git-lfs-support.md)。 +- `LFS_CONTENT_PATH`: **`{APP_DATA_PATH}/lfs`**: 預設的 LFS 內容路徑(如果它在本地儲存中)。**已棄用**,請使用 `[lfs]` 中的設定。 +- `LFS_JWT_SECRET`: **_empty_**: LFS 身份驗證密鑰,將其更改為唯一的字符串。你可以透過 Gitea 子命令來生成此字符串。轉到 [Command Line](administration/command-line.md#generate)。 +- `LFS_JWT_SECRET_URI`: **_empty_**: 代替在設定中定義 LFS_JWT_SECRET,可以使用此設定選項為 Gitea 提供包含密鑰的文件的路徑(範例值:`file:/etc/gitea/lfs_jwt_secret`)。 +- `LFS_HTTP_AUTH_EXPIRY`: **24h**: LFS 身份驗證的有效期,以 time.Duration 表示,超過此期限的推送可能會失敗。 +- `LFS_MAX_FILE_SIZE`: **0**: 允許的最大 LFS 文件大小(以位元組為單位,設定為 0 為無限制)。 +- `LFS_LOCKS_PAGING_NUM`: **50**: 每頁返回的最大 LFS 鎖定數。 +- `LFS_MAX_BATCH_SIZE`: **0**: 客戶端可通過 LFS 批量 API 請求的最大 LFS 指針數量。零為預設行為,允許任意大小的批量請求。 +- `REDIRECT_OTHER_PORT`: **false**: 如果為 true 並且 `PROTOCOL` 為 https,則允許將 http 請求重定向到 Gitea 監聽的 https 端口的 `PORT_TO_REDIRECT`。 +- `REDIRECTOR_USE_PROXY_PROTOCOL`: **`{USE_PROXY_PROTOCOL}`**: 在連接到 https 重定向器時,需要 PROXY 協議頭。 +- `PORT_TO_REDIRECT`: **80**: http 重定向服務監聽的端口。當 `REDIRECT_OTHER_PORT` 為 true 時使用。 +- `SSL_MIN_VERSION`: **TLSv1.2**: 設定最低支援的 SSL 版本。 +- `SSL_MAX_VERSION`: **_empty_**: 設定最大支援的 SSL 版本。 +- `SSL_CURVE_PREFERENCES`: **X25519,P256**: 設定首選的曲線。 +- `SSL_CIPHER_SUITES`: **ecdhe_ecdsa_with_aes_256_gcm_sha384,ecdhe_rsa_with_aes_256_gcm_sha384,ecdhe_ecdsa_with_aes_128_gcm_sha256,ecdhe_rsa_with_aes_128_gcm_sha256,ecdhe_ecdsa_with_chacha20_poly1305,ecdhe_rsa_with_chacha20_poly1305**: 設定首選的密碼套件。 + - 如果沒有對 AES 套件的硬件支援,預設情況下,ChaCha 套件將優先於 AES 套件。 + - 根據 Go 1.18 的支援的套件有: - TLS 1.0 - 1.2 套件 - "rsa_with_rc4_128_sha" - "rsa_with_3des_ede_cbc_sha" @@ -429,89 +432,89 @@ aliases: - "aes_128_gcm_sha256" - "aes_256_gcm_sha384" - "chacha20_poly1305_sha256" - - 别名 - - "ecdhe_rsa_with_chacha20_poly1305" 是 "ecdhe_rsa_with_chacha20_poly1305_sha256" 的别名 - - "ecdhe_ecdsa_with_chacha20_poly1305" 是 "ecdhe_ecdsa_with_chacha20_poly1305_sha256" 的别名 -- `ENABLE_ACME`: **false**: 通过 ACME 能力的证书颁发机构(CA)服务器(默认为 Let's Encrypt)启用自动证书管理的标志。如果启用,将忽略 `CERT_FILE` 和 `KEY_FILE`,并且 CA 必须将 `DOMAIN` 解析为此 Gitea 服务器。确保设置了 DNS 记录,并且端口 `80` 或端口 `443` 可以被 CA 服务器访问(默认情况下是公共互联网),并重定向到相应的端口 `PORT_TO_REDIRECT` 或 `HTTP_PORT`。 -- `ACME_URL`: **_empty_**: CA 的 ACME 目录 URL,例如自托管的 [smallstep CA 服务器](https://github.com/smallstep/certificates),它可以是 `https://ca.example.com/acme/acme/directory`。如果留空,默认使用 Let's Encrypt 的生产 CA(还要检查 `LETSENCRYPT_ACCEPTTOS`)。 -- `ACME_ACCEPTTOS`: **false**: 这是一个明确的检查,您是否接受 ACME 提供者的服务条款。默认为 Let's Encrypt 的 [服务条款](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf)。 -- `ACME_DIRECTORY`: **https**: 证书管理器用于缓存证书和私钥等信息的目录。 -- `ACME_EMAIL`: **_empty_**: 用于 ACME 注册的电子邮件。通常用于通知有关已颁发的证书的问题。 -- `ACME_CA_ROOT`: **_empty_**: CA 的根证书。如果留空,默认使用系统的信任链。 -- `ALLOW_GRACEFUL_RESTARTS`: **true**: 在 SIGHUP 时执行优雅重启。 -- `GRACEFUL_HAMMER_TIME`: **60s**: 在重新启动后,父进程将停止接受新连接,并允许请求在停止之前完成。如果耗时超过此时间,则会强制关闭关闭。 -- `STARTUP_TIMEOUT`: **0**: 如果启动超过提供的时间,将关闭服务器。在 Windows 上设置这将向 SVC 主机发送一个等待提示,告诉 SVC 主机启动可能需要一些时间。请注意,启动由监听器(HTTP/HTTPS/SSH)的打开来确定。索引程序可能需要更长时间启动,可能具有自己的超时时间。 + - 別名 + - "ecdhe_rsa_with_chacha20_poly1305" 是 "ecdhe_rsa_with_chacha20_poly1305_sha256" 的別名 + - "ecdhe_ecdsa_with_chacha20_poly1305" 是 "ecdhe_ecdsa_with_chacha20_poly1305_sha256" 的別名 +- `ENABLE_ACME`: **false**: 通過 ACME 能力的證書頒發機構(CA)伺服器(預設為 Let's Encrypt)啟用自動證書管理的標誌。如果啟用,將忽略 `CERT_FILE` 和 `KEY_FILE`,並且 CA 必須將 `DOMAIN` 解析為此 Gitea 伺服器。確保設定了 DNS 記錄,並且端口 `80` 或端口 `443` 可以被 CA 伺服器訪問(預設情況下是公共互聯網),並重定向到相應的端口 `PORT_TO_REDIRECT` 或 `HTTP_PORT`。 +- `ACME_URL`: **_empty_**: CA 的 ACME 目錄 URL,例如自託管的 [smallstep CA 伺服器](https://github.com/smallstep/certificates),它可以是 `https://ca.example.com/acme/acme/directory`。如果留空,預設使用 Let's Encrypt 的生產 CA(還要檢查 `LETSENCRYPT_ACCEPTTOS`)。 +- `ACME_ACCEPTTOS`: **false**: 這是一個明確的檢查,您是否接受 ACME 提供者的服務條款。預設為 Let's Encrypt 的 [服務條款](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf)。 +- `ACME_DIRECTORY`: **https**: 證書管理器用於緩存證書和私鑰等資訊的目錄。 +- `ACME_EMAIL`: **_empty_**: 用於 ACME 註冊的電子郵件。通常用於通知有關已頒發的證書的問題。 +- `ACME_CA_ROOT`: **_empty_**: CA 的根證書。如果留空,預設使用系統的信任鏈。 +- `ALLOW_GRACEFUL_RESTARTS`: **true**: 在 SIGHUP 時執行優雅重啟。 +- `GRACEFUL_HAMMER_TIME`: **60s**: 在重新啟動後,父進程將停止接受新連接,並允許請求在停止之前完成。如果耗時超過此時間,則會強制關閉關閉。 +- `STARTUP_TIMEOUT`: **0**: 如果啟動超過提供的時間,將關閉伺服器。在 Windows 上設定這將向 SVC 主機發送一個等待提示,告訴 SVC 主機啟動可能需要一些時間。請注意,啟動由監聽器(HTTP/HTTPS/SSH)的打開來確定。索引程式可能需要更長時間啟動,可能具有自己的超時時間。 -## 数据库 (`database`) +## 資料庫 (`database`) -- `DB_TYPE`: **mysql**: 数据库类型 \[mysql, postgres, mssql, sqlite3\]。 -- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或 unix 套接字的绝对路径 \[mysql, postgres\](例如:/var/run/mysqld/mysqld.sock)。 -- `NAME`: **gitea**: 数据库名称。 -- `USER`: **root**: 数据库用户名。 -- `PASSWD`: **_empty_**: 数据库密码。如果密码包含特殊字符,请使用 \`your password\` 或 """your password"""。 -- `CHARSET_COLLATION`: **_empty_**:(仅限 MySQL/MSSQL)Gitea 期望使用区分大小写的排序规则。留空以使用 Gitea 决定的默认排序规则。除非您明确知道需要什么,否则不要更改它。 -- `SCHEMA`: **_empty_**: 对于 PostgreSQL,如果与 "public" 不同的模式。模式必须事先存在,用户必须对其具有创建特权,并且用户搜索路径必须设置为首先查找模式(例如 `ALTER USER user SET SEARCH_PATH = schema_name,"$user",public;`)。 -- `SSL_MODE`: **disable**: MySQL 或 PostgreSQL 数据库是否启用 SSL 模式,仅适用于 MySQL 和 PostgreSQL。 +- `DB_TYPE`: **mysql**: 資料庫類型 \[mysql, postgres, mssql, sqlite3\]。 +- `HOST`: **127.0.0.1:3306**: 資料庫主機地址和端口或 unix 套接字的絕對路徑 \[mysql, postgres\](例如:/var/run/mysqld/mysqld.sock)。 +- `NAME`: **gitea**: 資料庫名稱。 +- `USER`: **root**: 資料庫使用者名稱。 +- `PASSWD`: **_empty_**: 資料庫密碼。如果密碼包含特殊字符,請使用 \`your password\` 或 """your password"""。 +- `CHARSET_COLLATION`: **_empty_**:(僅限 MySQL/MSSQL)Gitea 期望使用區分大小寫的排序規則。留空以使用 Gitea 決定的預設排序規則。除非您明確知道需要什麼,否則不要更改它。 +- `SCHEMA`: **_empty_**: 對於 PostgreSQL,如果與 "public" 不同的模式。模式必須事先存在,使用者必須對其具有建立特權,並且使用者搜索路徑必須設定為首先查找模式(例如 `ALTER USER user SET SEARCH_PATH = schema_name,"$user",public;`)。 +- `SSL_MODE`: **disable**: MySQL 或 PostgreSQL 資料庫是否啟用 SSL 模式,僅適用於 MySQL 和 PostgreSQL。 - MySQL 的有效值: - - `true`:启用 TLS,并针对数据库服务器证书根证书进行验证。选择此选项时,请确保用于验证数据库服务器证书的根证书(例如 CA 证书)位于数据库服务器和 Gitea 服务器的系统证书存储中。有关如何将 CA 证书添加到证书存储的说明,请参阅系统文档。 + - `true`:啟用 TLS,並針對資料庫伺服器證書根證書進行驗證。選擇此選項時,請確保用於驗證資料庫伺服器證書的根證書(例如 CA 證書)位於資料庫伺服器和 Gitea 伺服器的系統證書儲存中。有關如何將 CA 證書添加到證書儲存的說明,請參閱系統文件。 - `false`:禁用 TLS。 - - `disable`:`false` 的别名,与 PostgreSQL 兼容。 - - `skip-verify`:启用 TLS,但不进行数据库服务器证书验证。如果数据库服务器上有自签名或无效证书,请使用此选项。 - - `prefer`:启用 TLS,并回退到非 TLS 连接。 + - `disable`:`false` 的別名,與 PostgreSQL 相容。 + - `skip-verify`:啟用 TLS,但不進行資料庫伺服器證書驗證。如果資料庫伺服器上有自簽名或無效證書,請使用此選項。 + - `prefer`:啟用 TLS,並回退到非 TLS 連接。 - PostgreSQL 的有效值: - `disable`:禁用 TLS。 - - `require`:启用 TLS,但不进行任何验证。 - - `verify-ca`:启用 TLS,并对数据库服务器证书进行根证书验证。 - - `verify-full`:启用 TLS,并验证数据库服务器名称是否与给定的证书的 "Common Name" 或 "Subject Alternative Name" 字段匹配。 -- `SQLITE_TIMEOUT`:**500**: 仅适用于 SQLite3 的查询超时。 -- `SQLITE_JOURNAL_MODE`:**""**: 更改 SQlite3 的日志模式。可以用于在高负载导致写入拥塞时启用 [WAL 模式](https://www.sqlite.org/wal.html)。有关可能的值,请参阅 [SQlite3 文档](https://www.sqlite.org/pragma.html#pragma_journal_mode)。默认为数据库文件的默认值,通常为 DELETE。 -- `ITERATE_BUFFER_SIZE`:**50**: 用于迭代的内部缓冲区大小。 -- `PATH`:**data/gitea.db**: 仅适用于 SQLite3 的数据库文件路径。 -- `LOG_SQL`:**false**: 记录已执行的 SQL。 -- `DB_RETRIES`:**10**: 允许多少次 ORM 初始化 / DB 连接尝试。 -- `DB_RETRY_BACKOFF`:**3s**: 如果发生故障,等待另一个 ORM 初始化 / DB 连接尝试的 time.Duration。 -- `MAX_OPEN_CONNS`:**0**: 数据库最大打开连接数 - 默认为 0,表示没有限制。 -- `MAX_IDLE_CONNS`:**2**: 连接池上的最大空闲数据库连接数,默认为 2 - 这将限制为 `MAX_OPEN_CONNS`。 -- `CONN_MAX_LIFETIME`:**0 或 3s**: 设置 DB 连接可以重用的最长时间 - 默认为 0,表示没有限制(除了 MySQL,其中为 3s - 请参见 #6804 和 #7071)。 -- `AUTO_MIGRATION`:**true**: 是否自动执行数据库模型迁移。 -- `SLOW_QUERY_THRESHOLD` **5s**: 超过此秒数阈值的查询执行时间将在 xorm 日志中记录为警告。 + - `require`:啟用 TLS,但不進行任何驗證。 + - `verify-ca`:啟用 TLS,並對資料庫伺服器證書進行根證書驗證。 + - `verify-full`:啟用 TLS,並驗證資料庫伺服器名稱是否與給定的證書的 "Common Name" 或 "Subject Alternative Name" 欄位匹配。 +- `SQLITE_TIMEOUT`:**500**: 僅適用於 SQLite3 的查詢超時。 +- `SQLITE_JOURNAL_MODE`:**""**: 更改 SQlite3 的日誌模式。可以用於在高負載導致寫入擁塞時啟用 [WAL 模式](https://www.sqlite.org/wal.html)。有關可能的值,請參閱 [SQlite3 文件](https://www.sqlite.org/pragma.html#pragma_journal_mode)。預設為資料庫文件的預設值,通常為 DELETE。 +- `ITERATE_BUFFER_SIZE`:**50**: 用於迭代的內部緩衝區大小。 +- `PATH`:**data/gitea.db**: 僅適用於 SQLite3 的資料庫文件路徑。 +- `LOG_SQL`:**false**: 記錄已執行的 SQL。 +- `DB_RETRIES`:**10**: 允許多少次 ORM 初始化 / DB 連接嘗試。 +- `DB_RETRY_BACKOFF`:**3s**: 如果發生故障,等待另一個 ORM 初始化 / DB 連接嘗試的 time.Duration。 +- `MAX_OPEN_CONNS`:**0**: 資料庫最大打開連接數 - 預設為 0,表示沒有限制。 +- `MAX_IDLE_CONNS`:**2**: 連接池上的最大空閒資料庫連接數,預設為 2 - 這將限制為 `MAX_OPEN_CONNS`。 +- `CONN_MAX_LIFETIME`:**0 或 3s**: 設定 DB 連接可以重用的最長時間 - 預設為 0,表示沒有限制(除了 MySQL,其中為 3s - 請參見 #6804 和 #7071)。 +- `AUTO_MIGRATION`:**true**: 是否自動執行資料庫模型遷移。 +- `SLOW_QUERY_THRESHOLD` **5s**: 超過此秒數閾值的查詢執行時間將在 xorm 日誌中記錄為警告。 -请参见 #8540 和 #8273 以获取有关 `MAX_OPEN_CONNS`、`MAX_IDLE_CONNS` 和 `CONN_MAX_LIFETIME` 的适当值及其与端口耗尽的关系的进一步讨论。 +請參見 #8540 和 #8273 以獲取有關 `MAX_OPEN_CONNS`、`MAX_IDLE_CONNS` 和 `CONN_MAX_LIFETIME` 的適當值及其與端口耗盡的關係的進一步討論。 ## 索引 (`indexer`) -- `ISSUE_INDEXER_TYPE`: **bleve**: 工单索引类型,当前支持:`bleve`、`db`、`elasticsearch`(也兼容 OpenSearch)或 `meilisearch`。 -- `ISSUE_INDEXER_CONN_STR`:\*\*\*\* : 工单索引连接字符串,仅适用于 elasticsearch 和 meilisearch(例如:`http://elastic:password@localhost:9200`)或者(例如:`http://:apikey@localhost:7700`)。 -- `ISSUE_INDEXER_NAME`:**gitea_issues**: 工单索引器名称,在 ISSUE_INDEXER_TYPE 为 elasticsearch 或 meilisearch 时可用。 -- `ISSUE_INDEXER_PATH`:**indexers/issues.bleve**: 用于工单搜索的索引文件;在 ISSUE*INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 *`AppWorkPath`\_ 进行绝对路径化。 +- `ISSUE_INDEXER_TYPE`: **bleve**: 工單索引類型,當前支援:`bleve`、`db`、`elasticsearch`(也相容 OpenSearch)或 `meilisearch`。 +- `ISSUE_INDEXER_CONN_STR`:\*\*\*\* : 工單索引連接字符串,僅適用於 elasticsearch 和 meilisearch(例如:`http://elastic:password@localhost:9200`)或者(例如:`http://:apikey@localhost:7700`)。 +- `ISSUE_INDEXER_NAME`:**gitea_issues**: 工單索引器名稱,在 ISSUE_INDEXER_TYPE 為 elasticsearch 或 meilisearch 時可用。 +- `ISSUE_INDEXER_PATH`:**indexers/issues.bleve**: 用於工單搜索的索引文件;在 ISSUE*INDEXER_TYPE 為 bleve 和 elasticsearch 時可用。相對路徑將相對於 *`AppWorkPath`\_ 進行絕對路徑化。 -- `REPO_INDEXER_ENABLED`:**false**: 启用代码搜索(占用大量磁盘空间,约为存储库大小的 6 倍)。 -- `REPO_INDEXER_REPO_TYPES`:**sources,forks,mirrors,templates**: 存储库索引器单元。要索引的项目可以是 `sources`、`forks`、`mirrors`、`templates` 或它们的任何组合,用逗号分隔。如果为空,则默认为仅 `sources`,如果要完全禁用,请参见 `REPO_INDEXER_ENABLED`。 -- `REPO_INDEXER_TYPE`:**bleve**: 代码搜索引擎类型,可以为 `bleve` 或者 `elasticsearch`(也兼容 OpenSearch)。 -- `REPO_INDEXER_PATH`:**indexers/repos.bleve**: 用于代码搜索的索引文件。 -- `REPO_INDEXER_CONN_STR`:\*\*\*\*: 代码索引器连接字符串,在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如:`http://elastic:password@localhost:9200` -- `REPO_INDEXER_NAME`:**gitea_codes**: 代码索引器名称,在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。 +- `REPO_INDEXER_ENABLED`:**false**: 啟用程式碼搜索(佔用大量磁盤空間,約為儲存庫大小的 6 倍)。 +- `REPO_INDEXER_REPO_TYPES`:**sources,forks,mirrors,templates**: 儲存庫索引器單元。要索引的專案可以是 `sources`、`forks`、`mirrors`、`templates` 或它們的任何組合,用逗號分隔。如果為空,則預設為僅 `sources`,如果要完全禁用,請參見 `REPO_INDEXER_ENABLED`。 +- `REPO_INDEXER_TYPE`:**bleve**: 程式碼搜索引擎類型,可以為 `bleve` 或者 `elasticsearch`(也相容 OpenSearch)。 +- `REPO_INDEXER_PATH`:**indexers/repos.bleve**: 用於程式碼搜索的索引文件。 +- `REPO_INDEXER_CONN_STR`:\*\*\*\*: 程式碼索引器連接字符串,在 `REPO_INDEXER_TYPE` 為 elasticsearch 時可用。例如:`http://elastic:password@localhost:9200` +- `REPO_INDEXER_NAME`:**gitea_codes**: 程式碼索引器名稱,在 `REPO_INDEXER_TYPE` 為 elasticsearch 時可用。 -- `REPO_INDEXER_INCLUDE`:**empty**: 逗号分隔的 glob 模式列表(参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob))以用于**包括**在索引中。使用 `**.txt` 匹配任何具有 .txt 扩展名的文件。空列表表示包括所有文件。 -- `REPO_INDEXER_EXCLUDE`:**empty**: 逗号分隔的 glob 模式列表(参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob))以用于**排除**在索引中。即使在 `REPO_INDEXER_INCLUDE` 中匹配,也不会索引与此列表匹配的文件。 -- `REPO_INDEXER_EXCLUDE_VENDORED`:**true**: 从索引中排除 vendored 文件。 -- `MAX_FILE_SIZE`:**1048576**: 要索引的文件的最大字节数。 -- `STARTUP_TIMEOUT`:**30s**: 如果索引器启动时间超过此超时时间 - 则失败。(此超时时间将添加到上面的锤子时间中,用于子进程 - 因为 bleve 不会在上一个父进程关闭之前启动)。设置为 -1 表示永不超时。 +- `REPO_INDEXER_INCLUDE`:**empty**: 逗號分隔的 glob 模式列表(參見 [https://github.com/gobwas/glob](https://github.com/gobwas/glob))以用於**包括**在索引中。使用 `**.txt` 匹配任何具有 .txt 擴展名的文件。空列表表示包括所有文件。 +- `REPO_INDEXER_EXCLUDE`:**empty**: 逗號分隔的 glob 模式列表(參見 [https://github.com/gobwas/glob](https://github.com/gobwas/glob))以用於**排除**在索引中。即使在 `REPO_INDEXER_INCLUDE` 中匹配,也不會索引與此列表匹配的文件。 +- `REPO_INDEXER_EXCLUDE_VENDORED`:**true**: 從索引中排除 vendored 文件。 +- `MAX_FILE_SIZE`:**1048576**: 要索引的文件的最大位元組數。 +- `STARTUP_TIMEOUT`:**30s**: 如果索引器啟動時間超過此超時時間 - 則失敗。(此超時時間將添加到上面的錘子時間中,用於子進程 - 因為 bleve 不會在上一個父進程關閉之前啟動)。設定為 -1 表示永不超時。 -## 队列 (`queue` and `queue.*`) +## 隊列 (`queue` and `queue.*`) -[queue] 配置在 `[queue.*]` 下为各个队列设置默认值,并允许为各个队列设置单独的配置覆盖。(不过请参见下文。) +[queue] 設定在 `[queue.*]` 下為各個隊列設定預設值,並允許為各個隊列設定單獨的設定覆蓋。(不過請參見下文。) -- `TYPE`:**level**: 通用队列类型,当前支持:`level`(在内部使用 LevelDB)、`channel`、`redis`、`dummy`。无效的类型将视为 `level`。 -- `DATADIR`:**queues/common**: 用于存储 level 队列的基本 DataDir。单独的队列的 `DATADIR` 可以在 `queue.name` 部分进行设置。相对路径将根据 `{APP_DATA_PATH}` 变为绝对路径。 -- `LENGTH`:**100000**: 通道队列阻塞之前的最大队列大小 -- `BATCH_LENGTH`:**20**: 在传递给处理程序之前批处理数据 -- `CONN_STR`:**redis://127.0.0.1:6379/0**: redis 队列类型的连接字符串。对于 `redis-cluster`,使用 `redis+cluster://127.0.0.1:6379/0`。可以使用查询参数来设置选项。类似地,LevelDB 选项也可以使用:**leveldb://relative/path?option=value** 或 **leveldb:///absolute/path?option=value** 进行设置,并将覆盖 `DATADIR`。 -- `QUEUE_NAME`:**\_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`,但可以在特定的 `queue.name` 部分中进行覆盖。 -- `SET_NAME`:**\_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_,但可以在特定的 `queue.name` 部分中进行覆盖。 -- `MAX_WORKERS`:**(dynamic)**: 队列的最大工作协程数。默认值为 "CpuNum/2",限制在 1 到 10 之间。 +- `TYPE`:**level**: 通用隊列類型,當前支援:`level`(在內部使用 LevelDB)、`channel`、`redis`、`dummy`。無效的類型將視為 `level`。 +- `DATADIR`:**queues/common**: 用於儲存 level 隊列的基本 DataDir。單獨的隊列的 `DATADIR` 可以在 `queue.name` 部分進行設定。相對路徑將根據 `{APP_DATA_PATH}` 變為絕對路徑。 +- `LENGTH`:**100000**: 通道隊列阻塞之前的最大隊列大小 +- `BATCH_LENGTH`:**20**: 在傳遞給處理程式之前批處理資料 +- `CONN_STR`:**redis://127.0.0.1:6379/0**: redis 隊列類型的連接字符串。對於 `redis-cluster`,使用 `redis+cluster://127.0.0.1:6379/0`。可以使用查詢參數來設定選項。類似地,LevelDB 選項也可以使用:**leveldb://relative/path?option=value** 或 **leveldb:///absolute/path?option=value** 進行設定,並將覆蓋 `DATADIR`。 +- `QUEUE_NAME`:**\_queue**: 預設的 redis 和磁盤隊列名稱的後綴。單獨的隊列將預設為 **`name`**`QUEUE_NAME`,但可以在特定的 `queue.name` 部分中進行覆蓋。 +- `SET_NAME`:**\_unique**: 將添加到預設的 redis 和磁盤隊列 `set` 名稱中以用於唯一隊列的後綴。單獨的隊列將預設為 **`name`**`QUEUE_NAME`_`SET_NAME`_,但可以在特定的 `queue.name` 部分中進行覆蓋。 +- `MAX_WORKERS`:**(dynamic)**: 隊列的最大工作協程數。預設值為 "CpuNum/2",限制在 1 到 10 之間。 -Gitea 创建以下非唯一队列: +Gitea 建立以下非唯一隊列: - `code_indexer` - `issue_indexer` @@ -520,7 +523,7 @@ Gitea 创建以下非唯一队列: - `mail` - `push_update` -以及以下唯一队列: +以及以下唯一隊列: - `repo_stats_update` - `repo-archive` @@ -529,54 +532,56 @@ Gitea 创建以下非唯一队列: ## Admin (`admin`) -- `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: 用户电子邮件通知的默认配置(用户可配置)。选项:enabled、onmention、disabled -- `DISABLE_REGULAR_ORG_CREATION`: **false**: 禁止普通(非管理员)用户创建组织。 -- `USER_DISABLED_FEATURES`:**_empty_** 禁用的用户特性,当前允许为空或者 `deletion`,`manage_ssh_keys`, `manage_gpg_keys` 未来可以增加更多设置。 - - `deletion`: 用户不能通过界面或者 API 删除他自己。 - - `manage_ssh_keys`: 用户不能通过界面或者 API 配置 SSH Keys。 - - `manage_gpg_keys`: 用户不能配置 GPG 密钥。 -- `EXTERNAL_USER_DISABLE_FEATURES`:**_empty_**:仅在用户使用外部登录方式(例如 LDAP、OAuth 等)时禁用的功能列表,以逗号分隔,可选值为 `deletion`、`manage_ssh_keys`、`manage_gpg_keys`、`manage_mfa`、`manage_credentials`。此设置独立于 `USER_DISABLED_FEATURES`,并作为其行为的补充。 - - `deletion`:用户不能删除自己的帐户。 - - `manage_ssh_keys`:用户不能配置 SSH 密钥。 - - `manage_gpg_keys`:用户不能配置 GPG 密钥。 - - `manage_mfa`:用户不能配置 MFA 设备。 - - `manage_credentials`:用户不能配置邮箱、密码或 OpenID。 - - `change_username`:用户不能更改其用户名。 - - `change_full_name`:用户不能更改其全名。 +- `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: 使用者電子郵件通知的預設設定(使用者可設定)。選項:enabled、onmention、disabled +- `DISABLE_REGULAR_ORG_CREATION`: **false**: 禁止普通(非管理員)使用者建立組織。 +- `USER_DISABLED_FEATURES`:**_empty_** 禁用的使用者特性,當前允許為空或者 `deletion`,`manage_ssh_keys`, `manage_gpg_keys` 未來可以增加更多設定。 + - `deletion`: 使用者不能通過介面或者 API 刪除他自己。 + - `manage_ssh_keys`: 使用者不能通過介面或者 API 設定 SSH Keys。 + - `manage_gpg_keys`: 使用者不能設定 GPG 密鑰。 +- `EXTERNAL_USER_DISABLE_FEATURES`:**_empty_**:僅在使用者使用外部登入方式(例如 LDAP、OAuth 等)時禁用的功能列表,以逗號分隔,可選值為 `deletion`、`manage_ssh_keys`、`manage_gpg_keys`、`manage_mfa`、`manage_credentials`。此設定獨立於 `USER_DISABLED_FEATURES`,並作為其行為的補充。 + - `deletion`:使用者不能刪除自己的帳戶。 + - `manage_ssh_keys`:使用者不能設定 SSH 密鑰。 + - `manage_gpg_keys`:使用者不能設定 GPG 密鑰。 + - `manage_mfa`:使用者不能設定 MFA 設備。 + - `manage_credentials`:使用者不能設定郵箱、密碼或 OpenID。 + - `change_username`:使用者不能更改其使用者名稱。 + - `change_full_name`:使用者不能更改其全名。 + + ## 安全性 (`security`) -- `INSTALL_LOCK`: **false**: 控制是否能够访问安装向导页面,设置为 `true` 则禁止访问安装向导页面。 -- `SECRET_KEY`: **\<每次安装时随机生成\>**: 全局服务器安全密钥。这个密钥非常重要,如果丢失将无法解密加密的数据(例如 2FA)。 -- `SECRET_KEY_URI`: **_empty_**: 与定义 `SECRET_KEY` 不同,此选项可用于使用存储在文件中的密钥(示例值:`file:/etc/gitea/secret_key`)。它不应该像 `SECRET_KEY` 一样容易丢失。 -- `LOGIN_REMEMBER_DAYS`: **31**: 在要求重新登录之前,记住用户的登录状态多长时间(以天为单位)。 -- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: 保存自动登录信息的 Cookie 名称。 -- `REVERSE_PROXY_LOGOUT_REDIRECT`: **_empty_**: 当使用反向代理或 SSO 进行身份认证时,用户登出后重定向到的 URL 或相对路径。例如:`/my-sso/logout?return=/my-sso/home`。 -- `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: 反向代理认证的 HTTP 头部名称,用于提供用户信息。 -- `REVERSE_PROXY_AUTHENTICATION_EMAIL`: **X-WEBAUTH-EMAIL**: 反向代理认证的 HTTP 头部名称,用于提供邮箱信息。 -- `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`: **X-WEBAUTH-FULLNAME**: 反向代理认证的 HTTP 头部名称,用于提供全名信息。 -- `REVERSE_PROXY_LIMIT`: **1**: 解释 X-Forwarded-For 标头或 X-Real-IP 标头,并将其设置为请求的远程 IP。 - 可信代理计数。设置为零以不使用这些标头。 -- `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: 逗号分隔的受信任代理服务器的 IP 地址和网络列表。使用 `*` 来信任全部。 -- `DISABLE_GIT_HOOKS`: **true**: 设置为 `false` 以允许具有 Git 钩子权限的用户创建自定义 Git 钩子。 - 警告:自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库,并中断 Gitea 服务。 - 通过修改 Gitea 数据库,用户可以获得 Gitea 管理员权限。 - 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源,并以 Gitea 操作系统用户的名义执行任意操作。 - 这可能对您的网站或操作系统造成危害。 - 在必要之前,请在更改现有 git 存储库中的钩子之前进行调整。 -- `DISABLE_WEBHOOKS`: **false**: 设置为 `true` 以禁用 Webhooks 功能。 -- `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: 设置为 `false` 以允许本地用户在未设置 Gitea 环境的情况下推送到 Gitea 存储库。不建议这样做,如果您希望本地用户推送到 Gitea 存储库,应该适当地设置环境。 -- `IMPORT_LOCAL_PATHS`: **false**: 设置为 `false` 以防止所有用户(包括管理员)从服务器上导入本地路径。 -- `INTERNAL_TOKEN`: **\<每次安装时随机生成,如果未设置 URI\>**: 用于验证 Gitea 二进制文件内部通信的密钥。 -- `INTERNAL_TOKEN_URI`: **_empty_**: 与在配置中定义 `INTERNAL_TOKEN` 不同,此配置选项可用于将包含内部令牌的文件的路径提供给 Gitea(示例值:`file:/etc/gitea/internal_token`)。 -- `PASSWORD_HASH_ALGO`: **pbkdf2**: 要使用的哈希算法 \[argon2、pbkdf2、pbkdf2_v1、pbkdf2_hi、scrypt、bcrypt\],argon2 和 scrypt 将消耗大量内存。 - - 注意:`pbkdf2` 哈希的默认参数已更改 - 先前的设置可作为 `pbkdf2_v1` 使用,但不建议使用。 - - 可以通过在算法后使用 `$` 进行调整: +- `INSTALL_LOCK`: **false**: 控制是否能夠訪問安裝嚮導頁面,設定為 `true` 則禁止訪問安裝嚮導頁面。 +- `SECRET_KEY`: **\<每次安裝時隨機生成\>**: 全域伺服器安全密鑰。這個密鑰非常重要,如果丟失將無法解密加密的資料(例如 2FA)。 +- `SECRET_KEY_URI`: **_empty_**: 與定義 `SECRET_KEY` 不同,此選項可用於使用儲存在文件中的密鑰(範例值:`file:/etc/gitea/secret_key`)。它不應該像 `SECRET_KEY` 一樣容易丟失。 +- `LOGIN_REMEMBER_DAYS`: **31**: 在要求重新登入之前,記住使用者的登入狀態多長時間(以天為單位)。 +- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: 保存自動登入資訊的 Cookie 名稱。 +- `REVERSE_PROXY_LOGOUT_REDIRECT`: **_empty_**: 當使用反向代理或 SSO 進行身份認證時,使用者登出後重定向到的 URL 或相對路徑。例如:`/my-sso/logout?return=/my-sso/home`。 +- `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: 反向代理認證的 HTTP 頭部名稱,用於提供使用者資訊。 +- `REVERSE_PROXY_AUTHENTICATION_EMAIL`: **X-WEBAUTH-EMAIL**: 反向代理認證的 HTTP 頭部名稱,用於提供郵箱資訊。 +- `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`: **X-WEBAUTH-FULLNAME**: 反向代理認證的 HTTP 頭部名稱,用於提供全名資訊。 +- `REVERSE_PROXY_LIMIT`: **1**: 解釋 X-Forwarded-For 標頭或 X-Real-IP 標頭,並將其設定為請求的遠程 IP。 + 可信代理計數。設定為零以不使用這些標頭。 +- `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: 逗號分隔的受信任代理伺服器的 IP 地址和網路列表。使用 `*` 來信任全部。 +- `DISABLE_GIT_HOOKS`: **true**: 設定為 `false` 以允許具有 Git 鉤子權限的使用者建立自訂 Git 鉤子。 + 警告:自訂 Git 鉤子可用於在主機操作系統上執行任意程式碼。這允許使用者訪問和修改此設定文件和 Gitea 資料庫,並中斷 Gitea 服務。 + 透過修改 Gitea 資料庫,使用者可以獲得 Gitea 管理員權限。 + 它還使他們可以訪問正在運行 Gitea 實例的操作系統上使用者可用的其他資源,並以 Gitea 操作系統使用者的名義執行任意操作。 + 這可能對您的網站或操作系統造成危害。 + 在必要之前,請在更改現有 git 儲存庫中的鉤子之前進行調整。 +- `DISABLE_WEBHOOKS`: **false**: 設定為 `true` 以禁用 Webhooks 功能。 +- `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: 設定為 `false` 以允許本地使用者在未設定 Gitea 環境的情況下推送到 Gitea 儲存庫。不建議這樣做,如果您希望本地使用者推送到 Gitea 儲存庫,應該適當地設定環境。 +- `IMPORT_LOCAL_PATHS`: **false**: 設定為 `false` 以防止所有使用者(包括管理員)從伺服器上導入本地路徑。 +- `INTERNAL_TOKEN`: **\<每次安裝時隨機生成,如果未設定 URI\>**: 用於驗證 Gitea 二進制文件內部通信的密鑰。 +- `INTERNAL_TOKEN_URI`: **_empty_**: 與在設定中定義 `INTERNAL_TOKEN` 不同,此設定選項可用於將包含內部令牌的文件的路徑提供給 Gitea(範例值:`file:/etc/gitea/internal_token`)。 +- `PASSWORD_HASH_ALGO`: **pbkdf2**: 要使用的哈希算法 \[argon2、pbkdf2、pbkdf2_v1、pbkdf2_hi、scrypt、bcrypt\],argon2 和 scrypt 將消耗大量內存。 + - 注意:`pbkdf2` 哈希的預設參數已更改 - 先前的設定可作為 `pbkdf2_v1` 使用,但不建議使用。 + - 可以透過在算法後使用 `$` 進行調整: - `argon2$