Files
2025-09-03 21:00:35 +00:00

1381 lines
111 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
date: "2016-12-26T16:00:00+02:00"
slug: "config-cheat-sheet"
sidebar_position: 30
aliases:
- /zh-tw/config-cheat-sheet
---
# 配置说明
这是针对 Gitea 配置文件的说明,
你可以了解 Gitea 的强大配置。
需要说明的是,你的所有改变請修改 `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: 的配置项表明除非你真的理解这个配置项的意义,否则最好使用默认值。
包含`#`或者`;`的变量必須使用引号( `` ` `` 或者 `"` )包裹,否则会被解析為注释。
本文檔使用以下约定:
- `[section].FOO_BAR` 或 `[section]FOO_BAR`: 一个位于 INI 文件 `[section]` 段中的配置项。
- `FooBar`: 这是一个 Gitea 内部变量,不是一个配置项,僅用于描述相关逻辑。
- `$FOO_BAR`: 这是一个环境变量Gitea 可能会使用它的值,但是它不能直接用于配置文件中。
- `{FOO_BAR}/something` 或 `{FooBar}/something`: 这个值会默认使用配置项 `FOO_BAR` 或者内部变量 `FooBar`。
**注意:** 修改完配置文件后,需要重启 Gitea 服务才能生效。
## 使用环境变量配置 Gitea
我们提供了 [environment-to-ini](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini) 工具
来帮助通過环境变量生成 Gitea 的 `app.ini` 配置文件。
## 默认配置 (非`app.ini`配置文件)
这些值取决于环境,但构成了许多值的基础。当运行 `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`*目錄進行处理。
此外,還有*`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_**: 工作目錄, 前文有提及.
## 存放庫 (`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**: 使用推送建立新存放庫时默认為私有。
- `MAX_CREATION_LIMIT`: **-1**: 每个使用者的全局存放庫建立上限,
`-1` 代表無限制.
- `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
而不是 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**: 允许無限制得派生存放庫。
### 存放庫 - 编辑器 (`repository.editor`)
- `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 编辑器中應該换行的文件扩展名列表。用逗号分隔扩展名。要对没有扩展名的文件進行换行,只需放置一个逗号。
- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览 API 的有效文件模式,例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配,编辑模式下的预览選项卡将不会显示。
### 存放庫 - 合並請求 (`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`标记。
- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合並方法测试`PR Patch`以发現是否存在冲突。如果此设置`true`,将使用`git apply`重新测试冲突的`PR Pathch` - 这是 1.18(和之前版本)中的先前行為,但效率相对较低。如果发現需要此设置,請报告。
### 存放庫 - 工單 (`repository.issue`)
- `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合並請求或工單被锁定的原因列表。
- `MAX_PINNED`: **3**: 每个存放庫的最大可固定工單数量。设置為 0 禁用固定工單。
### 存放庫 - 文件上传 (`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**: 每次上传的最大文件数。
### 存放庫 - 版本發佈 (`repository.release`)
- `ALLOWED_TYPES`: **_empty_**: 允许發佈的文件類型列表,用逗号分隔 。如压缩包類型(`.zip`), mime 類型 (`text/plain`) ,也支持通配符 (`image/*`, `audio/*`, `video/*`)。 空值或者 `*/*` 代表允许所有類型。
- `DEFAULT_PAGING_NUM`: **10**: 默认的發佈版本页面分页大小
- 关于版本發佈相关的附件设置,详见`附件`部分。
### 存放庫 - 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`: 僅在头分支中的所有提交到合並点都進行了签名时才進行签名。
### 存放庫 - Local (`repository.local`)
- `LOCAL_COPY_PATH`: **tmp/local-repo**:临时本地存放庫副本的路径。默认為 tmp/local-repo内容在 Gitea 重新启动时被删除)
### 存放庫 - MIME type mapping (`repository.mimetype_mapping`)
配置用于根据可下载文件的文件扩展名设置预期的 MIME 類型。配置以键值对的形式呈現,文件扩展名以`.`開頭。
以下配置在下载具有`.apk`文件扩展名的文件时设置`Content-Type: application/vnd.android.package-archive`头部。
```ini
.apk=application/vnd.android.package-archive
```
## 跨域 (`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 头部.
## 界面 (`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` 提供)。允许使用者選择个性化的主题,
- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小(默认為 8MiB
- `REACTIONS`: 使用者可以在问题Issue、Pull RequestPR以及评论中選择的所有可選的反應。
这些值可以是表情符号别名(例如::smile:)或 Unicode 表情符号。
對於自定义的反應,在 public/assets/img/emoji/ 目錄下添加一个紧密裁剪的正方形图像,文件名為 reaction_name.png。
- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 标准中定义的额外表情符号。
默认情况下,我们支持 Gitea 表情符号(:gitea:)。要添加更多表情符号,請将它们复制到 public/assets/img/emoji/ 目錄下,
並将其添加到此配置中。
- `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情况下显示使用者的全名。如果没有设置全名,则将使用使用者名。
- `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索页面上的存放庫搜索中搜索描述。
- `ONLY_SHOW_RELEVANT_REPOS`: **false** 在没有指定关键字並使用默认排序时,是否僅在探索页面上显示相关的存放庫。
如果一个存放庫是分叉或者没有元数据(没有描述、图标、主题),则被视為不相关的存放庫。
### 界面 - 管理员 (`ui.admin`)
- `USER_PAGING_NUM`: **50**: 單页显示的使用者数量。
- `REPO_PAGING_NUM`: **50**: 單页显示的存放庫数量。
- `NOTICE_PAGING_NUM`: **25**: 單页显示的通知数量。
- `ORG_PAGING_NUM`: **50**: 單页显示的組織数量。
### 界面 - 使用者 (`ui.user`)
- `REPO_PAGING_NUM`: **15**: 單页显示的存放庫数量。
- `ORG_PAGING_NUM`: **15**: 个人信息页展示的組織数量。
### 界面 - 元信息 (`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**: 首页关键詞元標籤。
### 界面 - 通知 (`ui.notification`)
- `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`。
### 界面 - SVG Images (`ui.svg`)
- `ENABLE_RENDER`: **true**: 是否将 SVG 文件呈現為图像。如果禁用了 SVG 渲染SVG 文件将显示為文本,無法作為图像嵌入到 Markdown 文件中。
### 界面 - CSV Files (`ui.csv`)
- `MAX_FILE_SIZE`: **524288** (512kb): 以字节為單位允许将 CSV 文件呈現為表格的最大文件大小(将其设置為 0 表示没有限制)。
- `MAX_ROWS`: **2500** : 最大允许的 CSV 文件行数。 (设置為 0 不限制)
## Markdown (`markdown`)
- `ENABLE_HARD_LINE_BREAK_IN_COMMENTS`: **true**: 在评论中将软换行符呈現為硬换行符,
这意味着段落之间的單个换行符将导致换行,
並且不需要在段落后添加尾随空格来强制换行。
- `ENABLE_HARD_LINE_BREAK_IN_DOCUMENTS`: **false**: 在文檔中将软换行符呈現為硬换行符,
这意味着段落之间的單个换行符将导致换行,
並且不需要在段落后添加尾随空格来强制换行。
- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表ftp、git、svn来指示要在 Markdown 中呈現的附加 URL 超链接。
以 http 和 https 開頭的 URL 始终显示。
如果此条目為空,则允许所有 URL 方案。
- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 應呈現/编辑為 Markdown 的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈現為 Markdown請只需放置一个逗号。
- `ENABLE_MATH`: **true**: 启用对`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作為数学块的检测。
## 服务器 (`server`)
- `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**: 此服务器的域名。
- `ROOT_URL`: **`{PROTOCOL}://{DOMAIN}:{HTTP_PORT}/`**:
覆盖自动生成的公共 URL。
如果内部 URL 和外部 URL 不匹配(例如在 Docker 中),这很有用。
- `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`。
- `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 更新的本地DMZURL。
在大多数情况下,您不需要更改默认值。
僅在您的 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-<algorithm> <key>` 或 `ssh-<algorithm> <key1>, ssh-<algorithm> <key2>`。有关详细信息,請参阅 `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)_<username>_<temporary id>`。
- `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_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 锁定数。
- `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"
- "rsa_with_aes_128_cbc_sha"
- "rsa_with_aes_256_cbc_sha"
- "rsa_with_aes_128_cbc_sha256"
- "rsa_with_aes_128_gcm_sha256"
- "rsa_with_aes_256_gcm_sha384"
- "ecdhe_ecdsa_with_rc4_128_sha"
- "ecdhe_ecdsa_with_aes_128_cbc_sha"
- "ecdhe_ecdsa_with_aes_256_cbc_sha"
- "ecdhe_rsa_with_rc4_128_sha"
- "ecdhe_rsa_with_3des_ede_cbc_sha"
- "ecdhe_rsa_with_aes_128_cbc_sha"
- "ecdhe_rsa_with_aes_256_cbc_sha"
- "ecdhe_ecdsa_with_aes_128_cbc_sha256"
- "ecdhe_rsa_with_aes_128_cbc_sha256"
- "ecdhe_rsa_with_aes_128_gcm_sha256"
- "ecdhe_ecdsa_with_aes_128_gcm_sha256"
- "ecdhe_rsa_with_aes_256_gcm_sha384"
- "ecdhe_ecdsa_with_aes_256_gcm_sha384"
- "ecdhe_rsa_with_chacha20_poly1305_sha256"
- "ecdhe_ecdsa_with_chacha20_poly1305_sha256"
- TLS 1.3 套件
- "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的打开来确定。索引程序可能需要更长时间启动可能具有自己的超时时间。
## 数据库 (`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"""。
- `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 证书添加到证书存儲的说明,請参阅系统文檔。
- `false`:禁用 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**: 是否自动執行数据库模型迁移。
請参见 #8540#8273 以获取有关 `MAX_OPEN_CONNS``MAX_IDLE_CONNS``CONN_MAX_LIFETIME` 的适当值及其与端口耗尽的关系的進一步讨论。
## 索引 (`indexer`)
- `ISSUE_INDEXER_TYPE`: **bleve**: 工單索引類型,当前支持:`bleve``db``elasticsearch``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`
- `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 表示永不超时。
## 队列 (`queue` and `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 之间。
Gitea 建立以下非唯一队列:
- `code_indexer`
- `issue_indexer`
- `notification-service`
- `task`
- `mail`
- `push_update`
以及以下唯一队列:
- `repo_stats_update`
- `repo-archive`
- `mirror`
- `pr_patch_checker`
## 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 密钥。
## 安全性 (`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_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$<time>$<memory>$<threads>$<key-length>`
- `bcrypt$<cost>`
- `pbkdf2$<iterations>$<key-length>`
- `scrypt$<n>$<r>$<p>$<key-length>`
- 默认值為:
- `argon2``argon2$2$65536$8$50`
- `bcrypt``bcrypt$10`
- `pbkdf2``pbkdf2$50000$50`
- `pbkdf2_v1``pbkdf2$10000$50`
- `pbkdf2_v2``pbkdf2$50000$50`
- `pbkdf2_hi``pbkdf2$320000$50`
- `scrypt``scrypt$65536$16$2$50`
- 使用此功能调整算法參數存在一定风险。
- `CSRF_COOKIE_HTTP_ONLY`: **true**: 设置為 false 以允许 JavaScript 读取 CSRF cookie。
- `MIN_PASSWORD_LENGTH`: **6**: 新使用者的最小密碼长度。
- `PASSWORD_COMPLEXITY`: **off**: 要求通過最小复杂性的字符类别的逗号分隔列表。如果留空或没有指定有效值则禁用检查off
- lower - 使用一个或多个小写拉丁字符
- upper - 使用一个或多个大写拉丁字符
- digit - 使用一个或多个数字
- spec - 使用一个或多个特殊字符,如 `` !"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ ``
- off - 不检查密碼复杂性
- `PASSWORD_CHECK_PWN`: **false**: 检查密碼是否在 [HaveIBeenPwned](https://haveibeenpwned.com/Passwords) 中曝光。
- `SUCCESSFUL_TOKENS_CACHE_SIZE`: **20**: 缓存成功的令牌哈希。API 令牌在数据库中存儲為 pbkdf2 哈希,但这意味着在存在多个 API 操作时可能会有显着的哈希负载。此缓存将在 LRU 缓存中存儲成功的哈希令牌,以在性能和安全性之间保持平衡。
## Camo (`camo`)
- `ENABLED`: **false**: 启用媒體代理,目前僅支持图像。
- `SERVER_URL`: **_empty_**: Camo 服务器的 URL如果启用 camo则**必填**。
- `HMAC_KEY`: **_empty_**: 為 URL 编码提供 HMAC 密钥,如果启用 camo则**必填**。
- `ALWAYS`: **false**: 设置為 true 以在 HTTP 和 HTTPS 内容上使用 camo否则僅代理非 HTTPS URL。`ALLWAYS` 已经過期,並且会在未来版本中删除。
## OpenID (`openid`)
- `ENABLE_OPENID_SIGNIN`: **true**: 允许通過 OpenID 進行身份驗證。
- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: 允许通過 OpenID 進行注册。
- `WHITELISTED_URIS`: **_empty_**: 如果非空,是一组匹配 OpenID URI 的 POSIX 正则表达式模式,用于允许访问。
- `BLACKLISTED_URIS`: **_empty_**: 如果非空,是一组匹配 OpenID URI 的 POSIX 正则表达式模式,用于阻止访问。
## OAuth2 Client (`oauth2_client`)
- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER_EMAIL_CONFIRM**: 设置此项以启用或禁用 OAuth2 自动注册的电子邮件确认。(覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置)
- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的 OpenID 连接范围的列表。(`openid`已隐式添加)
- `ENABLE_AUTO_REGISTRATION`: **false**: 為新的 OAuth2 使用者自动建立使用者帳戶。
- `USERNAME`: **nickname**: 新 OAuth2 帳戶的使用者名来源:
- userid - 使用 userid / sub 属性
- nickname - 使用 nickname 属性
- email - 使用 email 属性的使用者名部分
- `UPDATE_AVATAR`: **false**: 如果 OAuth2 提供程序中有可用的头像,则進行头像更新。更新将在每次登入时執行。
- `ACCOUNT_LINKING`: **login**: 如果帳戶/电子邮件已存在,如何处理:
- disabled - 显示错误
- login - 显示帳戶链接登入
- auto - 自动与帳戶链接(請注意,这将因為提供相同的使用者名或电子邮件而自动授予現有帳戶的访问权限。您必須确保这不会导致身份驗證提供程序出現问题。)
## Service (`service`)
- `ACTIVE_CODE_LIVE_MINUTES`: **180**: 确认帳戶/电子邮件注册的时间限制(分钟)。
- `RESET_PASSWD_CODE_LIVE_MINUTES`: **180**: 确认忘记密碼重置流程的时间限制(分钟)。
- `REGISTER_EMAIL_CONFIRM`: **false**: 启用此项以要求通過邮件确认注册。需要启用`Mailer`
- `REGISTER_MANUAL_CONFIRM`: **false**: 启用此项以手动确认新的注册。需要禁用`REGISTER_EMAIL_CONFIRM`
- `DISABLE_REGISTRATION`: **false**: 禁用注册,之后只有管理员可以為使用者建立帳戶。
- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通過外部方式建立的帳戶(通過 GitHub、OpenID Connect 等)建立密碼。警告:启用此项将降低安全性,因此只有在您知道自己在做什么时才應启用它。
- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制使用者登入以查看任何页面或使用 API。
- `ENABLE_NOTIFY_MAIL`: **false**: 启用此项以在发生某些情况(如建立问题)时向存儲库的观察者发送电子邮件。需要启用`Mailer`
- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用 HTTP BASIC 和使用者的密碼進行身份驗證。請注意,如果禁用此项,您将無法使用密碼访问令牌 API 端点。此外,这僅会禁用使用密碼的 BASIC 身份驗證,而不会禁用令牌或 OAuth Basic。
- `ENABLE_REVERSE_PROXY_AUTHENTICATION`: **false**: 启用此项以允许反向代理身份驗證。
- `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION`: **false**: 启用此项以允许反向身份驗證的自动注册。
- `ENABLE_REVERSE_PROXY_EMAIL`: **false**: 启用此项以允许使用提供的电子邮件而不是生成的电子邮件進行自动注册。
- `ENABLE_REVERSE_PROXY_FULL_NAME`: **false**: 启用此项以允许使用提供的全名進行自动注册。
- `ENABLE_CAPTCHA`: **false**: 启用此项以对注册使用驗證码驗證。
- `REQUIRE_CAPTCHA_FOR_LOGIN`: **false**: 启用此项以要求登入使用驗證码驗證。您還必須启用`ENABLE_CAPTCHA`
- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帳戶(即 GitHub、OpenID Connect 等)使用驗證码驗證。您還必須启用`ENABLE_CAPTCHA`
- `CAPTCHA_TYPE`: **image**: \[image、recaptcha、hcaptcha、mcaptcha、cfturnstile\]
- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的密钥。
- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的站点密钥。
- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/** :设置 recaptcha 网址,允许使用 recaptcha net。
- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的密钥。
- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的站点密钥。
- `MCAPTCHA_SECRET`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的密钥。
- `MCAPTCHA_SITEKEY`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的站点密钥。
- `MCAPTCHA_URL` **https://demo.mcaptcha.org/** :设置 mCaptcha 的 URL。
- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的密钥。
- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的站点密钥。
- `DEFAULT_KEEP_EMAIL_PRIVATE`: **false**: 默认情况下,将使用者设置為保持其电子邮件地址私有。
- `DEFAULT_ALLOW_CREATE_ORGANIZATION`: **true**: 默认情况下,允许新使用者建立組織。
- `DEFAULT_USER_IS_RESTRICTED`: **false**: 默认情况下,為新使用者分配受限权限。
- `DEFAULT_ENABLE_DEPENDENCIES`: **true**: 启用此项以默认启用依赖项。
- `ALLOW_CROSS_REPOSITORY_DEPENDENCIES` : **true** 启用此项以允许从使用者被授予访问权限的任何存儲库上進行依赖项操作。
- `USER_LOCATION_MAP_URL`: **""**: 一个显示使用者在地图上位置的地图服务 URL。位置将作為转义的查询參數附加到 URL 中。
- `ENABLE_USER_HEATMAP`: **true**: 启用此项以在使用者个人资料上显示热图。
- `ENABLE_TIMETRACKING`: **true**: 启用时间跟踪功能。
- `DEFAULT_ENABLE_TIMETRACKING`: **true**: 默认情况下,允许存儲库默认使用时间跟踪。
- `DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME`: **true**: 僅允许具有写权限的使用者跟踪时间。
- `EMAIL_DOMAIN_ALLOWLIST`: **_empty_**: 如果非空,逗号分隔的域名列表,只能用于在此实例上注册,支持通配符。
- `EMAIL_DOMAIN_BLOCKLIST`: **_empty_**: 如果非空,逗号分隔的域名列表,不能用于在此实例上注册,支持通配符。
- `SHOW_REGISTRATION_BUTTON`: **! DISABLE_REGISTRATION**: 显示注册按钮
- `SHOW_MILESTONES_DASHBOARD_PAGE`: **true** 启用此项以显示里程碑仪表板页面 - 查看所有使用者的里程碑
- `AUTO_WATCH_NEW_REPOS`: **true** 启用此项以在建立新存儲库时让所有組織使用者观看新存儲库
- `AUTO_WATCH_ON_CHANGES`: **false** 启用此项以在首次提交后使使用者观看存儲库
- `DEFAULT_USER_VISIBILITY`: **public**: 為使用者设置默认的可见性模式,可以是"public"、"limited"或"private"。
- `ALLOWED_USER_VISIBILITY_MODES`: **public,limited,private**: 设置使用者可以具有的可见性模式
- `DEFAULT_ORG_VISIBILITY`: **public**: 為組織设置默认的可见性模式,可以是"public"、"limited"或"private"。
- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到組織时将使用者的成员身份可见,设置為 True。
- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置為 True 以强制僅通過 Gitea 進行注册。
- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置為 True 以强制僅使用第三方服务進行注册。
- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果使用者将 KeepEmailPrivate 设置為 True则在 Git 日志中的使用者电子邮件地址的域部分的值。DOMAIN 解析為 server.DOMAIN 中的值。
使用者的电子邮件将被替换為小写的使用者名、"@"和 NO_REPLY_ADDRESS 的连接。
- `USER_DELETE_WITH_COMMENTS_MAX_TIME`: **0**: 使用者删除后,评论将保留的最短时间。
- `VALID_SITE_URL_SCHEMES`: **http, https**: 使用者个人资料的有效站点 URL 方案
### Service - Explore (`service.explore`)
- `REQUIRE_SIGNIN_VIEW`: **false**: 僅允许已登入的使用者查看探索页面。
- `DISABLE_USERS_PAGE`: **false**: 禁用使用者探索页面。
- `DISABLE_ORGANIZATIONS_PAGE`: **false**: 禁用組織探索页面。
- `DISABLE_CODE_PAGE`: **false**: 禁用代码探索页面。
## SSH Minimum Key Sizes (`ssh.minimum_key_sizes`)
定义允许的算法及其最小密钥长度(使用-1 来禁用某个類型):
- `ED25519`**256**
- `ECDSA`**256**
- `RSA`**3071**: 我们在这里设置為 2047因為一个其他方面有效的 3072 RSA 密钥可能被报告為 3071 长度。
- `DSA`**-1**: 默认情况下禁用 DSA。设置為**1024**以重新启用,但請注意可能需要重新配置您的 SSHD 提供者
## Webhook (`webhook`)
- `QUEUE_LENGTH`: **1000**: 钩子任务队列长度。编辑此值时要小心。
- `DELIVER_TIMEOUT`: **5**: 发送 Webhook 的交付超时时间(秒)。
- `ALLOWED_HOST_LIST`: **external**: 出于安全原因Webhook 僅能调用允许的主机。以逗号分隔的列表。
- 内置网络:
- `loopback`IPv4 的 127.0.0.0/8 和 IPv6 的 ::1/128包括 localhost。
- `private`RFC 191810.0.0.0/8172.16.0.0/12192.168.0.0/16和 RFC 4193FC00::/7。也稱為 LAN/Intranet。
- `external`:一个有效的非私有單播 IP您可以访问公共互联网上的所有主机。
- `*`:允许所有主机。
- CIDR 列表IPv4 的 `1.2.3.0/8` 和 IPv6 的 `2001:db8::/32`
- 通配符主机:`*.mydomain.com``192.168.100.*`
- `SKIP_TLS_VERIFY`: **false**: 允许不安全的证书。
- `PAGING_NUM`: **10**: 一页中显示的 Webhook 历史事件数量。
- `PROXY_URL`: **_empty_**: 代理服务器 URL支持 http://、https://、socks://,留空将遵循环境的 http_proxy/https_proxy 设置。如果未提供,将使用全局代理设置。
- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (\*);使用 \*\* 来匹配所有主机。如果未提供,将使用全局代理设置。
## 邮件 (`mailer`)
⚠️ 此部分适用于 Gitea 1.18 及更高版本。如果您使用的是 Gitea 1.17 或更早版本,請阅读以下链接获取更多信息:
[Gitea 1.17 app.ini 示例](https://github.com/go-gitea/gitea/blob/release/v1.17/custom/conf/app.example.ini)
[Gitea 1.17 配置文檔](https://github.com/go-gitea/gitea/blob/release/v1.17/docs/content/doc/advanced/config-cheat-sheet.zh-tw.md)
- `ENABLED`: **false**: 是否启用邮件服务。
- `PROTOCOL`: **_empty_**: 邮件服务协议,可選择 "smtp"、"smtps"、"smtp+starttls"、"smtp+unix"、"sendmail"、"dummy"。在 Gitea 1.18 之前,邮件服务协议由 `MAILER_TYPE``IS_TLS_ENABLED` 两个配置共同决定。
- SMTP 类族,如果您的提供者没有明确说明使用的是哪个协议,但提供了一个端口,您可以设置 SMTP_PORT它将被推断出来。
- **sendmail** 使用操作系统的 `sendmail` 命令,而不是 SMTP。这在 Linux 系统上很常见。
- **dummy** 将邮件消息发送到日志,作為测试阶段。
- 請注意,启用 sendmail 将忽略所有其他 `mailer` 设置,除了 `ENABLED``FROM``SUBJECT_PREFIX``SENDMAIL_PATH`
- 启用 dummy 将忽略所有设置,除了 `ENABLED``SUBJECT_PREFIX``FROM`
- `SMTP_ADDR`: **_empty_**: 邮件服务器地址,例如 smtp.gmail.com。對於 smtp+unix这應該是一个到 unix socket 的路径。在 1.18 之前,此设置与 `SMTP_PORT` 合並,名稱為 `HOST`
- `SMTP_PORT`: **_empty_**: 邮件服务器端口。如果未指定协议,将通過此设置進行推断。常用端口如下。在 1.18 之前,此设置与 `SMTP_ADDR` 合並,名稱為 `HOST`
- 25不安全的简單邮件传输协议insecure SMTP
- 465安全的简單邮件传输协议SMTP Secure
- 587StartTLS
- `USE_CLIENT_CERT`: **false**: 使用客户端证书進行 TLS/SSL 加密。
- `CLIENT_CERT_FILE`: **custom/mailer/cert.pem**: 客户端证书文件。
- `CLIENT_KEY_FILE`: **custom/mailer/key.pem**: 客户端密钥文件。
- `FORCE_TRUST_SERVER_CERT`: **false**: 如果设置為 `true`,将完全忽略服务器证书驗證错误。此選项不安全。考虑将证书添加到系统信任存儲中。
- `USER`: **_empty_**: 邮件使用者的使用者名(通常是发件人的电子邮件地址)。
- `PASSWD`: **_empty_**: 邮件使用者的密碼。如果密碼中使用了特殊字符,請使用 \`your password\` 進行引用。
- 請注意:只有在 SMTP 服务器通信通過 TLS 加密(可以通過 `STARTTLS` 实現)或 SMTP 主机是 localhost 时,才支持身份驗證。有关更多信息,請参阅 [邮件设置](../administration/email-setup.md)。
- `ENABLE_HELO`: **true**: 启用 HELO 操作。
- `HELO_HOSTNAME`: **(从系统检索)**: HELO 主机名。
- `FROM`: **_empty_**: 邮件的发件人地址,符合 RFC 5322。这可以是一个电子邮件地址也可以是 "Name" \<email@example.com\> 格式。
- `ENVELOPE_FROM`: **_empty_**: 在 SMTP 邮件信封上设置的地址作為发件地址。设置為 `<>` 以发送一个空地址。
- `SUBJECT_PREFIX`: **_empty_**: 放置在电子邮件主题行之前的前缀。
- `SENDMAIL_PATH`: **sendmail**: 操作系统上 `sendmail` 的位置(可以是命令或完整路径)。
- `SENDMAIL_ARGS`: **_empty_**: 指定任何额外的 sendmail 參數。(注意:您應該知道电子邮件地址可能看起来像選项 - 如果您的 `sendmail` 命令带有選项,您必須设置選项终止符 `--`
- `SENDMAIL_TIMEOUT`: **5m**: 通過 sendmail 发送电子邮件的默认超时时间。
- `SENDMAIL_CONVERT_CRLF`: **true**: 大多数版本的 sendmail 偏好使用 LF 换行符,而不是 CRLF 换行符。如果您的 sendmail 版本需要 CRLF 换行符,請将此设置為 false。
- `SEND_BUFFER_LEN`: **100**: 邮件队列的缓冲区长度。**已弃用**,請在 `[queue.mailer]` 中使用 `LENGTH`
- `SEND_AS_PLAIN_TEXT`: **false**: 僅以纯文本形式发送邮件,不包括 HTML 备選方案。
## 入站邮件 (`email.incoming`)
- `ENABLED`: **false**: 启用处理入站邮件。
- `REPLY_TO_ADDRESS`: **_empty_**: 包括 `%{token}` 占位符的电子邮件地址,該占位符将根据使用者/操作進行替换。示例:`incoming+%{token}@example.com`。占位符必須出現在地址的使用者部分(在 `@` 之前)。
- `HOST`: **_empty_**: IMAP 服务器主机。
- `PORT`: **_empty_**: IMAP 服务器端口。
- `USERNAME`: **_empty_**: 接收帳戶的使用者名。
- `PASSWORD`: **_empty_**: 接收帳戶的密碼。
- `USE_TLS`: **false**: IMAP 服务器是否使用 TLS。
- `SKIP_TLS_VERIFY`: **false**: 如果设置為 `true`,将完全忽略服务器证书驗證错误。此選项不安全。
- `MAILBOX`: **INBOX**: 入站邮件将到达的邮箱名稱。
- `DELETE_HANDLED_MESSAGE`: **true**: 是否應从邮箱中删除已处理的消息。
- `MAXIMUM_MESSAGE_SIZE`: **10485760**: 要处理的消息的最大大小。忽略更大的消息。将其设置為 0 以允许每种大小。
## 缓存 (`cache`)
- `ADAPTER`: **memory**: 缓存引擎,可以為 `memory`, `redis`, `redis-cluster`, `twoqueue``memcache`. (`twoqueue` 代表缓冲区固定的 LRU 缓存)
- `INTERVAL`: **60**: 垃圾回收间隔(秒),只对`memory``towqueue`有效。
- `HOST`: **_empty_**: 缓存配置。`redis`, `redis-cluster``memcache`配置连接字符串;`twoqueue` 设置队列參數
- Redis: `redis://:macaron@127.0.0.1:6379/0?pool_size=100&idle_timeout=180s`
- Redis-cluster `redis+cluster://:macaron@127.0.0.1:6379/0?pool_size=100&idle_timeout=180s`
- Memcache: `127.0.0.1:9090;127.0.0.1:9091`
- TwoQueue LRU cache: `{"size":50000,"recent_ratio":0.25,"ghost_ratio":0.5}` 或者 `50000`,代表缓冲区的缓存对象容量
- `ITEM_TTL`: **16h**: 缓存项目失效时间,设置為 -1 则禁用缓存
### 缓存 - 最后提交缓存设置 (`cache.last_commit`)
- `ITEM_TTL`: **8760h**: 如果未使用,保持缓存中的项目的时间,将其设置為 -1 会禁用缓存。
- `COMMITS_COUNT`: **1000**: 僅在存儲库的提交计数大于时启用缓存。
## 会话 (`session`)
- `PROVIDER`: **memory**: 会话存儲引擎 \[memory, file, redis, redis-cluster, db, mysql, couchbase, memcache, postgres\]。设置為 `db` 将会重用 `[database]` 的配置信息。
- `PROVIDER_CONFIG`: **data/sessions**: 對於文件,為根路径;對於 db為空将使用数据库配置對於其他引擎為连接字符串。相对路径将根据 _`AppWorkPath`_ 绝对化。
- `COOKIE_SECURE`: **_empty_**: `true``false`。启用此選项以强制在所有会话访问中使用 HTTPS。如果没有设置当 ROOT_URL 是 https 链接的时候默认设置為 true。
- `COOKIE_NAME`: **i_like_gitea**: 用于会话 ID 的 cookie 名稱。
- `GC_INTERVAL_TIME`: **86400**: GC 间隔时间,以秒為單位。
- `SESSION_LIFE_TIME`: **86400**: 会话生命周期,以秒為單位,默认為 864001 天)。
- `DOMAIN`: **_empty_**: 设置 cookie 的域。
- `SAME_SITE`: **lax** \[strict, lax, none\]:為 cookie 设置 SameSite 属性。
## 图像 (`picture`)
- `GRAVATAR_SOURCE`: **gravatar**: 头像来源,可以是 gravatar、duoshuo 或类似 http://cn.gravatar.com/avatar/ 的来源。
`http://cn.gravatar.com/avatar/`
- `DISABLE_GRAVATAR`: **false**: 启用后,只使用内部头像。**已弃用 [v1.18+]** 該配置已迁移到数据库中保存,通過管理员面板進行配置。
- `ENABLE_FEDERATED_AVATAR`: **false**: 启用头像联盟支持(参见
[http://www.libravatar.org](http://www.libravatar.org))。**已弃用 [v1.18+]** 該配置已迁移到数据库中保存,通過管理员面板進行配置。
- `AVATAR_STORAGE_TYPE`: **default**: 在 `[storage.xxx]` 中定义的存儲類型。默认為 `default`,如果没有 `[storage]` 部分,则将读取 `[storage]`,如果没有则将是 `local` 類型。
- `AVATAR_UPLOAD_PATH`: **data/avatars**: 存儲使用者头像图像文件的路径。
- `AVATAR_MAX_WIDTH`: **4096**: 头像的最大宽度,以像素為單位。
- `AVATAR_MAX_HEIGHT`: **4096**: 头像的最大高度,以像素為單位。
- `AVATAR_MAX_FILE_SIZE`: **1048576**1MiB头像的最大大小。
- `AVATAR_MAX_ORIGIN_SIZE`: **262144**256KiB如果上传的文件不大于此字节大小则图像将原样使用無需调整大小/转换。
- `AVATAR_RENDERED_SIZE_FACTOR`: **2**: 渲染的头像图像的乘法因子。较大的值在 HiDPI 设备上会产生更细腻的渲染。
- `REPOSITORY_AVATAR_STORAGE_TYPE`: **default**: 在 `[storage.xxx]` 中定义的存儲類型。默认為 `default`,如果没有 `[storage]` 部分,则将读取 `[storage]`,如果没有则将是 `local` 類型。
- `REPOSITORY_AVATAR_UPLOAD_PATH`: **data/repo-avatars**: 存儲存放庫头像图像文件的路径。
- `REPOSITORY_AVATAR_FALLBACK`: **none**: Gitea 处理缺少存放庫头像的方式
- none = 不显示任何头像
- random = 生成随机头像
- image = 使用默认图像(在 `REPOSITORY_AVATAR_FALLBACK_IMAGE` 中设置),如果设置為 image 並且未上传任何图像。
- `REPOSITORY_AVATAR_FALLBACK_IMAGE`: **/img/repo_default.png**: 作為默认存放庫头像的图像(如果将 `REPOSITORY_AVATAR_FALLBACK` 设置為 image 並且没有上传图像)。
## 项目 (`project`)
默认项目看板的模板:
- `PROJECT_BOARD_BASIC_KANBAN_TYPE`: **待办,進行中,已完成**
- `PROJECT_BOARD_BUG_TRIAGE_TYPE`: **待分析,高优先级,低优先级,已关闭**
## 工單和合並請求的附件 (`attachment`)
- `ENABLED`: **true**: 是否允许使用者上传附件。
- `ALLOWED_TYPES`: **.avif,.cpuprofile,.csv,.dmp,.docx,.fodg,.fodp,.fods,.fodt,.gif,.gz,.jpeg,.jpg,.json,.jsonc,.log,.md,.mov,.mp4,.odf,.odg,.odp,.ods,.odt,.patch,.pdf,.png,.pptx,.svg,.tgz,.txt,.webm,.webp,.xls,.xlsx,.zip**: 允许的文件扩展名(`.zip`、mime 類型(`text/plain`)或通配符類型(`image/*``audio/*``video/*`)的逗号分隔列表。空值或 `*/*` 允许所有類型。
- `MAX_SIZE`: **2048**: 附件的最大限制MB
- `MAX_FILES`: **5**: 一次最多上传的附件数量。
- `STORAGE_TYPE`: **local**: 附件的存儲類型,`local` 表示本地硬碟,`minio` 表示兼容 S3 的对象存儲服务,如果未设置将使用默认值 `local` 或其他在 `[storage.xxx]` 中定义的名稱。
- `SERVE_DIRECT`: **false**: 允许存儲驱动器重定向到经過身份驗證的 URL 以直接提供文件。目前,只支持 Minio/S3 通過签名 URL 提供支持local 不会執行任何操作。
- `PATH`: **attachments**: 存儲附件的路径,僅当 STORAGE_TYPE 為 `local` 时可用。如果是相对路径,将会被解析為 `{AppDataPath}/{attachment.PATH}`.
- `MINIO_ENDPOINT`: **localhost:9000**: Minio 端点以连接,僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_ACCESS_KEY_ID`: Minio accessKeyID 以连接,僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_SECRET_ACCESS_KEY`: Minio secretAccessKey 以连接,僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_BUCKET`: **gitea**: Minio 存儲附件的存儲桶,僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_LOCATION`: **us-east-1**: Minio 存儲桶的位置以建立,僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_BASE_PATH`: **attachments/**: Minio 存儲桶上的基本路径,僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_USE_SSL`: **false**: Minio 启用 SSL僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_INSECURE_SKIP_VERIFY`: **false**: Minio 跳過 SSL 驗證,僅当 STORAGE_TYPE 為 `minio` 时可用。
- `MINIO_CHECKSUM_ALGORITHM`: **default**: Minio 校验算法:`default`(适用于 MinIO 或 AWS S3`md5`(适用于 Cloudflare 或 Backblaze
- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认為`auto`模式,可将其设置為`dns`(虚拟托管样式)或`path`(路径样式),僅当`STORAGE_TYPE``minio`时可用。
## 日志 (`log`)
- `ROOT_PATH`: **_empty_**: 日志文件的根目錄。
- `MODE`: **console**: 日志模式。對於多个模式,請使用逗号分隔。您可以在每个模式的日志子部分中配置每个模式。 `\[log.writer-mode-name\]`.
- `LEVEL`: **Info**: 日志级别。可選值:\[Trace, Debug, Info, Warn, Error, Critical, Fatal, None\]
- `STACKTRACE_LEVEL`: **None**: 记录建立堆栈跟踪的默认日志级别(很少有用,不要设置它)。可選值:\[Trace, Debug, Info, Warn, Error, Critical, Fatal, None\]
- `ENABLE_SSH_LOG`: **false**: 将 SSH 日志保存到日志文件中。
- `logger.access.MODE`: **_empty_**: "access" 记录器
- `logger.router.MODE`: **,**: "router" 记录器,單个逗号表示它将使用上述默认 MODE
- `logger.xorm.MODE`: **,**: "xorm" 记录器
### 访问日志 (`log`)
- `ACCESS_LOG_TEMPLATE`: **`{{.Ctx.RemoteHost}} - {{.Identity}} {{.Start.Format "[02/Jan/2006:15:04:05 -0700]" }} "{{.Ctx.Req.Method}} {{.Ctx.Req.URL.RequestURI}} {{.Ctx.Req.Proto}}" {{.ResponseWriter.Status}} {{.ResponseWriter.Size}} "{{.Ctx.Req.Referer}}" "{{.Ctx.Req.UserAgent}}"`**: 设置用于建立访问日志的模板。
- 可用以下变量:
- `Ctx`: 請求的 `context.Context`
- `Identity`: 登入的 SignedUserName 或 `"-"`(如果未登入)。
- `Start`: 請求的开始时间。
- `ResponseWriter`: 請求的 responseWriter。
- `RequestID`: 与 REQUEST_ID_HEADERS 相匹配的值(默认:如果不匹配则為 `-`)。
- 您必須非常小心,确保此模板不会引发错误或 panic因為此模板在 panic/recovery 脚本之外运行。
- `REQUEST_ID_HEADERS`: **_empty_**: 您可以在这里配置由逗号分隔的多个值。它将按照配置的顺序進行匹配,最终将在访问日志中打印第一个匹配的值。
- 例如:
- 在請求头中X-Request-ID: **test-id-123**
- 在 app.ini 中的配置REQUEST_ID_HEADERS = X-Request-ID
- 在日志中打印127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ...
### 日志子部分 (`log.<writer-mode-name>`)
- `MODE`: **name**: 设置此日志记录器的模式 - 默认為提供的子部分名稱。这允许您在不同级别上具有两个不同的文件日志记录器。
- `LEVEL`: **log.LEVEL**: 设置此日志记录器的日志级别。默认為全局 `[log]` 部分中设置的 `LEVEL`
- `STACKTRACE_LEVEL`: **log.STACKTRACE_LEVEL**: 设置记录堆栈跟踪的日志级别。
- `EXPRESSION`: **""**: 用于匹配函数名稱、文件或消息的正则表达式。默认為空。只有匹配表达式的日志消息才会保存在记录器中。
- `FLAGS`: **stdflags**: 逗号分隔的字符串,表示日志标志。默认為 `stdflags`,表示前缀:`2009/01/23 01:23:23 ...a/b/c/d.go:23:runtime.Caller() [I]: message``none` 表示不要在日志行前缀中添加任何内容。有关更多信息,請参见 `modules/log/flags.go`
- `PREFIX`: **""**: 該记录器中每个日志行的附加前缀。默认為空。
- `COLORIZE`: **false**: 是否為日志行添加颜色
### 控制台日志模式 (`log.console` 或 `MODE=console`)
- 對於控制台记录器,如果不在 Windows 上或终端被确定為能够着色,则 `COLORIZE` 默认為 `true`
- `STDERR`: **false**: 使用 Stderr 而不是 Stdout。
### 文件日志模式 (`log.file` 或 `MODE=file`)
- `FILE_NAME`: 设置此记录器的文件名。默认為 `gitea.log`(例外:访问日志默认為 `access.log`)。如果是相对路径,将相對於 `ROOT_PATH`
- `LOG_ROTATE`: **true**: 旋转日志文件。
- `MAX_SIZE_SHIFT`: **28**: 單个文件的最大大小移位28 表示 256Mb。
- `DAILY_ROTATE`: **true**: 每天旋转日志。
- `MAX_DAYS`: **7**: 在 n 天后删除日志文件
- `COMPRESS`: **true**: 默认使用 gzip 压缩旧的日志文件
- `COMPRESSION_LEVEL`: **-1**: 压缩级别
### 连接日志模式 (`log.conn` 或 `MODE=conn`)
- `RECONNECT_ON_MSG`: **false**: 对每个單独的消息重新连接主机。
- `RECONNECT`: **false**: 当连接丢失时尝试重新连接。
- `PROTOCOL`: **tcp**: 设置协议,可以是 "tcp"、"unix" 或 "udp"。
- `ADDR`: **:7020**: 设置要连接到的地址。
## 定时任务 (`cron`)
- `ENABLED`: **false**: 是否在后台运行定期任务。
- `RUN_AT_START`: **false**: 在應用程序启动时运行定时任务。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 时,任务成功完成时将進行通知。
- `SCHEDULE` 接受的格式:
- 完整的 crontab 语法规范, e.g. `* * * * * ?`
- 描述符 e.g. `@midnight`, `@every 1h30m` ...
- 更多详见: [cron documentation](https://pkg.go.dev/github.com/gogs/cron@v0.0.0-20171120032916-9f6c956d3e14)
### 基本定时任务 - 默认开启
#### 定时任务 - 删除旧的存放庫存檔 (`cron.archive_cleanup`)
- `ENABLED`: **true**: 是否启用該定时任务。
- `RUN_AT_START`: **true**: 设置在服务启动时运行。
- `SCHEDULE`: **@midnight**: 使用 Cron 语法的定时任务触发配置,例如 `@every 1h`
- `OLDER_THAN`: **24h**: 超過`OLDER_THAN`时间的存檔将被删除,例如 `12h`
#### 定时任务 - 更新镜像存放庫 (`cron.update_mirrors`)
- `SCHEDULE`: **@every 10m**: 使用 Cron 语法的定时任务触发配置,例如 `@every 3h`
- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制為此数字负值表示無限制0 将导致不会将镜像加入队列,从而有效地禁用镜像更新)。
- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制為此数字负值表示無限制0 将导致不会将镜像加入队列,从而有效地禁用镜像更新)。
#### 定时任务 - 健康检查所有存放庫 (`cron.repo_health_check`)
- `SCHEDULE`: **@midnight**: Cron 语法,用于安排存放庫健康检查。
- `TIMEOUT`: **60s**: 用于健康检查執行超时的时间持续语法。
- `ARGS`: **_empty_**: `git fsck` 命令的參數,例如 `--unreachable --tags`。在 http://git-scm.com/docs/git-fsck 上了解更多。
#### 定时任务 - 检查所有存放庫统计 (`cron.check_repo_stats`)
- `RUN_AT_START`: **true**: 在启动时运行存放庫统计检查。
- `SCHEDULE`: **@midnight**: Cron 语法,用于安排存放庫统计检查。
#### 定时任务 - 清理 hook_task 表 (`cron.cleanup_hook_task_table`)
- `ENABLED`: **true**: 启用清理 hook_task 任务。
- `RUN_AT_START`: **false**: 在启动时运行清理 hook_task如果启用
- `SCHEDULE`: **@midnight**: Cron 语法,用于清理 hook_task 表。
- `CLEANUP_TYPE` **OlderThan** OlderThan 或 PerWebhook 方法来清理 hook_task可以按年龄即 hook_task 记录传递多久)或按每个 Webhook 保留的数量(即每个 Webhook 保留最新的 x 个传递)来清理。
- `OLDER_THAN`: **168h**: 如果 CLEANUP_TYPE 设置為 OlderThan则早于此表达式的任何传递的 hook_task 记录将被删除。
- `NUMBER_TO_KEEP`: **10**: 如果 CLEANUP_TYPE 设置為 PerWebhook则 Webhook 的此数量 hook_task 记录将被保留(即保留最新的 x 个传递)。
#### Cron - 清理過期的包 (`cron.cleanup_packages`)
- `ENABLED`: **true**: 启用清理過期包任务。
- `RUN_AT_START`: **true**: 在启动时运行任务(如果启用)。
- `NOTICE_ON_SUCCESS`: **false**: 每次运行此任务时都会通知。
- `SCHEDULE`: **@midnight**: Cron 语法,用于任务。
- `OLDER_THAN`: **24h**: 未引用的包数据建立超過 OLDER_THAN 时间的包将被删除。
#### Cron - 更新迁移海报 ID (`cron.update_migration_poster_id`)
- `SCHEDULE`: **@midnight** : 同步之间的间隔作為持续时间,每次实例启动时都会尝试同步。
#### Cron - 同步外部使用者 (`cron.sync_external_users`)
- `SCHEDULE`: **@midnight** : 同步之间的间隔作為持续时间,每次实例启动时都会尝试同步。
- `UPDATE_EXISTING`: **true**: 建立新使用者,更新現有使用者数据,並禁用不再在外部源中的使用者(默认设置)或僅在 UPDATE_EXISTING 设置為 false 时建立新使用者。
### 扩展的定时任务(默认未启用)
#### Cron - 垃圾收集所有存放庫 (`cron.git_gc_repos`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `SCHEDULE`: **@every 72h**: Cron 语法,用于安排存放庫存檔清理,例如 `@every 1h`
- `TIMEOUT`: **60s**: 用于垃圾收集執行超时的时间持续语法。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 以打开成功通知。
- `ARGS`: **_empty_**: `git gc` 命令的參數,例如 `--aggressive --auto`。默认值与 [git] -> GC_ARGS 相同。
#### Cron - 使用 Gitea SSH 密钥更新 '.ssh/authorized_keys' 文件 (`cron.resync_all_sshkeys`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 以打开成功通知。
- `SCHEDULE`: **@every 72h**: Cron 语法,用于安排存放庫存檔清理,例如 `@every 1h`
#### Cron - 重新同步所有存放庫的 pre-receive、update 和 post-receive 钩子 (`cron.resync_all_hooks`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 以打开成功通知。
- `SCHEDULE`: **@every 72h**: Cron 语法,用于安排存放庫存檔清理,例如 `@every 1h`
#### Cron - 重新初始化所有缺失的 Git 存放庫,但记录已存在 (`cron.reinit_missing_repos`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 以打开成功通知。
- `SCHEDULE`: **@every 72h**: Cron 语法,用于安排存放庫存檔清理,例如 `@every 1h`
#### Cron - 删除所有缺少 Git 文件的存放庫 (`cron.delete_missing_repos`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 以打开成功通知。
- `SCHEDULE`: **@every 72h**: Cron 语法,用于安排存放庫存檔清理,例如 `@every 1h`
#### Cron - 删除生成的存放庫头像 (`cron.delete_generated_repository_avatars`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 以打开成功通知。
- `SCHEDULE`: **@every 72h**: Cron 语法,用于安排存放庫存檔清理,例如 `@every 1h`
#### Cron - 从数据库中删除所有旧的操作 (`cron.delete_old_actions`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `NOTICE_ON_SUCCESS`: **false**: 设置為 true 以打开成功通知。
- `SCHEDULE`: **@every 168h**: Cron 语法,用于设置多长时间進行检查。
- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除,建议使用 `8760h`1 年),因為这是热力图的最大长度。
#### Cron - 从数据库中删除所有旧的系统通知 (`cron.delete_old_system_notices`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `NO_SUCCESS_NOTICE`: **false**: 设置為 true 以关闭成功通知。
- `SCHEDULE`: **@every 168h**: Cron 语法,用于设置多长时间進行检查。
- `OLDER_THAN`: **8760h**: 早于此表达式的任何系统通知都将从数据库中删除。
#### Cron - 在存放庫中回收 LFS 指针 (`cron.gc_lfs`)
- `ENABLED`: **false**: 启用服务。
- `RUN_AT_START`: **false**: 在启动时运行任务(如果启用)。
- `SCHEDULE`: **@every 24h**: Cron 语法,用于设置多长时间進行检查。
- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间(默认 7 天)的 LFSMetaObject。
- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超過此时间(默认 3 天)没有尝试過回收的 LFSMetaObject。
- `NUMBER_TO_CHECK_PER_REPO`: **100**: 每个存放庫要检查的過期 LFSMetaObject 的最小数量。设置為 `0` 以始终检查所有。
## Git (`git`)
- `PATH`: **""**: Git 可執行文件的路径。如果為空Gitea 将在 PATH 环境中搜索。
- `HOME_PATH`: **`{APP_DATA_PATH}/home`**: Git 的 HOME 目錄。
此目錄将用于包含 Gitea 的 git 调用将使用的`.gitconfig`和可能的`.gnupg`目錄。如果您可以确认 Gitea 是在此环境中唯一运行的應用程序,您可以将其设置為 Gitea 使用者的正常主目錄。
- `DISABLE_DIFF_HIGHLIGHT`: **false**: 禁用已添加和已删除更改的高亮显示。
- `MAX_GIT_DIFF_LINES`: **1000**: 在 diff 视图中允许單个文件的最大行数。
- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在 diff 视图中每行的最大字符数。
- `MAX_GIT_DIFF_FILES`: **100**: 在 diff 视图中显示的最大文件数。
- `COMMITS_RANGE_SIZE`: **50**: 设置默认的提交范围大小
- `BRANCHES_RANGE_SIZE`: **20**: 设置默认的分支范围大小
- `GC_ARGS`: **_empty_**: 命令`git gc`的參數,例如`--aggressive --auto`。更多信息請参见http://git-scm.com/docs/git-gc/
- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用 Git 版本 >= 2.18 时使用 Git wire 协议版本 2默认為 true当您始终希望使用 Git wire 协议版本 1 时设置為 false。
要在使用 OpenSSH 服务器的情况下為通過 SSH 的 Git 启用此功能,請将`AcceptEnv GIT_PROTOCOL`添加到您的 sshd_config 文件中。
- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 對於推送到非默认分支的響應,使用 URL 建立拉取請求(如果启用了該存儲库的拉取請求)
- `VERBOSE_PUSH`: **true**: 在处理推送时打印有关推送状态的信息。
- `VERBOSE_PUSH_DELAY`: **5s**: 僅在推送时间超過此延迟时才打印详细信息。
- `LARGE_OBJECT_THRESHOLD`: **1048576**: (僅限于 Go-Git不要在内存中缓存大于此大小的对象。设置為 0 以禁用。)
- `DISABLE_CORE_PROTECT_NTFS`: **false**`core.protectNTFS`强制设置為 false。
- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆進行 git。
### Git - 超时设置 (`git.timeout`)
- `DEFAULT`: **360**: Git 操作的默认超时时间,單位秒
- `MIGRATE`: **600**: 在迁移外部存儲库时的超时时间,單位秒
- `MIRROR`: **300**: 在镜像外部存儲库时的超时时间,單位秒
- `CLONE`: **300**: 在存儲库之间進行内部克隆的超时时间,單位秒
- `PULL`: **300**: 在存儲库之间進行内部拉取的超时时间,單位秒
- `GC`: **60**: git 存儲库 GC 的超时时间,單位秒
### Git - 配置選项 (`git.config`)
此部分中的键/值对将用作 git 配置。
此部分僅執行“设置”配置,从此部分中删除的配置键不会自动从 git 配置中删除。格式為`some.configKey = value`
- `diff.algorithm`: **histogram**
- `core.logAllRefUpdates`: **true**
- `gc.reflogExpire`: **90**
## 指标 (`metrics`)
- `ENABLED`: **false**: 启用/prometheus 的 metrics 端点。
- `ENABLED_ISSUE_BY_LABEL`: **false**: 启用按標籤统计问题,格式為`gitea_issues_by_label{label="bug"} 2`
- `ENABLED_ISSUE_BY_REPOSITORY`: **false**: 启用按存儲库统计问题,格式為`gitea_issues_by_repository{repository="org/repo"} 5`
- `TOKEN`: **_empty_**: 如果要在授权中包含指标,则需要指定令牌。相同的令牌需要在 prometheus 參數`bearer_token``bearer_token_file`中使用。
## API (`api`)
- `ENABLE_SWAGGER`: **true**: 启用 API 文檔接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。
- `MAX_RESPONSE_ITEMS`: **50**: API 分页的最大單页项目数。
- `DEFAULT_PAGING_NUM`: **30**: API 分页的默认分页数。
- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API 的默认單页项目数。
- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API 的默认最大文件大小。
## OAuth2 (`oauth2`)
- `ENABLED`: **true**: 启用 OAuth2 提供者。
- `ACCESS_TOKEN_EXPIRATION_TIME`**3600**: OAuth2 访问令牌的生命周期,以秒為單位。
- `REFRESH_TOKEN_EXPIRATION_TIME`**730**: OAuth2 刷新令牌的生命周期,以小时為單位。
- `INVALIDATE_REFRESH_TOKENS`**false**: 检查刷新令牌是否已被使用。
- `JWT_SIGNING_ALGORITHM`**RS256**: 用于签署 OAuth2 令牌的算法。有效值:[`HS256``HS384``HS512``RS256``RS384``RS512``ES256``ES384``ES512`]。
- `JWT_SECRET`**_empty_**: OAuth2 访问和刷新令牌的身份驗證密钥,請将其更改為唯一的字符串。僅当`JWT_SIGNING_ALGORITHM`设置為`HS256``HS384``HS512`时才需要此设置。
- `JWT_SECRET_URI`**_empty_**: 可以使用此配置選项,而不是在配置中定义`JWT_SECRET`,以向 Gitea 提供包含密钥的文件的路径(示例值:`file:/etc/gitea/oauth2_jwt_secret`)。
- `JWT_SIGNING_PRIVATE_KEY_FILE`**jwt/private.pem**: 用于签署 OAuth2 令牌的私钥文件路径。路径相對於`APP_DATA_PATH`。僅当`JWT_SIGNING_ALGORITHM`设置為`RS256``RS384``RS512``ES256``ES384``ES512`时才需要此设置。文件必須包含 PKCS8 格式的 RSA 或 ECDSA 私钥。如果不存在密钥,则将為您建立一个 4096 位密钥。
- `MAX_TOKEN_LENGTH`**32767**: 从 OAuth2 提供者接受的令牌/cookie 的最大长度。
- `DEFAULT_APPLICATIONS`**git-credential-oauthgit-credential-manager, tea**: 在启动时预注册用于某些服务的 OAuth 應用程序。有关可用選项列表,請参阅[OAuth2 文檔](/development/oauth2-provider.md)。
## i18n (`i18n`)
- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**:
在语言選择器中显示的区域设置列表。如果使用者浏览器的语言与列表中的任何区域设置不匹配,则将使用第一个区域设置作為默认值。
- `NAMES`**English,简體中文,繁體中文(香港),繁體中文(台灣),Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**:
对應于各区域设置的可见名稱。
## Markup (`markup`)
- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置 Mermaid 源的最大大小。(设為-1 代表禁止)
gitea 支持外部渲染工具,你可以配置你熟悉的文檔渲染工具. 比如一下将新增一个名字為 asciidoc 的渲染工具。
```ini
[markup.asciidoc]
ENABLED = true
NEED_POSTPROCESS = true
FILE_EXTENSIONS = .adoc,.asciidoc
RENDER_COMMAND = "asciidoctor --embedded --safe-mode=secure --out-file=- -"
IS_INPUT_FILE = false
```
- ENABLED**false** 设置是否启动渲染器
- NEED_POSTPROCESS**true** 设置為**true**以替换链接/SHA1 等。
- FILE*EXTENSIONS\*\*\_empty*\*\* 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。
- RENDER_COMMAND用于渲染所有匹配的扩展名的外部命令。
- IS_INPUT_FILE**false** 输入不是标准输入,而是一个在`RENDER_COMMAND`之后带有文件參數的文件。
- RENDER_CONTENT_MODE**sanitized** 内容将如何呈現。
- sanitized对内容進行清理並在当前页面内呈現默认僅允许一些 HTML 標籤和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理規則。
- no-sanitizer禁用清理程序在当前页面内呈現内容。这是**不安全**的,如果内容包含恶意代码,可能会导致 XSS 攻擊。
- iframe在單独的独立页面中呈現内容並通過 iframe 嵌入到当前页面中。iframe 处于禁用同源策略的沙箱模式,並且 JS 代码与父页面安全隔离。
两个特殊的环境变量会传递给渲染命令:
- `GITEA_PREFIX_SRC`,其中包含`src`路径树中的当前 URL 前缀。用作链接的前缀。
- `GITEA_PREFIX_RAW`,其中包含`raw`路径树中的当前 URL 前缀。用作图像路径的前缀。
如果`RENDER_CONTENT_MODE``sanitized`Gitea 支持自定义用于呈現的 HTML 的清理策略。下面的示例将支持来自 pandoc 的 KaTeX 输出。
```ini
[markup.sanitizer.TeX]
; Pandoc renders TeX segments as <span>s with the "math" class, optionally
; with "inline" or "display" classes depending on context.
ELEMENT = span
ALLOW_ATTR = class
REGEXP = ^\s*((math(\s+|$)|inline(\s+|$)|display(\s+|$)))+
ALLOW_DATA_URI_IMAGES = true
```
- `ELEMENT`:此策略适用于的元素。必須非空。
- `ALLOW_ATTR`:此策略允许的属性。必須非空。
- `REGEXP`:用于匹配属性内容的正则表达式。必須存在,但可以為空,以無条件允许此属性的白名單。
- `ALLOW_DATA_URI_IMAGES`**false** 允许数据 URI 图像(`<img src="data:image/png;base64,..."/>`)。
可以通過添加唯一的子节来定义多个清理規則,例如`[markup.sanitizer.TeX-2]`
要僅為指定的外部渲染器應用清理規則,它们必須使用渲染器名稱,例如`[markup.sanitizer.asciidoc.rule-1]`
如果規則在渲染器 ini 节之上定义,或者名稱与渲染器不匹配,则應用于每个渲染器。
## 代码高亮映射 (`highlight.mapping`)
- `file_extension 比如 .toml`: **language 比如 ini**。文件扩展名到语言的映射覆盖。
- Gitea 将使用 `.gitattributes` 文件中的 `linguist-language``gitlab-language` 属性来对文件進行高亮显示,如果可用。
如果未设置此属性或语言不可用,则将查找文件扩展名在此映射中或使用启发式方法来确定文件類型。
## 时间 (`time`)
- `DEFAULT_UI_LOCATION`:在 UI 上的默认时间位置,以便我们可以在 UI 上显示正确的使用者时间。例如Asia/Shanghai
## 迁移 (`migrations`)
- `MAX_ATTEMPTS`**3**: 每次 http/https 請求的最大尝试次数(用于迁移)。
- `RETRY_BACKOFF`**3**: 每次 http/https 請求重试的退避时间(秒)。
- `ALLOWED_DOMAINS`**_empty_**: 允许迁移存放庫的域名允许列表,默认為空。这意味着允许外部网址。多个域名可以用逗号分隔。支持通配符:`github.com, *.github.com`
- `BLOCKED_DOMAINS`**_empty_**: 阻止迁移存放庫的域名阻止列表,默认為空。多个域名可以用逗号分隔。当 `ALLOWED_DOMAINS` 不為空时,此選项优先级较高,用于拒绝域名。支持通配符。
- `ALLOW_LOCALNETWORKS`**false**: 允许 RFC 1918、RFC 1122、RFC 4632 和 RFC 4291 中定义的私有地址。如果域名被 `ALLOWED_DOMAINS` 允许,此選项将被忽略。
- `SKIP_TLS_VERIFY`**false**: 允许跳過 TLS 驗證。
## 联邦(`federation`
- `ENABLED`**false**: 启用/禁用联邦功能。
- `SHARE_USER_STATISTICS`**true**: 如果启用联邦,则启用/禁用节点信息的使用者统计信息。
- `MAX_SIZE`**4**: 联邦請求和響應的最大大小MB
警告:更改以下设置可能会破坏联邦功能。
- `ALGORITHMS`**rsa-sha256, rsa-sha512, ed25519**: HTTP 签名算法。
- `DIGEST_ALGORITHM`**SHA-256**: HTTP 签名摘要算法。
- `GET_HEADERS`**(request-target), Date**: 用于联邦請求的 GET 头部。
- `POST_HEADERS`**(request-target), Date, Digest**: 用于联邦請求的 POST 头部。
## 包(`packages`
- `ENABLED`**true**: 启用/禁用包註冊表功能。
- `CHUNKED_UPLOAD_PATH`**tmp/package-upload**: 分块上传的路径。默认為 `APP_DATA_PATH` + `tmp/package-upload`
- `LIMIT_TOTAL_OWNER_COUNT`**-1**: 單个所有者可以拥有的包版本的最大数量(`-1` 表示無限制)。
- `LIMIT_TOTAL_OWNER_SIZE`**-1**: 單个所有者可以使用的包的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_ALPINE`**-1**: Alpine 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_CARGO`**-1**: Cargo 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_CHEF`**-1**: Chef 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_COMPOSER`**-1**: Composer 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_CONAN`**-1**: Conan 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_CONDA`**-1**: Conda 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_CONTAINER`**-1**: Container 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_CRAN`**-1**: CRAN 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_DEBIAN`**-1**: Debian 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_GENERIC`**-1**: 通用上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_GO`**-1**: Go 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_HELM`**-1**: Helm 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_MAVEN`**-1**: Maven 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_NPM`**-1**: npm 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_NUGET`**-1**: NuGet 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_PUB`**-1**: Pub 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_PYPI`**-1**: PyPI 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_RPM`**-1**: RPM 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_RUBYGEMS`**-1**: RubyGems 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_SWIFT`**-1**: Swift 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
- `LIMIT_SIZE_VAGRANT`**-1**: Vagrant 上传的最大大小(`-1` 表示無限制,格式為 `1000``1 MB``1 GiB`)。
## 镜像(`mirror`
- `ENABLED`**true**: 启用镜像功能。设置為 **false** 以禁用所有镜像。预先存在的镜像保持有效,但不会更新;可以转换為常规存放庫。
- `DISABLE_NEW_PULL`**false**: 禁用建立**新的**拉取镜像。预先存在的镜像保持有效。如果 `mirror.ENABLED``false`,将被忽略。
- `DISABLE_NEW_PUSH`**false**: 禁用建立**新的**推送镜像。预先存在的镜像保持有效。如果 `mirror.ENABLED``false`,将被忽略。
- `DEFAULT_INTERVAL`**8h**: 每次检查之间的默认间隔。
- `MIN_INTERVAL`**10m**: 检查的最小间隔。(必須大于 1 分钟)。
## LFS (`lfs`)
用于 lfs 数据的存儲配置。当将 `STORAGE_TYPE` 设置為 `xxx` 时,它将从默认的 `[storage]``[storage.xxx]` 派生。
当派生时,`PATH` 的默认值是 `data/lfs``MINIO_BASE_PATH` 的默认值是 `lfs/`
- `STORAGE_TYPE`**local**: lfs 的存儲類型,`local` 表示本地硬碟,`minio` 表示 S3 兼容对象存儲服务,或者使用 `[storage.xxx]` 中定义的其他名稱。
- `SERVE_DIRECT`**false**: 允许存儲驱动程序重定向到经過身份驗證的 URL 以直接提供文件。目前,僅支持通過签名的 URL 提供 Minio/S3本地不執行任何操作。
- `PATH`**./data/lfs**: 存儲 LFS 文件的位置,僅在 `STORAGE_TYPE``local` 时可用。如果未设置,则回退到 `[server]` 部分中已弃用的 `LFS_CONTENT_PATH` 值。
- `MINIO_ENDPOINT`**localhost:9000**: 连接的 Minio 终端点,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_ACCESS_KEY_ID`Minio 的 accessKeyID僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_SECRET_ACCESS_KEY`Minio 的 secretAccessKey僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_BUCKET`**gitea**: 用于存儲 lfs 的 Minio 桶,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_LOCATION`**us-east-1**: 建立桶的 Minio 位置,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_BASE_PATH`**lfs/**: 桶上的 Minio 基本路径,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_USE_SSL`**false**: Minio 启用 ssl僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_INSECURE_SKIP_VERIFY`**false**: Minio 跳過 SSL 驗證,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认為`auto`模式,可将其设置為`dns`(虚拟托管样式)或`path`(路径样式),僅当`STORAGE_TYPE``minio`时可用。
## 存儲 (`storage`)
默认的附件、lfs、头像、存放庫头像、存放庫归檔、軟體包、操作日志、artifacts 的存儲配置。推荐僅僅配置此 section 並让其它的 section 从此配置项继承。
- `STORAGE_TYPE`**local**: 存儲類型,`local` 表示本地硬碟,`minio` 表示 S3`azureblob` 表示 azure 对象存儲。
- `SERVE_DIRECT`**false**: 允许存儲驱动程序重定向到经過身份驗證的 URL 以直接提供文件。目前,僅支持通過签名的 URL 提供 Minio/S3本地不執行任何操作。
- `MINIO_ENDPOINT`**localhost:9000**: 连接的 Minio 终端点,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_ACCESS_KEY_ID`Minio 的 accessKeyID僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_SECRET_ACCESS_KEY`Minio 的 secretAccessKey僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_BUCKET`**gitea**: 用于存儲数据的 Minio 桶,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_LOCATION`**us-east-1**: 建立桶的 Minio 位置,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_USE_SSL`**false**: Minio 启用 ssl僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_INSECURE_SKIP_VERIFY`**false**: Minio 跳過 SSL 驗證,僅在 `STORAGE_TYPE``minio` 时可用。
- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认為`auto`模式,可将其设置為`dns`(虚拟托管样式)或`path`(路径样式),僅当`STORAGE_TYPE``minio`时可用。
- `AZURE_BLOB_ENDPOINT`: **_empty_**: Azure Blob 终端点,僅在 `STORAGE_TYPE``azureblob` 时可用。例如https://accountname.blob.core.windows.net 或 http://127.0.0.1:10000/devstoreaccount1
- `AZURE_BLOB_ACCOUNT_NAME`: **_empty_**: Azure Blob 账号名,僅在 `STORAGE_TYPE``azureblob` 时可用。
- `AZURE_BLOB_ACCOUNT_KEY`: **_empty_**: Azure Blob 访问密钥,僅在 `STORAGE_TYPE``azureblob` 时可用。
- `AZURE_BLOB_CONTAINER`: **gitea**: 用于存儲数据的 Azure Blob 容器名,僅在 `STORAGE_TYPE``azureblob` 时可用。
建议的 minio 存儲配置如下:
```ini
[storage]
STORAGE_TYPE = minio
; Minio endpoint to connect only available when STORAGE_TYPE is `minio`
MINIO_ENDPOINT = localhost:9000
; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`
MINIO_ACCESS_KEY_ID =
; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
MINIO_SECRET_ACCESS_KEY =
; Minio bucket to store the attachments only available when STORAGE_TYPE is `minio`
MINIO_BUCKET = gitea
; Minio location to create bucket only available when STORAGE_TYPE is `minio`
MINIO_LOCATION = us-east-1
; Minio enabled ssl only available when STORAGE_TYPE is `minio`
MINIO_USE_SSL = false
; Minio skip SSL verification available when STORAGE_TYPE is `minio`
MINIO_INSECURE_SKIP_VERIFY = false
SERVE_DIRECT = true
; Minio bucket lookup method defaults to auto mode; set it to `dns` for virtual host style or `path` for path style, only available when STORAGE_TYPE is `minio`
MINIO_BUCKET_LOOKUP_TYPE = auto
```
默认情况下,每个存儲都有其默认的基本路径,如下所示:
| storage | default base path |
| ----------------- | ------------------ |
| attachments | attachments/ |
| lfs | lfs/ |
| avatars | avatars/ |
| repo-avatars | repo-avatars/ |
| repo-archive | repo-archive/ |
| packages | packages/ |
| actions_log | actions_log/ |
| actions_artifacts | actions_artifacts/ |
並且桶bucket、基本路径或`SERVE_DIRECT`可以是特殊的或被覆盖的,如果您想要使用不同的设置,您可以:
```ini
[storage.actions_log]
MINIO_BUCKET = gitea_actions_log
SERVE_DIRECT = true
MINIO_BASE_PATH = my_actions_log/ ; default is actions_log/ if blank
```
如果您想為' lfs '自定义一个不同的存儲,如果上面定义了默认存儲
```ini
[lfs]
STORAGE_TYPE = my_minio
[storage.my_minio]
STORAGE_TYPE = minio
; Minio endpoint to connect only available when STORAGE_TYPE is `minio`
MINIO_ENDPOINT = localhost:9000
; Minio accessKeyID to connect only available when STORAGE_TYPE is `minio`
MINIO_ACCESS_KEY_ID =
; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
MINIO_SECRET_ACCESS_KEY =
; Minio bucket to store the attachments only available when STORAGE_TYPE is `minio`
MINIO_BUCKET = gitea
; Minio location to create bucket only available when STORAGE_TYPE is `minio`
MINIO_LOCATION = us-east-1
; Minio enabled ssl only available when STORAGE_TYPE is `minio`
MINIO_USE_SSL = false
; Minio skip SSL verification available when STORAGE_TYPE is `minio`
MINIO_INSECURE_SKIP_VERIFY = false
; Minio bucket lookup method defaults to auto mode; set it to `dns` for virtual host style or `path` for path style, only available when STORAGE_TYPE is `minio`
MINIO_BUCKET_LOOKUP_TYPE = auto
```
### 存儲库归檔存儲 (`storage.repo-archive`)
存儲库归檔存儲的配置。当将`STORAGE_TYPE`设置為`xxx`时,它将继承默认的 `[storage]``[storage.xxx]` 配置。`PATH`的默认值是`data/repo-archive``MINIO_BASE_PATH`的默认值是`repo-archive/`
- `STORAGE_TYPE`: **local**: 存儲類型,`local`表示本地硬碟,`minio`表示与 S3 兼容的对象存儲服务,或者使用定义為`[storage.xxx]`的其他名稱。
- `SERVE_DIRECT`: **false**: 允许存儲驱动程序重定向到经過身份驗證的 URL 以直接提供文件。目前,只有 Minio/S3 支持通過签名 URL本地不執行任何操作。
- `PATH`: **./data/repo-archive**: 用于存儲归檔文件的位置,僅在`STORAGE_TYPE``local`时可用。
- `MINIO_ENDPOINT`: **localhost:9000**: Minio 端点,僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_ACCESS_KEY_ID`: Minio 的 accessKeyID僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_SECRET_ACCESS_KEY`: Minio 的 secretAccessKey僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_BUCKET`: **gitea**: 用于存儲归檔的 Minio 存儲桶,僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_LOCATION`: **us-east-1**: 用于建立存儲桶的 Minio 位置,僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_BASE_PATH`: **repo-archive/**: 存儲桶上的 Minio 基本路径,僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_USE_SSL`: **false**: 启用 Minio 的 SSL僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳過 Minio 的 SSL 驗證,僅在`STORAGE_TYPE``minio`时可用。
- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认為`auto`模式,可将其设置為`dns`(虚拟托管样式)或`path`(路径样式),僅当`STORAGE_TYPE``minio`时可用。
### 存儲库归檔 (`repo-archive`)
- `STORAGE_TYPE`: **local**: 存儲類型,用于操作日志,`local`表示本地硬碟,`minio`表示与 S3 兼容的对象存儲服务,默认為`local`,或者使用定义為`[storage.xxx]`的其他名稱。
- `MINIO_BASE_PATH`: **repo-archive/**: Minio 存儲桶上的基本路径,僅在`STORAGE_TYPE``minio`时可用。
## 代理 (`proxy`)
- `PROXY_ENABLED`: **false**: 启用代理,如果為 true所有通過 HTTP 向外部的請求都将受到影響,如果為 false即使环境设置了 http_proxy/https_proxy 也不会使用
- `PROXY_URL`: **_empty_**: 代理服务器地址,支持 http://, https//, socks://,為空则不启用代理而使用环境变量中的 http_proxy/https_proxy
- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址,支持 \* 号匹配符号, \*\* 表示匹配所有网站
i.e.
```ini
PROXY_ENABLED = true
PROXY_URL = socks://127.0.0.1:1080
PROXY_HOSTS = *.github.com
```
## Actions (`actions`)
- `ENABLED`: **true**: 启用/禁用操作功能
- `DEFAULT_ACTIONS_URL`: **github**: 获取操作插件的默认平台,`github`表示`https://github.com``self`表示当前的 Gitea 实例。
- `STORAGE_TYPE`: **local**: 用于操作日志的存儲類型,`local`表示本地硬碟,`minio`表示与 S3 兼容的对象存儲服务,默认為`local`,或者使用定义為`[storage.xxx]`的其他名稱。
- `MINIO_BASE_PATH`: **actions_log/**: Minio 存儲桶上的基本路径,僅在`STORAGE_TYPE``minio`时可用。
- `LOG_RETENTION_DAYS`: **365**: 日志保留时间(天)。此期限后将删除旧日志。
- `LOG_COMPRESSION`: **zstd**: 日志压缩方式,`none`表示不压缩,`zstd`表示 zstd 压缩。
其它的压缩方式如`gzip`是不支持的,因為查看日志需要可寻址流。
如果 CPU 或内存不是瓶颈,建议在使用本地硬碟作為日志存儲时总是使用压缩。
對於像 S3 这样的会对請求次数计费的对象存儲服务,每次查看日志会导致额外的 2 次获取請求。
但它将节省存儲空间和网络带宽,因此仍然建议使用压缩。
- `ARTIFACT_RETENTION_DAYS`: **90**: 保留 artifacts 的默认天数。可以通過在`actions/upload-artifact`步骤中设置`retention-days`選项来指定 artifacts 的保留期。
- `ZOMBIE_TASK_TIMEOUT`: **10m**: 僵尸任务超时时间,指具有运行状态但长时间未更新的任务。
- `ENDLESS_TASK_TIMEOUT`: **3h**: 無尽任务超时时间,指具有运行状态並持续更新,但长时间未结束的任务。
- `ABANDONED_JOB_TIMEOUT`: **24h**: 被遗弃的作业超时时间,指具有等待状态但长时间未被 runner 選中並執行的作业。
- `SKIP_WORKFLOW_STRINGS`: **[skip ci],[ci skip],[no ci],[skip actions],[actions skip]**: 提交者可以在提交消息或 PR 标题中放置的字符串,以跳過執行相應的工作流。
`DEFAULT_ACTIONS_URL` 指示 Gitea 操作运行程序應該在哪里找到带有相对路径的操作。
例如,`uses: actions/checkout@v4` 表示 `https://github.com/actions/checkout@v4`,因為 `DEFAULT_ACTIONS_URL` 的值為 `github`
它可以更改為 `self`,以使其成為 `root_url_of_your_gitea/actions/checkout@v4`
請注意,對於大多数情况,不建议使用 `self`,因為它可能使名稱在全局范围内产生歧义。
此外,它要求您将所有所需的操作镜像到您的 Gitea 实例,这可能不值得。
因此,請僅在您了解自己在做什么的情况下使用 `self`
在早期版本(`<= 1.19`)中,`DEFAULT_ACTIONS_URL` 可以设置為任何自定义 URL例如 `https://gitea.com``http://your-git-server,https://gitea.com`,默认值為 `https://gitea.com`
然而,后来的更新删除了这些選项,現在唯一的選项是 `github``self`,默认值為 `github`
但是,如果您想要使用其他 Git 服务器中的操作,您可以在 `uses` 字段中使用完整的 URLGitea 支持此功能GitHub 不支持)。
例如 `uses: https://gitea.com/actions/checkout@v4``uses: http://your-git-server/actions/checkout@v4`
## 其他 (`other`)
- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示 Gitea 的版本。
- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: 在页脚显示模板執行的时间。
- `SHOW_FOOTER_POWERED_BY`: **true**: 在页脚显示“由...提供动力”的文本。
- `ENABLE_SITEMAP`: **true**: 生成 sitemap.
- `ENABLE_FEED`: **true**: 是否启用 RSS/Atom