mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-15 22:33:45 +00:00
zh-cn translation for administration docs (#24881)
- [x] adding-legal-pages - [x] cmd-embedded - [x] command-line - [x] email-setup - [x] external-renderers - [x] git-lfs-support - [x] logging-config - [x] mail-templates - [x] repo-indexer - [x] search-engines-indexation - [x] signing
This commit is contained in:
1 parent
7554a13593
commit
6c3882969e
11 files changed
+1820
No files matched your search
@@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "添加法律页面"
|
||||||
|
slug: adding-legal-pages
|
||||||
|
weight: 110
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/adding-legal-pages
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "添加法律页面"
|
||||||
|
identifier: "adding-legal-pages"
|
||||||
|
weight: 110
|
||||||
|
---
|
||||||
|
|
||||||
|
一些法域(例如欧盟)要求在网站上添加特定的法律页面(例如隐私政策)。按照以下步骤将它们添加到你的 Gitea 实例中。
|
||||||
|
|
||||||
|
## 获取页面
|
||||||
|
|
||||||
|
Gitea 源代码附带了示例页面,位于 `contrib/legal` 目录中。将它们复制到 `custom/public/` 目录下。例如,如果要添加隐私政策:
|
||||||
|
|
||||||
|
```
|
||||||
|
wget -O /path/to/custom/public/privacy.html https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/legal/privacy.html.sample
|
||||||
|
```
|
||||||
|
|
||||||
|
现在,你需要编辑该页面以满足你的需求。特别是,你必须更改电子邮件地址、网址以及与 "Your Gitea Instance" 相关的引用,以匹配你的情况。
|
||||||
|
|
||||||
|
请务必不要放置会暗示 Gitea 项目对你的服务器负责的一般服务条款或隐私声明。
|
||||||
|
|
||||||
|
## 使其可见
|
||||||
|
|
||||||
|
创建或追加到 `/path/to/custom/templates/custom/extra_links_footer.tmpl` 文件中:
|
||||||
|
|
||||||
|
```go
|
||||||
|
<a class="item" href="{{AppSubUrl}}/assets/privacy.html">隐私政策</a>
|
||||||
|
```
|
||||||
|
|
||||||
|
重启 Gitea 以查看更改。
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "嵌入资源提取工具"
|
||||||
|
slug: "cmd-embedded"
|
||||||
|
weight: 20
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/cmd-embedded
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "嵌入资源提取工具"
|
||||||
|
weight: 20
|
||||||
|
identifier: "cmd-embedded"
|
||||||
|
---
|
||||||
|
|
||||||
|
# 嵌入资源提取工具
|
||||||
|
|
||||||
|
**目录**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
Gitea 的可执行文件包含了运行所需的所有资源:模板、图片、样式表和翻译文件。你可以通过在 `custom` 目录下的相应路径中放置替换文件来覆盖其中的任何资源(详见 [自定义 Gitea 配置]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}}))。
|
||||||
|
|
||||||
|
要获取嵌入资源的副本以进行编辑,可以使用 CLI 中的 `embedded` 命令,通过操作系统的 shell 执行。
|
||||||
|
|
||||||
|
**注意:** 嵌入资源提取工具包含在 Gitea 1.12 及以上版本中。
|
||||||
|
|
||||||
|
## 资源列表
|
||||||
|
|
||||||
|
要列出嵌入在 Gitea 可执行文件中的资源,请使用以下语法:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
gitea embedded list [--include-vendored] [patterns...]
|
||||||
|
```
|
||||||
|
|
||||||
|
`--include-vendored` 标志使命令包括被供应的文件,这些文件通常被排除在外;即来自外部库的文件,这些文件是 Gitea 所需的(例如 [octicons](https://octicons.github.com/) 等)。
|
||||||
|
|
||||||
|
可以提供一系列文件搜索模式。Gitea 使用 [gobwas/glob](https://github.com/gobwas/glob) 作为其 glob 语法。以下是一些示例:
|
||||||
|
|
||||||
|
- 列出所有模板文件,无论在哪个虚拟目录下:`**.tmpl`
|
||||||
|
- 列出所有邮件模板文件:`templates/mail/**.tmpl`
|
||||||
|
- 列出 `public/img` 目录下的所有文件:`public/img/**`
|
||||||
|
|
||||||
|
不要忘记为模式使用引号,因为空格、`*` 和其他字符可能对命令行解释器有特殊含义。
|
||||||
|
|
||||||
|
如果未提供模式,则列出所有文件。
|
||||||
|
|
||||||
|
### 示例
|
||||||
|
|
||||||
|
列出所有路径中包含 `openid` 的嵌入文件:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ gitea embedded list '**openid**'
|
||||||
|
public/img/auth/openid_connect.svg
|
||||||
|
public/img/openid-16x16.png
|
||||||
|
templates/user/auth/finalize_openid.tmpl
|
||||||
|
templates/user/auth/signin_openid.tmpl
|
||||||
|
templates/user/auth/signup_openid_connect.tmpl
|
||||||
|
templates/user/auth/signup_openid_navbar.tmpl
|
||||||
|
templates/user/auth/signup_openid_register.tmpl
|
||||||
|
templates/user/settings/security_openid.tmpl
|
||||||
|
```
|
||||||
|
|
||||||
|
## 提取资源
|
||||||
|
|
||||||
|
要提取嵌入在 Gitea 可执行文件中的资源,请使用以下语法:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
gitea [--config {file}] embedded extract [--destination {dir}|--custom] [--overwrite|--rename] [--include-vendored] {patterns...}
|
||||||
|
```
|
||||||
|
|
||||||
|
`--config` 选项用于告知 Gitea `app.ini` 配置文件的位置(如果不在默认位置)。此选项仅在使用 `--custom` 标志时使用。
|
||||||
|
|
||||||
|
`--destination` 选项用于指定提取文件的目标目录。默认为当前目录。
|
||||||
|
|
||||||
|
`--custom` 标志告知 Gitea 直接将文件提取到 `custom` 目录中。为使其正常工作,该命令需要知道 `app.ini` 配置文件的位置(通过 `--config` 指定),并且根据配置的不同,需要从 Gitea 通常启动的目录运行。有关详细信息,请参阅 [自定义 Gitea 配置]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}})。
|
||||||
|
|
||||||
|
`--overwrite` 标志允许覆盖目标目录中的任何现有文件。
|
||||||
|
|
||||||
|
`--rename` 标志告知 Gitea 将目标目录中的任何现有文件重命名为 `filename.bak`。之前的 `.bak` 文件将被覆盖。
|
||||||
|
|
||||||
|
至少需要提供一个文件搜索模式;有关模式的语法和示例,请参阅上述 `list` 子命令。
|
||||||
|
|
||||||
|
### 重要提示
|
||||||
|
|
||||||
|
请确保**只提取需要自定义的文件**。位于 `custom` 目录中的文件不会受到 Gitea 的升级过程的影响。当 Gitea 升级到新版本(通过替换可执行文件)时,许多嵌入文件将发生变化。Gitea 将尊重并使用在 `custom` 目录中找到的任何文件,即使这些文件是旧的和不兼容的。
|
||||||
|
|
||||||
|
### 示例
|
||||||
|
|
||||||
|
将邮件模板提取到临时目录:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ mkdir tempdir
|
||||||
|
$ gitea embedded extract --destination tempdir 'templates/mail/**.tmpl'
|
||||||
|
Extracting to tempdir:
|
||||||
|
tempdir/templates/mail/auth/activate.tmpl
|
||||||
|
tempdir/templates/mail/auth/activate_email.tmpl
|
||||||
|
tempdir/templates/mail/auth/register_notify.tmpl
|
||||||
|
tempdir/templates/mail/auth/reset_passwd.tmpl
|
||||||
|
tempdir/templates/mail/issue/assigned.tmpl
|
||||||
|
tempdir/templates/mail/issue/default.tmpl
|
||||||
|
tempdir/templates/mail/notify/collaborator.tmpl
|
||||||
|
```
|
||||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,91 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "Email 设置"
|
||||||
|
slug: "email-setup"
|
||||||
|
weight: 12
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/email-setup
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "Email 设置"
|
||||||
|
weight: 12
|
||||||
|
identifier: "email-setup"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Email 设置
|
||||||
|
|
||||||
|
**目录**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
Gitea 具有邮件功能,用于发送事务性邮件(例如注册确认邮件)。它可以配置为使用 Sendmail(或兼容的 MTA,例如 Postfix 和 msmtp)或直接使用 SMTP 服务器。
|
||||||
|
|
||||||
|
## 使用 Sendmail
|
||||||
|
|
||||||
|
使用 `sendmail` 命令作为邮件传输代理(mailer)。
|
||||||
|
|
||||||
|
注意:对于在官方Gitea Docker镜像中使用,请使用SMTP版本进行配置(请参考下一节)。
|
||||||
|
|
||||||
|
注意:对于面向互联网的网站,请查阅您的 MTA 文档以了解通过TLS发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录,以使发送的邮件被各个电子邮件提供商接受为合法邮件。
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
FROM = [email protected]
|
||||||
|
MAILER_TYPE = sendmail
|
||||||
|
SENDMAIL_PATH = /usr/sbin/sendmail
|
||||||
|
SENDMAIL_ARGS = "--" ; 大多数 "sendmail" 程序都接受选项,使用 "--" 将防止电子邮件地址被解释为选项。
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用 SMTP
|
||||||
|
|
||||||
|
直接使用 SMTP 服务器作为中继。如果您不想在实例上设置 MTA,但在电子邮件提供商那里有一个帐户,这个选项非常有用。
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
FROM = [email protected]
|
||||||
|
MAILER_TYPE = smtp
|
||||||
|
SMTP_ADDR = mail.mydomain.com
|
||||||
|
SMTP_PORT = 587
|
||||||
|
IS_TLS_ENABLED = true
|
||||||
|
USER = [email protected]
|
||||||
|
PASSWD = `password`
|
||||||
|
```
|
||||||
|
|
||||||
|
重启 Gitea 以使配置更改生效。
|
||||||
|
|
||||||
|
要发送测试邮件以验证设置,请转到 Gitea > 站点管理 > 配置 > SMTP 邮件配置。
|
||||||
|
|
||||||
|
有关所有选项的完整列表,请查看[配置速查表](doc/administration/config-cheat-sheet.zh-cn.md)。
|
||||||
|
|
||||||
|
请注意:只有在使用 TLS 或 `HOST=localhost` 加密 SMTP 服务器通信时才支持身份验证。TLS 加密可以通过以下方式进行:
|
||||||
|
|
||||||
|
- 通过端口 587 的 STARTTLS(也称为 Opportunistic TLS)。初始连接是明文的,但如果服务器支持,则可以升级为 TLS。
|
||||||
|
- 通过默认端口 465 的 SMTPS 连接。连接到服务器从一开始就使用 TLS。
|
||||||
|
- 使用 `IS_TLS_ENABLED=true` 进行强制的 SMTPS 连接。(这两种方式都被称为 Implicit TLS)
|
||||||
|
这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。
|
||||||
|
|
||||||
|
请注意,自2018年起,[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。
|
||||||
|
|
||||||
|
### Gmail
|
||||||
|
|
||||||
|
以下配置应该适用于 Gmail 的 SMTP 服务器:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
HOST = smtp.gmail.com:465 ; 对于 Gitea >= 1.18.0,删除此行
|
||||||
|
SMTP_ADDR = smtp.gmail.com
|
||||||
|
SMTP_PORT = 465
|
||||||
|
FROM = [email protected]
|
||||||
|
USER = example.user
|
||||||
|
PASSWD = `***`
|
||||||
|
MAILER_TYPE = smtp
|
||||||
|
IS_TLS_ENABLED = true
|
||||||
|
```
|
||||||
|
|
||||||
|
请注意,您需要创建并使用一个 [应用密码](https://support.google.com/accounts/answer/185833?hl=en) 并在您的 Google 帐户上启用 2FA。您将无法直接使用您的 Google 帐户密码。
|
||||||
@@ -0,0 +1,207 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "外部渲染器"
|
||||||
|
slug: "external-renderers"
|
||||||
|
weight: 60
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/external-renderers
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "外部渲染器"
|
||||||
|
weight: 60
|
||||||
|
identifier: "external-renderers"
|
||||||
|
---
|
||||||
|
|
||||||
|
# 自定义文件渲染配置
|
||||||
|
|
||||||
|
**目录**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
Gitea 通过外部二进制文件支持自定义文件渲染(例如 Jupyter notebooks、asciidoc 等),只需要进行以下步骤:
|
||||||
|
|
||||||
|
- 安装外部二进制文件
|
||||||
|
- 在您的 `app.ini` 文件中添加一些配置
|
||||||
|
- 重新启动 Gitea 实例
|
||||||
|
|
||||||
|
此功能支持整个文件的渲染。如果您想要在 Markdown 中渲染代码块,您需要使用 JavaScript 进行一些操作。请参阅 [自定义 Gitea 配置]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}}) 页面上的一些示例。
|
||||||
|
|
||||||
|
## 安装外部二进制文件
|
||||||
|
|
||||||
|
为了通过外部二进制文件进行文件渲染,必须安装它们的关联软件包。
|
||||||
|
如果您正在使用 Docker 镜像,则您的 `Dockerfile` 应该包含以下内容:
|
||||||
|
|
||||||
|
```docker
|
||||||
|
FROM gitea/gitea:{{< version >}}
|
||||||
|
[...]
|
||||||
|
|
||||||
|
COPY custom/app.ini /data/gitea/conf/app.ini
|
||||||
|
[...]
|
||||||
|
|
||||||
|
RUN apk --no-cache add asciidoctor freetype freetype-dev gcc g++ libpng libffi-dev py-pip python3-dev py3-pip py3-pyzmq
|
||||||
|
# 安装其他您需要的外部渲染器的软件包
|
||||||
|
|
||||||
|
RUN pip3 install --upgrade pip
|
||||||
|
RUN pip3 install -U setuptools
|
||||||
|
RUN pip3 install jupyter docutils
|
||||||
|
# 在上面添加您需要安装的任何其他 Python 软件包
|
||||||
|
```
|
||||||
|
|
||||||
|
## `app.ini` 文件配置
|
||||||
|
|
||||||
|
在您的自定义 `app.ini` 文件中为每个外部渲染器添加一个 `[markup.XXXXX]` 部分:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.asciidoc]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .adoc,.asciidoc
|
||||||
|
RENDER_COMMAND = "asciidoctor -s -a showtitle --out-file=- -"
|
||||||
|
; 输入不是标准输入而是文件
|
||||||
|
IS_INPUT_FILE = false
|
||||||
|
|
||||||
|
[markup.jupyter]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .ipynb
|
||||||
|
RENDER_COMMAND = "jupyter nbconvert --stdin --stdout --to html --template basic"
|
||||||
|
IS_INPUT_FILE = false
|
||||||
|
|
||||||
|
[markup.restructuredtext]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .rst
|
||||||
|
RENDER_COMMAND = "timeout 30s pandoc +RTS -M512M -RTS -f rst"
|
||||||
|
IS_INPUT_FILE = false
|
||||||
|
```
|
||||||
|
|
||||||
|
如果您的外部标记语言依赖于在生成的 HTML 元素上的额外类和属性,您可能需要启用自定义的清理策略。Gitea 使用 [`bluemonday`](https://godoc.org/github.com/microcosm-cc/bluemonday) 包作为我们的 HTML 清理器。下面的示例可以用于支持从 [`pandoc`](https://pandoc.org/) 输出的服务器端 [KaTeX](https://katex.org/) 渲染结果。
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.sanitizer.TeX]
|
||||||
|
; Pandoc 渲染 TeX 段落为带有 "math" 类的 <span> 元素,根据上下文可能还带有 "inline" 或 "display" 类。
|
||||||
|
; - 请注意,这与我们的 Markdown 解析器中内置的数学支持不同,后者使用 <code> 元素。
|
||||||
|
ELEMENT = span
|
||||||
|
ALLOW_ATTR = class
|
||||||
|
REGEXP = ^\s*((math(\s+|$)|inline(\s+|$)|display(\s+|$)))+
|
||||||
|
|
||||||
|
[markup.markdown]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .md,.markdown
|
||||||
|
RENDER_COMMAND = pandoc -f markdown -t html --katex
|
||||||
|
```
|
||||||
|
|
||||||
|
您必须在每个部分中定义 `ELEMENT` 和 `ALLOW_ATTR`。
|
||||||
|
|
||||||
|
要定义多个条目,请添加唯一的字母数字后缀(例如,`[markup.sanitizer.1]` 和 `[markup.sanitizer.something]`)。
|
||||||
|
|
||||||
|
要仅为特定的外部渲染器应用清理规则,它们必须使用渲染器名称,例如 `[markup.sanitizer.asciidoc.rule-1]`、`[markup.sanitizer.<renderer>.rule-1]`。
|
||||||
|
|
||||||
|
**注意**:如果规则在渲染器 ini 部分之前定义,或者名称与渲染器不匹配,它将应用于所有渲染器。
|
||||||
|
|
||||||
|
完成配置更改后,请重新启动 Gitea 以使更改生效。
|
||||||
|
|
||||||
|
**注意**:在 Gitea 1.12 之前,存在一个名为 `markup.sanitiser` 的单个部分,其中的键被重新定义为多个规则,但是,这种配置方法存在重大问题,需要通过多个部分进行配置。
|
||||||
|
|
||||||
|
### 示例:HTML
|
||||||
|
|
||||||
|
直接渲染 HTML 文件:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.html]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .html,.htm
|
||||||
|
RENDER_COMMAND = cat
|
||||||
|
; 输入不是标准输入,而是文件
|
||||||
|
IS_INPUT_FILE = true
|
||||||
|
|
||||||
|
[markup.sanitizer.html.1]
|
||||||
|
ELEMENT = div
|
||||||
|
ALLOW_ATTR = class
|
||||||
|
|
||||||
|
[markup.sanitizer.html.2]
|
||||||
|
ELEMENT = a
|
||||||
|
ALLOW_ATTR = class
|
||||||
|
```
|
||||||
|
|
||||||
|
请注意:此示例中的配置将允许渲染 HTML 文件,并使用 `cat` 命令将文件内容输出为 HTML。此外,配置中的两个清理规则将允许 `<div>` 和 `<a>` 元素使用 `class` 属性。
|
||||||
|
|
||||||
|
在进行配置更改后,请重新启动 Gitea 以使更改生效。
|
||||||
|
|
||||||
|
### 示例:Office DOCX
|
||||||
|
|
||||||
|
使用 [`pandoc`](https://pandoc.org/) 显示 Office DOCX 文件:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.docx]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .docx
|
||||||
|
RENDER_COMMAND = "pandoc --from docx --to html --self-contained --template /path/to/basic.html"
|
||||||
|
|
||||||
|
[markup.sanitizer.docx.img]
|
||||||
|
ALLOW_DATA_URI_IMAGES = true
|
||||||
|
```
|
||||||
|
|
||||||
|
在此示例中,配置将允许显示 Office DOCX 文件,并使用 `pandoc` 命令将文件转换为 HTML 格式。同时,清理规则中的 `ALLOW_DATA_URI_IMAGES` 设置为 `true`,允许使用 Data URI 格式的图片。
|
||||||
|
|
||||||
|
模板文件的内容如下:
|
||||||
|
|
||||||
|
```
|
||||||
|
$body$
|
||||||
|
```
|
||||||
|
|
||||||
|
### 示例:Jupyter Notebook
|
||||||
|
|
||||||
|
使用 [`nbconvert`](https://github.com/jupyter/nbconvert) 显示 Jupyter Notebook 文件:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.jupyter]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .ipynb
|
||||||
|
RENDER_COMMAND = "jupyter-nbconvert --stdin --stdout --to html --template basic"
|
||||||
|
|
||||||
|
[markup.sanitizer.jupyter.img]
|
||||||
|
ALLOW_DATA_URI_IMAGES = true
|
||||||
|
```
|
||||||
|
|
||||||
|
在此示例中,配置将允许显示 Jupyter Notebook 文件,并使用 `nbconvert` 命令将文件转换为 HTML 格式。同样,清理规则中的 `ALLOW_DATA_URI_IMAGES` 设置为 `true`,允许使用 Data URI 格式的图片。
|
||||||
|
|
||||||
|
在进行配置更改后,请重新启动 Gitea 以使更改生效。
|
||||||
|
|
||||||
|
## 自定义 CSS
|
||||||
|
|
||||||
|
在 `.ini` 文件中,可以使用 `[markup.XXXXX]` 的格式指定外部渲染器,并且由外部渲染器生成的 HTML 将被包装在一个带有 `markup` 和 `XXXXX` 类的 `<div>` 中。`markup` 类提供了预定义的样式(如果 `XXXXX` 是 `markdown`,则使用 `markdown` 类)。否则,您可以使用这些类来针对渲染的 HTML 内容进行定制样式。
|
||||||
|
|
||||||
|
因此,您可以编写一些 CSS 样式:
|
||||||
|
|
||||||
|
```css
|
||||||
|
.markup.XXXXX html {
|
||||||
|
font-size: 100%;
|
||||||
|
overflow-y: scroll;
|
||||||
|
-webkit-text-size-adjust: 100%;
|
||||||
|
-ms-text-size-adjust: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.markup.XXXXX body {
|
||||||
|
color: #444;
|
||||||
|
font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif;
|
||||||
|
font-size: 12px;
|
||||||
|
line-height: 1.7;
|
||||||
|
padding: 1em;
|
||||||
|
margin: auto;
|
||||||
|
max-width: 42em;
|
||||||
|
background: #fefefe;
|
||||||
|
}
|
||||||
|
|
||||||
|
.markup.XXXXX p {
|
||||||
|
color: orangered;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
将您的样式表添加到自定义目录中,例如 `custom/public/css/my-style-XXXXX.css`,并使用自定义的头文件 `custom/templates/custom/header.tmpl` 进行导入:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<link rel="stylesheet" href="{{AppSubUrl}}/assets/css/my-style-XXXXX.css" />
|
||||||
|
```
|
||||||
|
|
||||||
|
通过以上步骤,您可以将自定义的 CSS 样式应用到特定的外部渲染器,使其具有所需的样式效果。
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "Git LFS 设置"
|
||||||
|
slug: "git-lfs-setup"
|
||||||
|
weight: 12
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/git-lfs-setup
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "Git LFS 设置"
|
||||||
|
weight: 12
|
||||||
|
identifier: "git-lfs-setup"
|
||||||
|
---
|
||||||
|
|
||||||
|
# 配置 Git 大文件存储(Large File Storage,LFS)
|
||||||
|
|
||||||
|
要使用 Gitea 内置的 LFS 支持,您需要更新 `app.ini` 文件:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[server]
|
||||||
|
; 启用 git-lfs 支持。true 或 false,默认为 false。
|
||||||
|
LFS_START_SERVER = true
|
||||||
|
|
||||||
|
[lfs]
|
||||||
|
; 存放 LFS 文件的路径,默认为 data/lfs。
|
||||||
|
PATH = /home/gitea/data/lfs
|
||||||
|
```
|
||||||
|
|
||||||
|
**注意**:LFS 服务器支持需要服务器上安装 Git v2.1.2 以上版本。
|
||||||
@@ -0,0 +1,276 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "日志配置"
|
||||||
|
slug: "logging-config"
|
||||||
|
weight: 40
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/logging-configuration
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "日志配置"
|
||||||
|
weight: 40
|
||||||
|
identifier: "logging-config"
|
||||||
|
---
|
||||||
|
|
||||||
|
# 日志配置
|
||||||
|
|
||||||
|
Gitea 的日志配置主要由以下三种类型的组件组成:
|
||||||
|
|
||||||
|
- `[log]` 部分用于一般配置
|
||||||
|
- `[log.<mode-name>]` 部分用于配置不同的日志输出方式,也称为 "writer mode",模式名称同时也作为 "writer name"
|
||||||
|
- `[log]` 部分还可以包含遵循 `logger.<logger-name>.<CONFIG-KEY>` 模式的子日志记录器的配置
|
||||||
|
|
||||||
|
默认情况下,已经有一个完全功能的日志输出,因此不需要重新定义。
|
||||||
|
|
||||||
|
**目录**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
## 收集日志以获取帮助
|
||||||
|
|
||||||
|
要收集日志以获取帮助和报告问题,请参阅 [需要帮助]({{< relref "doc/help/support.zh-cn.md" >}})。
|
||||||
|
|
||||||
|
## `[log]` 部分
|
||||||
|
|
||||||
|
在 Gitea 中,日志设施的配置在 `[log]` 部分及其子部分。
|
||||||
|
|
||||||
|
在顶层的 `[log]` 部分,可以放置以下配置项:
|
||||||
|
|
||||||
|
- `ROOT_PATH`:(默认值:**%(GITEA_WORK_DIR)/log**):日志文件的基本路径。
|
||||||
|
- `MODE`:(默认值:**console**):要用于默认日志记录器的日志输出列表。
|
||||||
|
- `LEVEL`:(默认值:**Info**):要持久化的最严重的日志事件,不区分大小写。可能的值为:`Trace`、`Debug`、`Info`、`Warn`、`Error`、`Fatal`。
|
||||||
|
- `STACKTRACE_LEVEL`:(默认值:**None**):对于此类及更严重的事件,将在记录时打印堆栈跟踪。
|
||||||
|
|
||||||
|
它还可以包含以下子日志记录器:
|
||||||
|
|
||||||
|
- `logger.router.MODE`:(默认值:**,**):用于路由器日志记录器的日志输出列表。
|
||||||
|
- `logger.access.MODE`:(默认值:**\<empty\>**):用于访问日志记录器的日志输出列表。默认情况下,访问日志记录器被禁用。
|
||||||
|
- `logger.xorm.MODE`:(默认值:**,**):用于 XORM 日志记录器的日志输出列表。
|
||||||
|
|
||||||
|
将子日志记录器的模式设置为逗号(`,`)表示使用默认的全局 `MODE`。
|
||||||
|
|
||||||
|
## 快速示例
|
||||||
|
|
||||||
|
### 默认(空)配置
|
||||||
|
|
||||||
|
空配置等同于默认配置:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[log]
|
||||||
|
ROOT_PATH = %(GITEA_WORK_DIR)/log
|
||||||
|
MODE = console
|
||||||
|
LEVEL = Info
|
||||||
|
STACKTRACE_LEVEL = None
|
||||||
|
logger.router.MODE = ,
|
||||||
|
logger.xorm.MODE = ,
|
||||||
|
logger.access.MODE =
|
||||||
|
|
||||||
|
; 这是“控制台”模式的配置选项(由上面的 MODE=console 使用)
|
||||||
|
[log.console]
|
||||||
|
MODE = console
|
||||||
|
FLAGS = stdflags
|
||||||
|
PREFIX =
|
||||||
|
COLORIZE = true
|
||||||
|
```
|
||||||
|
|
||||||
|
这等同于将所有日志发送到控制台,并将默认的 Golang 日志也发送到控制台日志中。
|
||||||
|
|
||||||
|
这只是一个示例,默认情况下不需要将其写入配置文件中。
|
||||||
|
|
||||||
|
### 禁用路由日志并将一些访问日志记录到文件中
|
||||||
|
|
||||||
|
禁用路由日志,将访问日志(>=Warn)记录到 `access.log` 中:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[log]
|
||||||
|
logger.router.MODE =
|
||||||
|
logger.access.MODE = access-file
|
||||||
|
|
||||||
|
[log.access-file]
|
||||||
|
MODE = file
|
||||||
|
LEVEL = Warn
|
||||||
|
FILE_NAME = access.log
|
||||||
|
```
|
||||||
|
|
||||||
|
### 为不同的模式设置不同的日志级别
|
||||||
|
|
||||||
|
将默认日志(>=Warn)记录到 `gitea.log` 中,将错误日志记录到 `file-error.log` 中:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[log]
|
||||||
|
LEVEL = Warn
|
||||||
|
MODE = file, file-error
|
||||||
|
|
||||||
|
; 默认情况下,"file" 模式会将日志记录到 %(log.ROOT_PATH)/gitea.log,因此我们不需要设置它
|
||||||
|
; [log.file]
|
||||||
|
|
||||||
|
[log.file-error]
|
||||||
|
LEVEL = Error
|
||||||
|
FILE_NAME = file-error.log
|
||||||
|
```
|
||||||
|
|
||||||
|
## 日志输出(模式和写入器)
|
||||||
|
|
||||||
|
Gitea 提供以下日志写入器:
|
||||||
|
|
||||||
|
- `console` - 输出日志到 `stdout`(或 `stderr`,如果已在配置中设置)
|
||||||
|
- `file` - 输出日志到文件
|
||||||
|
- `conn` - 输出日志到套接字(网络或 Unix 套接字)
|
||||||
|
|
||||||
|
### 公共配置
|
||||||
|
|
||||||
|
某些配置适用于所有日志输出模式:
|
||||||
|
|
||||||
|
- `MODE` 是日志输出写入器的模式。它将默认为 ini 部分的模式名称。因此,`[log.console]` 将默认为 `MODE = console`。
|
||||||
|
- `LEVEL` 是此输出将记录的最低日志级别。
|
||||||
|
- `STACKTRACE_LEVEL` 是此输出将打印堆栈跟踪的最低日志级别。
|
||||||
|
- `COLORIZE` 对于 `console`,默认为 `true`,否则默认为 `false`。
|
||||||
|
|
||||||
|
#### `EXPRESSION`
|
||||||
|
|
||||||
|
`EXPRESSION` 表示日志事件必须匹配才能被输出写入器记录的正则表达式。
|
||||||
|
日志消息(去除颜色)或 `longfilename:linenumber:functionname` 必须匹配其中之一。
|
||||||
|
注意:整个消息或字符串不需要完全匹配。
|
||||||
|
|
||||||
|
请注意,此表达式将在写入器的 goroutine 中运行,而不是在日志事件的 goroutine 中运行。
|
||||||
|
|
||||||
|
#### `FLAGS`
|
||||||
|
|
||||||
|
`FLAGS` 表示在每条消息之前打印的前置日志上下文信息。
|
||||||
|
它是一个逗号分隔的字符串集。值的顺序无关紧要。
|
||||||
|
|
||||||
|
默认值为 `stdflags`(= `date,time,medfile,shortfuncname,levelinitial`)。
|
||||||
|
|
||||||
|
可能的值为:
|
||||||
|
|
||||||
|
- `none` 或 `,` - 无标志。
|
||||||
|
- `date` - 当地时区的日期:`2009/01/23`。
|
||||||
|
- `time` - 当地时区的时间:`01:23:23`。
|
||||||
|
- `microseconds` - 微秒精度:`01:23:23.123123`。假定有时间。
|
||||||
|
- `longfile` - 完整的文件名和行号:`/a/b/c/d.go:23`。
|
||||||
|
- `shortfile` - 文件名的最后一个部分和行号:`d.go:23`。
|
||||||
|
- `funcname` - 调用者的函数名:`runtime.Caller()`。
|
||||||
|
- `shortfuncname` - 函数名的最后一部分。覆盖 `funcname`。
|
||||||
|
- `utc` - 如果设置了日期或时间,则使用 UTC 而不是本地时区。
|
||||||
|
- `levelinitial` - 提供的级别的初始字符,放在方括号内,例如 `[I]` 表示 info。
|
||||||
|
- `level` - 在方括号内的级别,例如 `[INFO]`。
|
||||||
|
- `gopid` - 上下文的 Goroutine-PID。
|
||||||
|
- `medfile` - 文件名的最后 20 个字符 - 相当于 `shortfile,longfile`。
|
||||||
|
- `stdflags` - 相当于 `date,time,medfile,shortfuncname,levelinitial`。
|
||||||
|
|
||||||
|
### Console 模式
|
||||||
|
|
||||||
|
在此模式下,日志记录器将将日志消息转发到 Gitea 进程附加的 stdout 和 stderr 流。
|
||||||
|
|
||||||
|
对于 console 模式的日志记录器,如果不在 Windows 上,或者 Windows 终端可以设置为 ANSI 模式,或者是 cygwin 或 Msys 管道,则 `COLORIZE` 默认为 `true`。
|
||||||
|
|
||||||
|
设置:
|
||||||
|
|
||||||
|
- `STDERR`:**false**:日志记录器是否应将日志打印到 `stderr` 而不是 `stdout`。
|
||||||
|
|
||||||
|
### File 模式
|
||||||
|
|
||||||
|
在此模式下,日志记录器将将日志消息保存到文件中。
|
||||||
|
|
||||||
|
设置:
|
||||||
|
|
||||||
|
- `FILE_NAME`:要将日志事件写入的文件,相对于 `ROOT_PATH`,默认为 `%(ROOT_PATH)/gitea.log`。异常情况:访问日志默认为 `%(ROOT_PATH)/access.log`。
|
||||||
|
- `MAX_SIZE_SHIFT`:**28**:单个文件的最大大小位移。28 表示 256Mb。详细信息见下文。
|
||||||
|
- `LOG_ROTATE` **true**:是否轮转日志文件。
|
||||||
|
- `DAILY_ROTATE`:**true**:是否每天旋转日志。
|
||||||
|
- `MAX_DAYS`:**7**:在此天数之后删除旋转的日志文件。
|
||||||
|
- `COMPRESS`:**true**:默认情况下是否使用 gzip 压缩旧的日志文件。
|
||||||
|
- `COMPRESSION_LEVEL`:**-1**:压缩级别。详细信息见下文。
|
||||||
|
|
||||||
|
`MAX_SIZE_SHIFT` 通过将给定次数左移 1 (`1 << x`) 来定义文件的最大大小。
|
||||||
|
在 v1.17.3 版本时的确切行为可以在[这里](https://github.com/go-gitea/gitea/blob/v1.17.3/modules/setting/log.go#L185)中查看。
|
||||||
|
|
||||||
|
`COMPRESSION_LEVEL` 的有用值范围从 1 到(包括)9,其中较高的数字表示更好的压缩。
|
||||||
|
请注意,更好的压缩可能会带来更高的资源使用。
|
||||||
|
必须在前面加上 `-` 符号。
|
||||||
|
|
||||||
|
### Conn 模式
|
||||||
|
|
||||||
|
在此模式下,日志记录器将通过网络套接字发送日志消息。
|
||||||
|
|
||||||
|
设置:
|
||||||
|
|
||||||
|
- `ADDR`:**:7020**:设置要连接的地址。
|
||||||
|
- `PROTOCOL`:**tcp**:设置协议,可以是 "tcp"、"unix" 或 "udp"。
|
||||||
|
- `RECONNECT`:**false**:在连接丢失时尝试重新连接。
|
||||||
|
- `RECONNECT_ON_MSG`:**false**:为每条消息重新连接主机。
|
||||||
|
|
||||||
|
### "Router" 日志记录器
|
||||||
|
|
||||||
|
当 Gitea 的路由处理程序工作时,Router 日志记录器记录以下消息类型:
|
||||||
|
|
||||||
|
- `started` 消息将以 TRACE 级别记录
|
||||||
|
- `polling`/`completed` 路由将以 INFO 级别记录。异常情况:"/assets" 静态资源请求也会以 TRACE 级别记录。
|
||||||
|
- `slow` 路由将以 WARN 级别记录
|
||||||
|
- `failed` 路由将以 WARN 级别记录
|
||||||
|
|
||||||
|
### "XORM" 日志记录器
|
||||||
|
|
||||||
|
为了使 XORM 输出 SQL 日志,还应将 `[database]` 部分中的 `LOG_SQL` 设置为 `true`。
|
||||||
|
|
||||||
|
### "Access" 日志记录器
|
||||||
|
|
||||||
|
"Access" 日志记录器是自 Gitea 1.9 版本以来的新日志记录器。它提供了符合 NCSA Common Log 标准的日志格式。虽然它具有高度可配置性,但在更改其模板时应谨慎。此日志记录器的主要好处是,Gitea 现在可以使用标准日志格式记录访问日志,因此可以使用标准工具进行分析。
|
||||||
|
|
||||||
|
您可以通过使用 `logger.access.MODE = ...` 来启用此日志记录器。
|
||||||
|
|
||||||
|
如果需要,可以通过更改 `ACCESS_LOG_TEMPLATE` 的值来更改 "Access" 日志记录器的格式。
|
||||||
|
|
||||||
|
请注意,访问日志记录器将以 `INFO` 级别记录,将此日志记录器的 `LEVEL` 设置为 `WARN` 或更高级别将导致不记录访问日志。
|
||||||
|
|
||||||
|
#### ACCESS_LOG_TEMPLATE
|
||||||
|
|
||||||
|
此值表示一个 Go 模板。其默认值为
|
||||||
|
|
||||||
|
```tmpl
|
||||||
|
{{.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` 是 `http.ResponseWriter`
|
||||||
|
|
||||||
|
更改此模板时必须小心,因为它在标准的 panic 恢复陷阱之外运行。此模板应该尽可能简单,因为它会为每个请求运行一次。
|
||||||
|
|
||||||
|
## 释放和重新打开、暂停和恢复日志记录
|
||||||
|
|
||||||
|
如果您在 Unix 上运行,您可能希望释放和重新打开日志以使用 `logrotate` 或其他工具。
|
||||||
|
可以通过向运行中的进程发送 `SIGUSR1` 信号或运行 `gitea manager logging release-and-reopen` 命令来强制 Gitea 释放并重新打开其日志文件和连接。
|
||||||
|
|
||||||
|
或者,您可能希望暂停和恢复日志记录 - 可以通过使用 `gitea manager logging pause` 和 `gitea manager logging resume` 命令来实现。请注意,当日志记录暂停时,低于 INFO 级别的日志事件将不会存储,并且只会存储有限数量的事件。在暂停时,日志记录可能会阻塞,尽管是暂时性的,但会大大减慢 Gitea 的运行速度,因此建议仅暂停很短的时间。
|
||||||
|
|
||||||
|
### 在 Gitea 运行时添加和删除日志记录
|
||||||
|
|
||||||
|
可以使用 `gitea manager logging add` 和 `remove` 子命令在 Gitea 运行时添加和删除日志记录。
|
||||||
|
此功能只能调整正在运行的日志系统,不能用于启动未初始化的访问或路由日志记录器。如果您希望启动这些系统,建议调整 app.ini 并(优雅地)重新启动 Gitea 服务。
|
||||||
|
|
||||||
|
这些命令的主要目的是在运行中的系统上轻松添加临时日志记录器,以便调查问题,因为重新启动可能会导致问题消失。
|
||||||
|
|
||||||
|
## 使用 `logrotate` 而不是内置的日志轮转
|
||||||
|
|
||||||
|
Gitea 包含内置的日志轮转功能,对于大多数部署来说应该已经足够了。但是,如果您想使用 `logrotate` 工具:
|
||||||
|
|
||||||
|
- 在 `app.ini` 中将 `LOG_ROTATE` 设置为 `false`,禁用内置的日志轮转。
|
||||||
|
- 安装 `logrotate`。
|
||||||
|
- 根据部署要求配置 `logrotate`,有关配置语法细节,请参阅 `man 8 logrotate`。
|
||||||
|
在 `postrotate/endscript` 块中通过 `kill -USR1` 或 `kill -10` 向 `gitea` 进程本身发送 `USR1` 信号,
|
||||||
|
或者运行 `gitea manager logging release-and-reopen`(使用适当的环境设置)。
|
||||||
|
确保配置适用于由 Gitea 日志记录器生成的所有文件,如上述部分所述。
|
||||||
|
- 始终使用 `logrotate /etc/logrotate.conf --debug` 来测试您的配置。
|
||||||
|
- 如果您正在使用 Docker 并从容器外部运行,您可以使用
|
||||||
|
`docker exec -u $OS_USER $CONTAINER_NAME sh -c 'gitea manager logging release-and-reopen'`
|
||||||
|
或 `docker exec $CONTAINER_NAME sh -c '/bin/s6-svc -1 /etc/s6/gitea/'`,或直接向 Gitea 进程本身发送 `USR1` 信号。
|
||||||
|
|
||||||
|
下一个 `logrotate` 作业将包括您的配置,因此不需要重新启动。
|
||||||
|
您还可以立即使用 `logrotate /etc/logrotate.conf --force` 重新加载 `logrotate`。
|
||||||
@@ -0,0 +1,265 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "邮件模板"
|
||||||
|
slug: "mail-templates"
|
||||||
|
weight: 45
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/mail-templates
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "邮件模板"
|
||||||
|
weight: 45
|
||||||
|
identifier: "mail-templates"
|
||||||
|
---
|
||||||
|
|
||||||
|
# 邮件模板
|
||||||
|
|
||||||
|
**目录**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
为了定制特定操作的电子邮件主题和内容,可以使用模板来自定义 Gitea。这些功能的模板位于 [`custom` 目录](https://docs.gitea.io/en-us/customizing-gitea/) 下。
|
||||||
|
如果没有自定义的替代方案,Gitea 将使用内部模板作为默认模板。
|
||||||
|
|
||||||
|
自定义模板在 Gitea 启动时加载。对它们的更改在 Gitea 重新启动之前不会被识别。
|
||||||
|
|
||||||
|
## 支持模板的邮件通知
|
||||||
|
|
||||||
|
目前,以下通知事件使用模板:
|
||||||
|
|
||||||
|
| 操作名称 | 用途 |
|
||||||
|
| ----------- | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `new` | 创建了新的工单或合并请求。 |
|
||||||
|
| `comment` | 在现有工单或合并请求中创建了新的评论。 |
|
||||||
|
| `close` | 关闭了工单或合并请求。 |
|
||||||
|
| `reopen` | 重新打开了工单或合并请求。 |
|
||||||
|
| `review` | 在合并请求中进行审查的首要评论。 |
|
||||||
|
| `approve` | 对合并请求进行批准的首要评论。 |
|
||||||
|
| `reject` | 对合并请求提出更改请求的审查的首要评论。 |
|
||||||
|
| `code` | 关于合并请求的代码的单个评论。 |
|
||||||
|
| `assigned` | 用户被分配到工单或合并请求。 |
|
||||||
|
| `default` | 未包括在上述类别中的任何操作,或者当对应类别的模板不存在时使用的模板。 |
|
||||||
|
|
||||||
|
特定消息类型的模板路径为:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
custom/templates/mail/{操作类型}/{操作名称}.tmpl
|
||||||
|
```
|
||||||
|
|
||||||
|
其中 `{操作类型}` 是 `issue` 或 `pull`(针对合并请求),`{操作名称}` 是上述列出的操作名称之一。
|
||||||
|
|
||||||
|
例如,有关合并请求中的评论的电子邮件的特定模板是:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
custom/templates/mail/pull/comment.tmpl
|
||||||
|
```
|
||||||
|
|
||||||
|
然而,并不需要为每个操作类型/名称组合创建模板。
|
||||||
|
使用回退系统来选择适当的模板。在此列表中,将使用 _第一个存在的_ 模板:
|
||||||
|
|
||||||
|
- 所需**操作类型**和**操作名称**的特定模板。
|
||||||
|
- 操作类型为 `issue` 和所需**操作名称**的模板。
|
||||||
|
- 所需**操作类型**和操作名称为 `default` 的模板。
|
||||||
|
- 操作类型为` issue` 和操作名称为 `default` 的模板。
|
||||||
|
|
||||||
|
唯一必需的模板是操作类型为 `issue` 操作名称为 `default` 的模板,除非用户在 `custom` 目录中覆盖了它。
|
||||||
|
|
||||||
|
## 模板语法
|
||||||
|
|
||||||
|
邮件模板是 UTF-8 编码的文本文件,需要遵循以下格式之一:
|
||||||
|
|
||||||
|
```
|
||||||
|
用于主题行的文本和宏
|
||||||
|
------------
|
||||||
|
用于邮件正文的文本和宏
|
||||||
|
```
|
||||||
|
|
||||||
|
或者
|
||||||
|
|
||||||
|
```
|
||||||
|
用于邮件正文的文本和宏
|
||||||
|
```
|
||||||
|
|
||||||
|
指定 _主题_ 部分是可选的(因此也是虚线分隔符)。在使用时,_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线;分隔符行中不允许使用其他字符。
|
||||||
|
|
||||||
|
_主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/text/template/) 解析,并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素:
|
||||||
|
|
||||||
|
| 名称 | 类型 | 可用性 | 用途 |
|
||||||
|
| -------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 |
|
||||||
|
| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 |
|
||||||
|
| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息,从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 |
|
||||||
|
| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 |
|
||||||
|
| `.Issue` | models.Issue | 始终可用 | 产生通知的工单(或合并请求)。要获取特定于合并请求的数据(例如 `HasMerged`),可以使用 `.Issue.PullRequest`,但需要注意,如果工单 _不是_ 合并请求,则该字段将为 `nil`。 |
|
||||||
|
| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论,则其中包含有关评论的信息。 |
|
||||||
|
| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联(即 `.Issue.PullRequest` 不为 `nil` ),则为 `true`。 |
|
||||||
|
| `.Repo` | string | 始终可用 | 仓库的名称,包括所有者名称(例如 `mike/stuff`) |
|
||||||
|
| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名(例如 `mike`),可以使用 `.User.Name`。 |
|
||||||
|
| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名(例如 `rhonda`),可以使用 `.Doer.Name`。 |
|
||||||
|
| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的,并且收件人未订阅源,则为 `true`。如果收件人已订阅工单或仓库,则为 `false`。 |
|
||||||
|
| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容,则为 `Re:`;否则为空字符串。 |
|
||||||
|
| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应,与选择的模板无关。 |
|
||||||
|
| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一(`new` ,`comment` 等),并与选择的模板对应。 |
|
||||||
|
| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中,引用的代码将在 `.Patch` 中。 |
|
||||||
|
|
||||||
|
所有名称区分大小写。
|
||||||
|
|
||||||
|
### 模板中的主题部分
|
||||||
|
|
||||||
|
用于邮件主题的模板引擎是 Golang 的 [`text/template`](https://golang.org/pkg/text/template/)。
|
||||||
|
有关语法的详细信息,请参阅链接的文档。
|
||||||
|
|
||||||
|
主题构建的步骤如下:
|
||||||
|
|
||||||
|
- 根据通知类型和可用的模板选择一个模板。
|
||||||
|
- 解析并解析模板(例如,将 `{{.Issue.Index}}` 转换为工单或合并请求的编号)。
|
||||||
|
- 将所有空格字符(例如 `TAB`,`LF` 等)转换为普通空格。
|
||||||
|
- 删除所有前导、尾随和多余的空格。
|
||||||
|
- 将字符串截断为前 256 个字母(字符)。
|
||||||
|
|
||||||
|
如果最终结果为空字符串,**或者**没有可用的主题模板(即所选模板不包含主题部分),将使用Gitea的**内部默认值**。
|
||||||
|
|
||||||
|
内部默认(回退)主题相当于:
|
||||||
|
|
||||||
|
```
|
||||||
|
{{.SubjectPrefix}}[{{.Repo}}] {{.Issue.Title}} (#{{.Issue.Index}})
|
||||||
|
```
|
||||||
|
|
||||||
|
例如:`Re: [mike/stuff] New color palette (#38)`
|
||||||
|
|
||||||
|
即使存在有效的主题模板,Gitea的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。
|
||||||
|
|
||||||
|
### 模板中的邮件正文部分
|
||||||
|
|
||||||
|
用于邮件正文的模板引擎是 Golang 的 [`html/template`](https://golang.org/pkg/html/template/)。
|
||||||
|
有关语法的详细信息,请参阅链接的文档。
|
||||||
|
|
||||||
|
邮件正文在邮件主题之后进行解析,因此还有一个额外的 _元数据_ 字段,即在考虑所有情况之后实际呈现的主题。
|
||||||
|
|
||||||
|
期望的结果是 HTML(包括结构元素,如`<html>`,`<body>`等)。可以通过 `<style>` 块、`class` 和 `style` 属性进行样式设置。但是,`html/template` 会进行一些 [自动转义](https://golang.org/pkg/html/template/#hdr-Contexts),需要考虑这一点。
|
||||||
|
|
||||||
|
不支持附件(例如图像或外部样式表)。但是,也可以引用其他模板,例如以集中方式提供 `<style>` 元素的内容。外部模板必须放置在 `custom/mail` 下,并相对于该目录引用。例如,可以使用 `{{template styles/base}}` 包含 `custom/mail/styles/base.tmpl`。
|
||||||
|
|
||||||
|
邮件以 `Content-Type: multipart/alternative` 发送,因此正文以 HTML 和文本格式发送。通过剥离 HTML 标记来获取文本版本。
|
||||||
|
|
||||||
|
## 故障排除
|
||||||
|
|
||||||
|
邮件的呈现方式直接取决于邮件应用程序的功能。许多邮件客户端甚至不支持 HTML,因此显示生成邮件中包含的文本版本。
|
||||||
|
|
||||||
|
如果模板无法呈现,则只有在发送邮件时才会注意到。
|
||||||
|
如果主题模板失败,将使用默认主题,如果从 _邮件正文_ 中成功呈现了任何内容,则将使用该内容,忽略其他内容。
|
||||||
|
|
||||||
|
如果遇到问题,请检查 [Gitea的日志](https://docs.gitea.io/en-us/logging-configuration/) 以获取错误消息。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
`custom/templates/mail/issue/default.tmpl`:
|
||||||
|
|
||||||
|
```html
|
||||||
|
[{{.Repo}}] @{{.Doer.Name}}
|
||||||
|
{{if eq .ActionName "new"}}
|
||||||
|
创建了
|
||||||
|
{{else if eq .ActionName "comment"}}
|
||||||
|
评论了
|
||||||
|
{{else if eq .ActionName "close"}}
|
||||||
|
关闭了
|
||||||
|
{{else if eq .ActionName "reopen"}}
|
||||||
|
重新打开了
|
||||||
|
{{else}}
|
||||||
|
更新了
|
||||||
|
{{end}}
|
||||||
|
{{if eq .ActionType "issue"}}
|
||||||
|
工单
|
||||||
|
{{else}}
|
||||||
|
合并请求
|
||||||
|
{{end}}
|
||||||
|
#{{.Issue.Index}}: {{.Issue.Title}}
|
||||||
|
------------
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
|
<title>{{.Subject}}</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
{{if .IsMention}}
|
||||||
|
<p>
|
||||||
|
您收到此邮件是因为 @{{.Doer.Name}} 提到了您。
|
||||||
|
</p>
|
||||||
|
{{end}}
|
||||||
|
<p>
|
||||||
|
<p>
|
||||||
|
<a href="{{AppUrl}}/{{.Doer.LowerName}}">@{{.Doer.Name}}</a>
|
||||||
|
{{if not (eq .Doer.FullName "")}}
|
||||||
|
({{.Doer.FullName}})
|
||||||
|
{{end}}
|
||||||
|
{{if eq .ActionName "new"}}
|
||||||
|
创建了
|
||||||
|
{{else if eq .ActionName "close"}}
|
||||||
|
关闭了
|
||||||
|
{{else if eq .ActionName "reopen"}}
|
||||||
|
重新打开了
|
||||||
|
{{else}}
|
||||||
|
更新了
|
||||||
|
{{end}}
|
||||||
|
<a href="{{.Link}}">{{.Repo}}#{{.Issue.Index}}</a>。
|
||||||
|
</p>
|
||||||
|
{{if not (eq .Body "")}}
|
||||||
|
<h3>消息内容:</h3>
|
||||||
|
<hr>
|
||||||
|
{{.Body | Str2html}}
|
||||||
|
{{end}}
|
||||||
|
</p>
|
||||||
|
<hr>
|
||||||
|
<p>
|
||||||
|
<a href="{{.Link}}">在 Gitea 上查看</a>。
|
||||||
|
</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
该模板将生成以下内容:
|
||||||
|
|
||||||
|
### 主题
|
||||||
|
|
||||||
|
> [mike/stuff] @rhonda 在合并请求 #38 上进行了评论:New color palette
|
||||||
|
|
||||||
|
### 邮件正文
|
||||||
|
|
||||||
|
> [@rhonda](#)(Rhonda Myers)更新了 [mike/stuff#38](#)。
|
||||||
|
>
|
||||||
|
> #### 消息内容:
|
||||||
|
>
|
||||||
|
> \_********************************\_********************************
|
||||||
|
>
|
||||||
|
> Mike, I think we should tone down the blues a little.
|
||||||
|
>
|
||||||
|
> \_********************************\_********************************
|
||||||
|
>
|
||||||
|
> [在 Gitea 上查看](#)。
|
||||||
|
|
||||||
|
## 高级用法
|
||||||
|
|
||||||
|
模板系统包含一些函数,可用于进一步处理和格式化消息。以下是其中一些函数的列表:
|
||||||
|
|
||||||
|
| 函数名 | 参数 | 可用于 | 用法 |
|
||||||
|
| ----------------- | ----------- | ------------ | --------------------------------------------------------------------------------- |
|
||||||
|
| `AppUrl` | - | 任何地方 | Gitea 的 URL |
|
||||||
|
| `AppName` | - | 任何地方 | 从 `app.ini` 中设置,通常为 "Gitea" |
|
||||||
|
| `AppDomain` | - | 任何地方 | Gitea 的主机名 |
|
||||||
|
| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度;根据需要添加省略号 |
|
||||||
|
| `Str2html` | string | 仅正文部分 | 通过删除其中的 HTML 标签对文本进行清理 |
|
||||||
|
| `Safe` | string | 仅正文部分 | 将输入作为 HTML 处理;可用于 `.ReviewComments.RenderedContent` 等字段 |
|
||||||
|
|
||||||
|
这些都是 _函数_,而不是元数据,因此必须按以下方式使用:
|
||||||
|
|
||||||
|
```html
|
||||||
|
像这样使用: {{Str2html "Escape<my>text"}}
|
||||||
|
或者这样使用: {{"Escape<my>text" | Str2html}}
|
||||||
|
或者这样使用: {{AppUrl}}
|
||||||
|
但不要像这样使用: {{.AppUrl}}
|
||||||
|
```
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "仓库索引器"
|
||||||
|
slug: "repo-indexer"
|
||||||
|
weight: 45
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/repo-indexer
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "仓库索引器"
|
||||||
|
weight: 45
|
||||||
|
identifier: "repo-indexer"
|
||||||
|
---
|
||||||
|
|
||||||
|
# 仓库索引器
|
||||||
|
|
||||||
|
**目录**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
## 设置仓库索引器
|
||||||
|
|
||||||
|
通过在您的 [`app.ini`](https://docs.gitea.io/en-us/config-cheat-sheet/) 中启用此功能,Gitea 可以通过仓库的文件进行搜索:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[indexer]
|
||||||
|
; ...
|
||||||
|
REPO_INDEXER_ENABLED = true
|
||||||
|
REPO_INDEXER_PATH = indexers/repos.bleve
|
||||||
|
MAX_FILE_SIZE = 1048576
|
||||||
|
REPO_INDEXER_INCLUDE =
|
||||||
|
REPO_INDEXER_EXCLUDE = resources/bin/**
|
||||||
|
```
|
||||||
|
|
||||||
|
请记住,索引内容可能会消耗大量系统资源,特别是在首次创建索引或全局更新索引时(例如升级 Gitea 之后)。
|
||||||
|
|
||||||
|
### 按大小选择要索引的文件
|
||||||
|
|
||||||
|
`MAX_FILE_SIZE` 选项将使索引器跳过所有大于指定值的文件。
|
||||||
|
|
||||||
|
### 按路径选择要索引的文件
|
||||||
|
|
||||||
|
Gitea使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。
|
||||||
|
|
||||||
|
限制文件列表可以防止索引被派生或无关的文件(例如 lss、sym、map 等)污染,从而使搜索结果更相关。这还有助于减小索引的大小。
|
||||||
|
|
||||||
|
`REPO_INDEXER_EXCLUDE_VENDORED`(默认值为 true)将排除供应商文件不包含在索引中。
|
||||||
|
|
||||||
|
`REPO_INDEXER_INCLUDE`(默认值为空)是一个逗号分隔的 glob 模式列表,用于在索引中**包含**的文件。空列表表示“_包含所有文件_”。
|
||||||
|
`REPO_INDEXER_EXCLUDE`(默认值为空)是一个逗号分隔的 glob 模式列表,用于从索引中**排除**的文件。与该列表匹配的文件将不会被索引。`REPO_INDEXER_EXCLUDE` 优先于 `REPO_INDEXER_INCLUDE`。
|
||||||
|
|
||||||
|
模式匹配工作方式如下:
|
||||||
|
|
||||||
|
- 要匹配所有带有 `.txt` 扩展名的文件,无论在哪个目录中,请使用 `**.txt`。
|
||||||
|
- 要匹配仅在仓库的根级别中具有 `.txt` 扩展名的所有文件,请使用 `*.txt`。
|
||||||
|
- 要匹配 `resources/bin` 目录及其子目录中的所有文件,请使用 `resources/bin/**`。
|
||||||
|
- 要匹配位于 `resources/bin` 目录下的所有文件,请使用 `resources/bin/*`。
|
||||||
|
- 要匹配所有名为 `Makefile` 的文件,请使用 `**Makefile`。
|
||||||
|
- 匹配目录没有效果;模式 `resources/bin` 不会包含/排除该目录中的文件;`resources/bin/**` 会。
|
||||||
|
- 所有文件和模式都规范化为小写,因此 `**Makefile`、`**makefile` 和 `**MAKEFILE` 是等效的。
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "搜索引擎索引"
|
||||||
|
slug: "search-engines-indexation"
|
||||||
|
weight: 60
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/search-engines-indexation
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "搜索引擎索引"
|
||||||
|
weight: 60
|
||||||
|
identifier: "search-engines-indexation"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Gitea 安装的搜索引擎索引
|
||||||
|
|
||||||
|
默认情况下,您的 Gitea 安装将被搜索引擎索引。
|
||||||
|
如果您不希望您的仓库对搜索引擎可见,请进一步阅读。
|
||||||
|
|
||||||
|
## 使用 robots.txt 阻止搜索引擎索引
|
||||||
|
|
||||||
|
为了使 Gitea 为顶级安装提供自定义的`robots.txt`(默认为空的 404),请在[`custom`文件夹或`CustomPath`]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}})中创建一个名为 `robots.txt` 的文件。
|
||||||
|
|
||||||
|
有关如何配置 `robots.txt` 的示例,请参考 [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt)。
|
||||||
|
|
||||||
|
```txt
|
||||||
|
User-agent: *
|
||||||
|
Disallow: /
|
||||||
|
```
|
||||||
|
|
||||||
|
如果您将Gitea安装在子目录中,则需要在顶级目录中创建或编辑 `robots.txt`。
|
||||||
|
|
||||||
|
```txt
|
||||||
|
User-agent: *
|
||||||
|
Disallow: /gitea/
|
||||||
|
```
|
||||||
@@ -0,0 +1,146 @@
|
|||||||
|
---
|
||||||
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
|
title: "GPG 提交签名"
|
||||||
|
slug: "signing"
|
||||||
|
weight: 50
|
||||||
|
toc: false
|
||||||
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/signing
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
parent: "administration"
|
||||||
|
name: "GPG 提交签名"
|
||||||
|
weight: 50
|
||||||
|
identifier: "signing"
|
||||||
|
---
|
||||||
|
|
||||||
|
# GPG 提交签名
|
||||||
|
|
||||||
|
**目录**
|
||||||
|
|
||||||
|
{{< toc >}}
|
||||||
|
|
||||||
|
Gitea 将通过检查提交是否由 Gitea 数据库中的密钥签名,或者提交是否与 Git 的默认密钥匹配,来验证提供的树中的 GPG 提交签名。
|
||||||
|
|
||||||
|
密钥不会被检查以确定它们是否已过期或撤销。密钥也不会与密钥服务器进行检查。
|
||||||
|
|
||||||
|
如果找不到用于验证提交的密钥,提交将被标记为灰色的未锁定图标。如果提交被标记为红色的未锁定图标,则表示它使用带有 ID 的密钥签名。
|
||||||
|
|
||||||
|
请注意:提交的签署者不必是提交的作者或提交者。
|
||||||
|
|
||||||
|
此功能要求 Git >= 1.7.9,但要实现全部功能,需要 Git >= 2.0.0。
|
||||||
|
|
||||||
|
## 自动签名
|
||||||
|
|
||||||
|
有许多地方 Gitea 会生成提交:
|
||||||
|
|
||||||
|
- 仓库初始化
|
||||||
|
- Wiki 更改
|
||||||
|
- 使用编辑器或 API 进行的 CRUD 操作
|
||||||
|
- 从合并请求进行合并
|
||||||
|
|
||||||
|
根据配置和服务器信任,您可能希望 Gitea 对这些提交进行签名。
|
||||||
|
|
||||||
|
## 安装和生成 Gitea 的 GPG 密钥
|
||||||
|
|
||||||
|
如何安装签名密钥由服务器管理员决定。Gitea 目前使用服务器的 `git` 命令生成所有提交,因此将使用服务器的 `gpg` 进行签名(如果配置了)。管理员应该审查 GPG 的最佳实践 - 特别是可能建议仅安装签名的子密钥,而不是主签名和认证的密钥。
|
||||||
|
|
||||||
|
## 通用配置
|
||||||
|
|
||||||
|
Gitea 的签名配置可以在 `app.ini` 的 `[repository.signing]` 部分找到:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
...
|
||||||
|
[repository.signing]
|
||||||
|
SIGNING_KEY = default
|
||||||
|
SIGNING_NAME =
|
||||||
|
SIGNING_EMAIL =
|
||||||
|
INITIAL_COMMIT = always
|
||||||
|
CRUD_ACTIONS = pubkey, twofa, parentsigned
|
||||||
|
WIKI = never
|
||||||
|
MERGES = pubkey, twofa, basesigned, commitssigned
|
||||||
|
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
### `SIGNING_KEY`
|
||||||
|
|
||||||
|
首先讨论的选项是 `SIGNING_KEY`。有三个主要选项:
|
||||||
|
|
||||||
|
- `none` - 这将阻止 Gitea 对任何提交进行签名
|
||||||
|
- `default` - Gitea 将使用 `git config` 中配置的默认密钥
|
||||||
|
- `KEYID` - Gitea 将使用具有 ID `KEYID` 的 GPG 密钥对提交进行签名。在这种情况下,您应该提供 `SIGNING_NAME` 和 `SIGNING_EMAIL`,以便显示此密钥的信息。
|
||||||
|
|
||||||
|
`default` 选项将读取 `git config` 中的 `commit.gpgsign` 选项 - 如果设置了该选项,它将使用 `user.signingkey`、`user.name` 和 `user.email` 的结果。
|
||||||
|
|
||||||
|
请注意:通过在 Gitea 的仓库中调整 Git 的 `config` 文件,可以使用 `SIGNING_KEY=default` 为每个仓库提供不同的签名密钥。然而,这显然不是一个理想的用户界面,因此可能会发生更改。
|
||||||
|
|
||||||
|
**自 1.17 起**,Gitea 在自己的主目录 `[git].HOME_PATH`(默认为 `%(APP_DATA_PATH)/home`)中运行 git,并使用自己的配置文件 `{[git].HOME_PATH}/.gitconfig`。
|
||||||
|
如果您有自己定制的 Gitea git 配置,您应该将这些配置设置在系统 git 配置文件中(例如 `/etc/gitconfig`)或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。
|
||||||
|
与 git 命令相关的主目录文件(如 `.gnupg`)也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。
|
||||||
|
如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置,请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。
|
||||||
|
|
||||||
|
### `INITIAL_COMMIT`
|
||||||
|
|
||||||
|
此选项确定在创建仓库时,Gitea 是否应该对初始提交进行签名。可能的取值有:
|
||||||
|
|
||||||
|
- `never`:从不签名
|
||||||
|
- `pubkey`:仅在用户拥有公钥时进行签名
|
||||||
|
- `twofa`:仅在用户使用 2FA 登录时进行签名
|
||||||
|
- `always`:始终签名
|
||||||
|
|
||||||
|
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true,则提交将被签名。
|
||||||
|
|
||||||
|
### `WIKI`
|
||||||
|
|
||||||
|
此选项确定 Gitea 是否应该对 Wiki 的提交进行签名。可能的取值有:
|
||||||
|
|
||||||
|
- `never`:从不签名
|
||||||
|
- `pubkey`:仅在用户拥有公钥时进行签名
|
||||||
|
- `twofa`:仅在用户使用 2FA 登录时进行签名
|
||||||
|
- `parentsigned`:仅在父提交已签名时进行签名。
|
||||||
|
- `always`:始终签名
|
||||||
|
|
||||||
|
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true,则提交将被签名。
|
||||||
|
|
||||||
|
### `CRUD_ACTIONS`
|
||||||
|
|
||||||
|
此选项确定 Gitea 是否应该对 Web 编辑器或 API CRUD 操作的提交进行签名。可能的取值有:
|
||||||
|
|
||||||
|
- `never`:从不签名
|
||||||
|
- `pubkey`:仅在用户拥有公钥时进行签名
|
||||||
|
- `twofa`:仅在用户使用 2FA 登录时进行签名
|
||||||
|
- `parentsigned`:仅在父提交已签名时进行签名。
|
||||||
|
- `always`:始终签名
|
||||||
|
|
||||||
|
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true,则更改将被签名。
|
||||||
|
|
||||||
|
### `MERGES`
|
||||||
|
|
||||||
|
此选项确定 Gitea 是否应该对 PR 的合并提交进行签名。可能的选项有:
|
||||||
|
|
||||||
|
- `never`:从不签名
|
||||||
|
- `pubkey`:仅在用户拥有公钥时进行签名
|
||||||
|
- `twofa`:仅在用户使用 2FA 登录时进行签名
|
||||||
|
- `basesigned`:仅在基础仓库中的父提交已签名时进行签名。
|
||||||
|
- `headsigned`:仅在头分支中的头提交已签名时进行签名。
|
||||||
|
- `commitssigned`:仅在头分支中的所有提交到合并点的提交都已签名时进行签名。
|
||||||
|
- `approved`:仅对已批准的合并到受保护分支的提交进行签名。
|
||||||
|
- `always`:始终签名
|
||||||
|
|
||||||
|
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true,则合并将被签名。
|
||||||
|
|
||||||
|
## 获取签名密钥的公钥
|
||||||
|
|
||||||
|
用于签署 Gitea 提交的公钥可以通过 API 获取:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
/api/v1/signing-key.gpg
|
||||||
|
```
|
||||||
|
|
||||||
|
在存在特定于仓库的密钥的情况下,可以通过以下方式获取:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
/api/v1/repos/:username/:reponame/signing-key.gpg
|
||||||
|
```
|
||||||
Reference in new issue
Block a user