mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-13 13:23:44 +00:00
Docusaurus-ify 1.19 (#26053)
See https://github.com/go-gitea/gitea/pull/26051 --------- Signed-off-by: jolheiser <[email protected]> Co-authored-by: Giteabot <[email protected]>
This commit is contained in:
1 parent
94947e2be5
commit
bd74711ecc
217 files changed
+707
-1176
No files matched your search
@@ -2,13 +2,13 @@
|
|||||||
date: "2016-12-01T16:00:00+02:00"
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
title: "Administration"
|
title: "Administration"
|
||||||
slug: "administration"
|
slug: "administration"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
name: "Administration"
|
name: "Administration"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
collapse: true
|
collapse: true
|
||||||
identifier: "administration"
|
identifier: "administration"
|
||||||
---
|
---
|
||||||
@@ -2,12 +2,12 @@
|
|||||||
date: "2017-08-23T09:00:00+02:00"
|
date: "2017-08-23T09:00:00+02:00"
|
||||||
title: "Avancé"
|
title: "Avancé"
|
||||||
slug: "administration"
|
slug: "administration"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
name: "Avancé"
|
name: "Avancé"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "administration"
|
identifier: "administration"
|
||||||
---
|
---
|
||||||
@@ -2,12 +2,12 @@
|
|||||||
date: "2016-12-01T16:00:00+02:00"
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
title: "运维"
|
title: "运维"
|
||||||
slug: "administration"
|
slug: "administration"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
name: "运维"
|
name: "运维"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "administration"
|
identifier: "administration"
|
||||||
---
|
---
|
||||||
@@ -2,12 +2,12 @@
|
|||||||
date: "2016-12-01T16:00:00+02:00"
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
title: "運維"
|
title: "運維"
|
||||||
slug: "administration"
|
slug: "administration"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
name: "運維"
|
name: "運維"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "administration"
|
identifier: "administration"
|
||||||
---
|
---
|
||||||
+2
-2
@@ -2,7 +2,7 @@
|
|||||||
date: "2019-12-28"
|
date: "2019-12-28"
|
||||||
title: "Adding Legal Pages"
|
title: "Adding Legal Pages"
|
||||||
slug: adding-legal-pages
|
slug: adding-legal-pages
|
||||||
weight: 110
|
sidebar_position: 110
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
@@ -10,7 +10,7 @@ menu:
|
|||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Adding Legal Pages"
|
name: "Adding Legal Pages"
|
||||||
identifier: "adding-legal-pages"
|
identifier: "adding-legal-pages"
|
||||||
weight: 110
|
sidebar_position: 110
|
||||||
---
|
---
|
||||||
|
|
||||||
Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Policy) to be added to website. Follow these steps to add them to your Gitea instance.
|
Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Policy) to be added to website. Follow these steps to add them to your Gitea instance.
|
||||||
+2
-2
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "添加法律页面"
|
title: "添加法律页面"
|
||||||
slug: adding-legal-pages
|
slug: adding-legal-pages
|
||||||
weight: 110
|
sidebar_position: 110
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -12,7 +12,7 @@ menu:
|
|||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "添加法律页面"
|
name: "添加法律页面"
|
||||||
identifier: "adding-legal-pages"
|
identifier: "adding-legal-pages"
|
||||||
weight: 110
|
sidebar_position: 110
|
||||||
---
|
---
|
||||||
|
|
||||||
一些法域(例如欧盟)要求在网站上添加特定的法律页面(例如隐私政策)。按照以下步骤将它们添加到你的 Gitea 实例中。
|
一些法域(例如欧盟)要求在网站上添加特定的法律页面(例如隐私政策)。按照以下步骤将它们添加到你的 Gitea 实例中。
|
||||||
+2
-6
@@ -2,14 +2,14 @@
|
|||||||
date: "2017-01-01T16:00:00+02:00"
|
date: "2017-01-01T16:00:00+02:00"
|
||||||
title: "Backup and Restore"
|
title: "Backup and Restore"
|
||||||
slug: "backup-and-restore"
|
slug: "backup-and-restore"
|
||||||
weight: 11
|
sidebar_position: 11
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Backup and Restore"
|
name: "Backup and Restore"
|
||||||
weight: 11
|
sidebar_position: 11
|
||||||
identifier: "backup-and-restore"
|
identifier: "backup-and-restore"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -18,10 +18,6 @@ menu:
|
|||||||
Gitea currently has a `dump` command that will save the installation to a ZIP file. This
|
Gitea currently has a `dump` command that will save the installation to a ZIP file. This
|
||||||
file can be unpacked and used to restore an instance.
|
file can be unpacked and used to restore an instance.
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Backup Consistency
|
## Backup Consistency
|
||||||
|
|
||||||
To ensure the consistency of the Gitea instance, it must be shutdown during backup.
|
To ensure the consistency of the Gitea instance, it must be shutdown during backup.
|
||||||
+2
-2
@@ -2,14 +2,14 @@
|
|||||||
date: "2018-06-06T09:33:00+08:00"
|
date: "2018-06-06T09:33:00+08:00"
|
||||||
title: "备份与恢复"
|
title: "备份与恢复"
|
||||||
slug: "backup-and-restore"
|
slug: "backup-and-restore"
|
||||||
weight: 11
|
sidebar_position: 11
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "备份与恢复"
|
name: "备份与恢复"
|
||||||
weight: 11
|
sidebar_position: 11
|
||||||
identifier: "backup-and-restore"
|
identifier: "backup-and-restore"
|
||||||
---
|
---
|
||||||
|
|
||||||
+2
-2
@@ -2,14 +2,14 @@
|
|||||||
date: "2017-01-01T16:00:00+02:00"
|
date: "2017-01-01T16:00:00+02:00"
|
||||||
title: "用法: 備份與還原"
|
title: "用法: 備份與還原"
|
||||||
slug: "backup-and-restore"
|
slug: "backup-and-restore"
|
||||||
weight: 11
|
sidebar_position: 11
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "備份與還原"
|
name: "備份與還原"
|
||||||
weight: 11
|
sidebar_position: 11
|
||||||
identifier: "backup-and-restore"
|
identifier: "backup-and-restore"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -2,26 +2,22 @@
|
|||||||
date: "2020-01-25T21:00:00-03:00"
|
date: "2020-01-25T21:00:00-03:00"
|
||||||
title: "Embedded data extraction tool"
|
title: "Embedded data extraction tool"
|
||||||
slug: "cmd-embedded"
|
slug: "cmd-embedded"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Embedded data extraction tool"
|
name: "Embedded data extraction tool"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "cmd-embedded"
|
identifier: "cmd-embedded"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Embedded data extraction tool
|
# Embedded data extraction tool
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea's executable contains all the resources required to run: templates, images, style-sheets
|
Gitea's executable contains all the resources required to run: templates, images, style-sheets
|
||||||
and translations. Any of them can be overridden by placing a replacement in a matching path
|
and translations. Any of them can be overridden by placing a replacement in a matching path
|
||||||
inside the `custom` directory (see [Customizing Gitea]({{< relref "doc/administration/customizing-gitea.en-us.md" >}})).
|
inside the `custom` directory (see [Customizing Gitea](administration/customizing-gitea.md)).
|
||||||
|
|
||||||
To obtain a copy of the embedded resources ready for editing, the `embedded` command from the CLI
|
To obtain a copy of the embedded resources ready for editing, the `embedded` command from the CLI
|
||||||
can be used from the OS shell interface.
|
can be used from the OS shell interface.
|
||||||
@@ -85,7 +81,7 @@ The default is the current directory.
|
|||||||
The `--custom` flag tells Gitea to extract the files directly into the `custom` directory.
|
The `--custom` flag tells Gitea to extract the files directly into the `custom` directory.
|
||||||
For this to work, the command needs to know the location of the `app.ini` configuration
|
For this to work, the command needs to know the location of the `app.ini` configuration
|
||||||
file (`--config`) and, depending of the configuration, be ran from the directory where
|
file (`--config`) and, depending of the configuration, be ran from the directory where
|
||||||
Gitea normally starts. See [Customizing Gitea]({{< relref "doc/administration/customizing-gitea.en-us.md" >}}) for details.
|
Gitea normally starts. See [Customizing Gitea](administration/customizing-gitea.md) for details.
|
||||||
|
|
||||||
The `--overwrite` flag allows any existing files in the destination directory to be overwritten.
|
The `--overwrite` flag allows any existing files in the destination directory to be overwritten.
|
||||||
|
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "嵌入资源提取工具"
|
title: "嵌入资源提取工具"
|
||||||
slug: "cmd-embedded"
|
slug: "cmd-embedded"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,17 +11,13 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "嵌入资源提取工具"
|
name: "嵌入资源提取工具"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "cmd-embedded"
|
identifier: "cmd-embedded"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 嵌入资源提取工具
|
# 嵌入资源提取工具
|
||||||
|
|
||||||
**目录**
|
Gitea 的可执行文件包含了运行所需的所有资源:模板、图片、样式表和翻译文件。你可以通过在 `custom` 目录下的相应路径中放置替换文件来覆盖其中的任何资源(详见 [自定义 Gitea 配置](administration/customizing-gitea.md))。
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea 的可执行文件包含了运行所需的所有资源:模板、图片、样式表和翻译文件。你可以通过在 `custom` 目录下的相应路径中放置替换文件来覆盖其中的任何资源(详见 [自定义 Gitea 配置]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}}))。
|
|
||||||
|
|
||||||
要获取嵌入资源的副本以进行编辑,可以使用 CLI 中的 `embedded` 命令,通过操作系统的 shell 执行。
|
要获取嵌入资源的副本以进行编辑,可以使用 CLI 中的 `embedded` 命令,通过操作系统的 shell 执行。
|
||||||
|
|
||||||
@@ -75,7 +71,7 @@ gitea [--config {file}] embedded extract [--destination {dir}|--custom] [--overw
|
|||||||
|
|
||||||
`--destination` 选项用于指定提取文件的目标目录。默认为当前目录。
|
`--destination` 选项用于指定提取文件的目标目录。默认为当前目录。
|
||||||
|
|
||||||
`--custom` 标志告知 Gitea 直接将文件提取到 `custom` 目录中。为使其正常工作,该命令需要知道 `app.ini` 配置文件的位置(通过 `--config` 指定),并且根据配置的不同,需要从 Gitea 通常启动的目录运行。有关详细信息,请参阅 [自定义 Gitea 配置]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}})。
|
`--custom` 标志告知 Gitea 直接将文件提取到 `custom` 目录中。为使其正常工作,该命令需要知道 `app.ini` 配置文件的位置(通过 `--config` 指定),并且根据配置的不同,需要从 Gitea 通常启动的目录运行。有关详细信息,请参阅 [自定义 Gitea 配置](administration/customizing-gitea.md)。
|
||||||
|
|
||||||
`--overwrite` 标志允许覆盖目标目录中的任何现有文件。
|
`--overwrite` 标志允许覆盖目标目录中的任何现有文件。
|
||||||
|
|
||||||
@@ -2,23 +2,19 @@
|
|||||||
date: "2017-01-01T16:00:00+02:00"
|
date: "2017-01-01T16:00:00+02:00"
|
||||||
title: "Command Line"
|
title: "Command Line"
|
||||||
slug: "command-line"
|
slug: "command-line"
|
||||||
weight: 1
|
sidebar_position: 1
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Command Line"
|
name: "Command Line"
|
||||||
weight: 1
|
sidebar_position: 1
|
||||||
identifier: "command-line"
|
identifier: "command-line"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Command Line
|
# Command Line
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
`gitea [global options] command [command or global options] [arguments...]`
|
`gitea [global options] command [command or global options] [arguments...]`
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "Gitea 命令行"
|
title: "Gitea 命令行"
|
||||||
slug: "command-line"
|
slug: "command-line"
|
||||||
weight: 1
|
sidebar_position: 1
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Gitea 命令行"
|
name: "Gitea 命令行"
|
||||||
weight: 1
|
sidebar_position: 1
|
||||||
identifier: "command-line"
|
identifier: "command-line"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 命令行
|
# 命令行
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## 用法
|
## 用法
|
||||||
|
|
||||||
`gitea [全局选项] 命令 [命令或全局选项] [参数...]`
|
`gitea [全局选项] 命令 [命令或全局选项] [参数...]`
|
||||||
+55
-57
@@ -2,14 +2,14 @@
|
|||||||
date: "2016-12-26T16:00:00+02:00"
|
date: "2016-12-26T16:00:00+02:00"
|
||||||
title: "Config Cheat Sheet"
|
title: "Config Cheat Sheet"
|
||||||
slug: "config-cheat-sheet"
|
slug: "config-cheat-sheet"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Config Cheat Sheet"
|
name: "Config Cheat Sheet"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
identifier: "config-cheat-sheet"
|
identifier: "config-cheat-sheet"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -33,8 +33,6 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
|
|||||||
|
|
||||||
**Note:** A full restart is required for Gitea configuration changes to take effect.
|
**Note:** A full restart is required for Gitea configuration changes to take effect.
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Default Configuration (non-`app.ini` configuration)
|
## Default Configuration (non-`app.ini` configuration)
|
||||||
|
|
||||||
These values are environment-dependent but form the basis of a lot of values. They will be
|
These values are environment-dependent but form the basis of a lot of values. They will be
|
||||||
@@ -80,7 +78,7 @@ In addition there is _`StaticRootPath`_ which can be set as a built-in at build
|
|||||||
- `SCRIPT_TYPE`: **bash**: The script type this server supports. Usually this is `bash`,
|
- `SCRIPT_TYPE`: **bash**: The script type this server supports. Usually this is `bash`,
|
||||||
but some users report that only `sh` is available.
|
but some users report that only `sh` is available.
|
||||||
- `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**: Tie-break order of detected charsets - if the detected charsets have equal confidence, charsets earlier in the list will be chosen in preference to those later. Adding `defaults` will place the unnamed charsets at that point.
|
- `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**: Tie-break order of detected charsets - if the detected charsets have equal confidence, charsets earlier in the list will be chosen in preference to those later. Adding `defaults` will place the unnamed charsets at that point.
|
||||||
- `ANSI_CHARSET`: **\<empty\>**: Default ANSI charset to override non-UTF-8 charsets to.
|
- `ANSI_CHARSET`: **_empty_**: Default ANSI charset to override non-UTF-8 charsets to.
|
||||||
- `FORCE_PRIVATE`: **false**: Force every new repository to be private.
|
- `FORCE_PRIVATE`: **false**: Force every new repository to be private.
|
||||||
- `DEFAULT_PRIVATE`: **last**: Default private when creating a new repository.
|
- `DEFAULT_PRIVATE`: **last**: Default private when creating a new repository.
|
||||||
\[last, private, public\]
|
\[last, private, public\]
|
||||||
@@ -97,7 +95,7 @@ In addition there is _`StaticRootPath`_ which can be set as a built-in at build
|
|||||||
HTTP protocol.
|
HTTP protocol.
|
||||||
- `USE_COMPAT_SSH_URI`: **false**: Force ssh:// clone url instead of scp-style uri when
|
- `USE_COMPAT_SSH_URI`: **false**: Force ssh:// clone url instead of scp-style uri when
|
||||||
default SSH port is used.
|
default SSH port is used.
|
||||||
- `ACCESS_CONTROL_ALLOW_ORIGIN`: **\<empty\>**: Value for Access-Control-Allow-Origin header,
|
- `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**: Value for Access-Control-Allow-Origin header,
|
||||||
default is not to present. **WARNING**: This maybe harmful to you website if you do not
|
default is not to present. **WARNING**: This maybe harmful to you website if you do not
|
||||||
give it a right value.
|
give it a right value.
|
||||||
- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: Close an issue if a commit on a non default branch marks it as closed.
|
- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: Close an issue if a commit on a non default branch marks it as closed.
|
||||||
@@ -146,13 +144,13 @@ In addition there is _`StaticRootPath`_ which can be set as a built-in at build
|
|||||||
|
|
||||||
- `ENABLED`: **true**: Whether repository file uploads are enabled
|
- `ENABLED`: **true**: Whether repository file uploads are enabled
|
||||||
- `TEMP_PATH`: **data/tmp/uploads**: Path for uploads (content gets deleted on Gitea restart)
|
- `TEMP_PATH`: **data/tmp/uploads**: Path for uploads (content gets deleted on Gitea restart)
|
||||||
- `ALLOWED_TYPES`: **\<empty\>**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
|
- `ALLOWED_TYPES`: **_empty_**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
|
||||||
- `FILE_MAX_SIZE`: **3**: Max size of each file in megabytes.
|
- `FILE_MAX_SIZE`: **3**: Max size of each file in megabytes.
|
||||||
- `MAX_FILES`: **5**: Max number of files per upload
|
- `MAX_FILES`: **5**: Max number of files per upload
|
||||||
|
|
||||||
### Repository - Release (`repository.release`)
|
### Repository - Release (`repository.release`)
|
||||||
|
|
||||||
- `ALLOWED_TYPES`: **\<empty\>**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
|
- `ALLOWED_TYPES`: **_empty_**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
|
||||||
- `DEFAULT_PAGING_NUM`: **10**: The default paging number of releases user interface
|
- `DEFAULT_PAGING_NUM`: **10**: The default paging number of releases user interface
|
||||||
- For settings related to file attachments on releases, see the `attachment` section.
|
- For settings related to file attachments on releases, see the `attachment` section.
|
||||||
|
|
||||||
@@ -220,7 +218,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
|||||||
- `SHOW_USER_EMAIL`: **true**: Whether the email of the user should be shown in the Explore Users page.
|
- `SHOW_USER_EMAIL`: **true**: Whether the email of the user should be shown in the Explore Users page.
|
||||||
- `THEMES`: **auto,gitea,arc-green**: All available themes. Allow users select personalized themes.
|
- `THEMES`: **auto,gitea,arc-green**: All available themes. Allow users select personalized themes.
|
||||||
regardless of the value of `DEFAULT_THEME`.
|
regardless of the value of `DEFAULT_THEME`.
|
||||||
- `THEME_COLOR_META_TAG`: **\<empty\>**: Value of `theme-color` meta tag, used by some mobile browers for chrome and out-of-viewport areas. Default is unset which uses body color.
|
- `THEME_COLOR_META_TAG`: **_empty_**: Value of `theme-color` meta tag, used by some mobile browers for chrome and out-of-viewport areas. Default is unset which uses body color.
|
||||||
- `MAX_DISPLAY_FILE_SIZE`: **8388608**: Max size of files to be displayed (default is 8MiB)
|
- `MAX_DISPLAY_FILE_SIZE`: **8388608**: Max size of files to be displayed (default is 8MiB)
|
||||||
- `REACTIONS`: All available reactions users can choose on issues/prs and comments
|
- `REACTIONS`: All available reactions users can choose on issues/prs and comments
|
||||||
Values can be emoji alias (:smile:) or a unicode emoji.
|
Values can be emoji alias (:smile:) or a unicode emoji.
|
||||||
@@ -291,7 +289,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
|||||||
- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP\_PORT)s/**:
|
- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP\_PORT)s/**:
|
||||||
Overwrite the automatically generated public URL.
|
Overwrite the automatically generated public URL.
|
||||||
This is useful if the internal and the external URL don't match (e.g. in Docker).
|
This is useful if the internal and the external URL don't match (e.g. in Docker).
|
||||||
- `STATIC_URL_PREFIX`: **\<empty\>**:
|
- `STATIC_URL_PREFIX`: **_empty_**:
|
||||||
Overwrite this option to request static resources from a different URL.
|
Overwrite this option to request static resources from a different URL.
|
||||||
This includes CSS files, images, JS files and web fonts.
|
This includes CSS files, images, JS files and web fonts.
|
||||||
Avatar images are dynamic resources and still served by Gitea.
|
Avatar images are dynamic resources and still served by Gitea.
|
||||||
@@ -334,7 +332,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
|||||||
- `SSH_ROOT_PATH`: **~/.ssh**: Root path of SSH directory.
|
- `SSH_ROOT_PATH`: **~/.ssh**: Root path of SSH directory.
|
||||||
- `SSH_CREATE_AUTHORIZED_KEYS_FILE`: **true**: Gitea will create a authorized_keys file by default when it is not using the internal ssh server. If you intend to use the AuthorizedKeysCommand functionality then you should turn this off.
|
- `SSH_CREATE_AUTHORIZED_KEYS_FILE`: **true**: Gitea will create a authorized_keys file by default when it is not using the internal ssh server. If you intend to use the AuthorizedKeysCommand functionality then you should turn this off.
|
||||||
- `SSH_AUTHORIZED_KEYS_BACKUP`: **true**: Enable SSH Authorized Key Backup when rewriting all keys, default is true.
|
- `SSH_AUTHORIZED_KEYS_BACKUP`: **true**: Enable SSH Authorized Key Backup when rewriting all keys, default is true.
|
||||||
- `SSH_TRUSTED_USER_CA_KEYS`: **\<empty\>**: Specifies the public keys of certificate authorities that are trusted to sign user certificates for authentication. Multiple keys should be comma separated. E.g.`ssh-<algorithm> <key>` or `ssh-<algorithm> <key1>, ssh-<algorithm> <key2>`. For more information see `TrustedUserCAKeys` in the sshd config man pages. When empty no file will be created and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` will default to `off`.
|
- `SSH_TRUSTED_USER_CA_KEYS`: **_empty_**: Specifies the public keys of certificate authorities that are trusted to sign user certificates for authentication. Multiple keys should be comma separated. E.g.`ssh-<algorithm> <key>` or `ssh-<algorithm> <key1>, ssh-<algorithm> <key2>`. For more information see `TrustedUserCAKeys` in the sshd config man pages. When empty no file will be created and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` will default to `off`.
|
||||||
- `SSH_TRUSTED_USER_CA_KEYS_FILENAME`: **`RUN_USER`/.ssh/gitea-trusted-user-ca-keys.pem**: Absolute path of the `TrustedUserCaKeys` file Gitea will manage. If you're running your own ssh server and you want to use the Gitea managed file you'll also need to modify your sshd_config to point to this file. The official docker image will automatically work without further configuration.
|
- `SSH_TRUSTED_USER_CA_KEYS_FILENAME`: **`RUN_USER`/.ssh/gitea-trusted-user-ca-keys.pem**: Absolute path of the `TrustedUserCaKeys` file Gitea will manage. If you're running your own ssh server and you want to use the Gitea managed file you'll also need to modify your sshd_config to point to this file. The official docker image will automatically work without further configuration.
|
||||||
- `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** or **username, email**: \[off, username, email, anything\]: Specify the principals values that users are allowed to use as principal. When set to `anything` no checks are done on the principal string. When set to `off` authorized principal are not allowed to be set.
|
- `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** or **username, email**: \[off, username, email, anything\]: Specify the principals values that users are allowed to use as principal. When set to `anything` no checks are done on the principal string. When set to `off` authorized principal are not allowed to be set.
|
||||||
- `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: Gitea will create a authorized_principals file by default when it is not using the internal ssh server and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`.
|
- `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: Gitea will create a authorized_principals file by default when it is not using the internal ssh server and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`.
|
||||||
@@ -364,7 +362,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
|||||||
- `LANDING_PAGE`: **home**: Landing page for unauthenticated users \[home, explore, organizations, login, **custom**\]. Where custom would instead be any URL such as "/org/repo" or even `https://anotherwebsite.com`
|
- `LANDING_PAGE`: **home**: Landing page for unauthenticated users \[home, explore, organizations, login, **custom**\]. Where custom would instead be any URL such as "/org/repo" or even `https://anotherwebsite.com`
|
||||||
- `LFS_START_SERVER`: **false**: Enables Git LFS support.
|
- `LFS_START_SERVER`: **false**: Enables Git LFS support.
|
||||||
- `LFS_CONTENT_PATH`: **%(APP_DATA_PATH)s/lfs**: Default LFS content path. (if it is on local storage.) **DEPRECATED** use settings in `[lfs]`.
|
- `LFS_CONTENT_PATH`: **%(APP_DATA_PATH)s/lfs**: Default LFS content path. (if it is on local storage.) **DEPRECATED** use settings in `[lfs]`.
|
||||||
- `LFS_JWT_SECRET`: **\<empty\>**: LFS authentication secret, change this a unique string.
|
- `LFS_JWT_SECRET`: **_empty_**: LFS authentication secret, change this a unique string.
|
||||||
- `LFS_HTTP_AUTH_EXPIRY`: **20m**: LFS authentication validity period in time.Duration, pushes taking longer than this may fail.
|
- `LFS_HTTP_AUTH_EXPIRY`: **20m**: LFS authentication validity period in time.Duration, pushes taking longer than this may fail.
|
||||||
- `LFS_MAX_FILE_SIZE`: **0**: Maximum allowed LFS file size in bytes (Set to 0 for no limit).
|
- `LFS_MAX_FILE_SIZE`: **0**: Maximum allowed LFS file size in bytes (Set to 0 for no limit).
|
||||||
- `LFS_LOCKS_PAGING_NUM`: **50**: Maximum number of LFS Locks returned per page.
|
- `LFS_LOCKS_PAGING_NUM`: **50**: Maximum number of LFS Locks returned per page.
|
||||||
@@ -373,7 +371,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
|||||||
- `REDIRECTOR_USE_PROXY_PROTOCOL`: **%(USE_PROXY_PROTOCOL)s**: expect PROXY protocol header on connections to https redirector.
|
- `REDIRECTOR_USE_PROXY_PROTOCOL`: **%(USE_PROXY_PROTOCOL)s**: expect PROXY protocol header on connections to https redirector.
|
||||||
- `PORT_TO_REDIRECT`: **80**: Port for the http redirection service to listen on. Used when `REDIRECT_OTHER_PORT` is true.
|
- `PORT_TO_REDIRECT`: **80**: Port for the http redirection service to listen on. Used when `REDIRECT_OTHER_PORT` is true.
|
||||||
- `SSL_MIN_VERSION`: **TLSv1.2**: Set the minimum version of ssl support.
|
- `SSL_MIN_VERSION`: **TLSv1.2**: Set the minimum version of ssl support.
|
||||||
- `SSL_MAX_VERSION`: **\<empty\>**: Set the maximum version of ssl support.
|
- `SSL_MAX_VERSION`: **_empty_**: Set the maximum version of ssl support.
|
||||||
- `SSL_CURVE_PREFERENCES`: **X25519,P256**: Set the preferred curves,
|
- `SSL_CURVE_PREFERENCES`: **X25519,P256**: Set the preferred curves,
|
||||||
- `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**: Set the preferred cipher suites.
|
- `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**: Set the preferred cipher suites.
|
||||||
- If there is no hardware support for AES suites, by default the ChaCha suites will be preferred over the AES suites.
|
- If there is no hardware support for AES suites, by default the ChaCha suites will be preferred over the AES suites.
|
||||||
@@ -409,11 +407,11 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
|||||||
- "ecdhe_rsa_with_chacha20_poly1305" is an alias for "ecdhe_rsa_with_chacha20_poly1305_sha256"
|
- "ecdhe_rsa_with_chacha20_poly1305" is an alias for "ecdhe_rsa_with_chacha20_poly1305_sha256"
|
||||||
- "ecdhe_ecdsa_with_chacha20_poly1305" is alias for "ecdhe_ecdsa_with_chacha20_poly1305_sha256"
|
- "ecdhe_ecdsa_with_chacha20_poly1305" is alias for "ecdhe_ecdsa_with_chacha20_poly1305_sha256"
|
||||||
- `ENABLE_ACME`: **false**: Flag to enable automatic certificate management via an ACME capable Certificate Authority (CA) server (default: Lets Encrypt). If enabled, `CERT_FILE` and `KEY_FILE` are ignored, and the CA must resolve `DOMAIN` to this gitea server. Ensure that DNS records are set and either port `80` or port `443` are accessible by the CA server (the public internet by default), and redirected to the appropriate ports `PORT_TO_REDIRECT` or `HTTP_PORT` respectively.
|
- `ENABLE_ACME`: **false**: Flag to enable automatic certificate management via an ACME capable Certificate Authority (CA) server (default: Lets Encrypt). If enabled, `CERT_FILE` and `KEY_FILE` are ignored, and the CA must resolve `DOMAIN` to this gitea server. Ensure that DNS records are set and either port `80` or port `443` are accessible by the CA server (the public internet by default), and redirected to the appropriate ports `PORT_TO_REDIRECT` or `HTTP_PORT` respectively.
|
||||||
- `ACME_URL`: **\<empty\>**: The CA's ACME directory URL, e.g. for a self-hosted [smallstep CA server](https://github.com/smallstep/certificates), it can look like `https://ca.example.com/acme/acme/directory`. If left empty, it defaults to using Let's Encerypt's production CA (check `LETSENCRYPT_ACCEPTTOS` as well).
|
- `ACME_URL`: **_empty_**: The CA's ACME directory URL, e.g. for a self-hosted [smallstep CA server](https://github.com/smallstep/certificates), it can look like `https://ca.example.com/acme/acme/directory`. If left empty, it defaults to using Let's Encerypt's production CA (check `LETSENCRYPT_ACCEPTTOS` as well).
|
||||||
- `ACME_ACCEPTTOS`: **false**: This is an explicit check that you accept the terms of service of the ACME provider. The default is Lets Encrypt [terms of service](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf).
|
- `ACME_ACCEPTTOS`: **false**: This is an explicit check that you accept the terms of service of the ACME provider. The default is Lets Encrypt [terms of service](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf).
|
||||||
- `ACME_DIRECTORY`: **https**: Directory that the certificate manager will use to cache information such as certs and private keys.
|
- `ACME_DIRECTORY`: **https**: Directory that the certificate manager will use to cache information such as certs and private keys.
|
||||||
- `ACME_EMAIL`: **\<empty\>**: Email used for the ACME registration. Usually it is to notify about problems with issued certificates.
|
- `ACME_EMAIL`: **_empty_**: Email used for the ACME registration. Usually it is to notify about problems with issued certificates.
|
||||||
- `ACME_CA_ROOT`: **\<empty\>**: The CA's root certificate. If left empty, it defaults to using the system's trust chain.
|
- `ACME_CA_ROOT`: **_empty_**: The CA's root certificate. If left empty, it defaults to using the system's trust chain.
|
||||||
- `ALLOW_GRACEFUL_RESTARTS`: **true**: Perform a graceful restart on SIGHUP
|
- `ALLOW_GRACEFUL_RESTARTS`: **true**: Perform a graceful restart on SIGHUP
|
||||||
- `GRACEFUL_HAMMER_TIME`: **60s**: After a restart the parent process will stop accepting new connections and will allow requests to finish before stopping. Shutdown will be forced if it takes longer than this time.
|
- `GRACEFUL_HAMMER_TIME`: **60s**: After a restart the parent process will stop accepting new connections and will allow requests to finish before stopping. Shutdown will be forced if it takes longer than this time.
|
||||||
- `STARTUP_TIMEOUT`: **0**: Shutsdown the server if startup takes longer than the provided time. On Windows setting this sends a waithint to the SVC host to tell the SVC host startup may take some time. Please note startup is determined by the opening of the listeners - HTTP/HTTPS/SSH. Indexers may take longer to startup and can have their own timeouts.
|
- `STARTUP_TIMEOUT`: **0**: Shutsdown the server if startup takes longer than the provided time. On Windows setting this sends a waithint to the SVC host to tell the SVC host startup may take some time. Please note startup is determined by the opening of the listeners - HTTP/HTTPS/SSH. Indexers may take longer to startup and can have their own timeouts.
|
||||||
@@ -424,8 +422,8 @@ The following configuration set `Content-Type: application/vnd.android.package-a
|
|||||||
- `HOST`: **127.0.0.1:3306**: Database host address and port or absolute path for unix socket \[mysql, postgres\] (ex: /var/run/mysqld/mysqld.sock).
|
- `HOST`: **127.0.0.1:3306**: Database host address and port or absolute path for unix socket \[mysql, postgres\] (ex: /var/run/mysqld/mysqld.sock).
|
||||||
- `NAME`: **gitea**: Database name.
|
- `NAME`: **gitea**: Database name.
|
||||||
- `USER`: **root**: Database username.
|
- `USER`: **root**: Database username.
|
||||||
- `PASSWD`: **\<empty\>**: Database user password. Use \`your password\` or """your password""" for quoting if you use special characters in the password.
|
- `PASSWD`: **_empty_**: Database user password. Use \`your password\` or """your password""" for quoting if you use special characters in the password.
|
||||||
- `SCHEMA`: **\<empty\>**: For PostgreSQL only, schema to use if different from "public". The schema must exist beforehand,
|
- `SCHEMA`: **_empty_**: For PostgreSQL only, schema to use if different from "public". The schema must exist beforehand,
|
||||||
the user must have creation privileges on it, and the user search path must be set to the look into the schema first
|
the user must have creation privileges on it, and the user search path must be set to the look into the schema first
|
||||||
(e.g. `ALTER USER user SET SEARCH_PATH = schema_name,"$user",public;`).
|
(e.g. `ALTER USER user SET SEARCH_PATH = schema_name,"$user",public;`).
|
||||||
- `SSL_MODE`: **disable**: SSL/TLS encryption mode for connecting to the database. This option is only applied for PostgreSQL and MySQL.
|
- `SSL_MODE`: **disable**: SSL/TLS encryption mode for connecting to the database. This option is only applied for PostgreSQL and MySQL.
|
||||||
@@ -543,7 +541,7 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
|
|||||||
|
|
||||||
- `INSTALL_LOCK`: **false**: Controls access to the installation page. When set to "true", the installation page is not accessible.
|
- `INSTALL_LOCK`: **false**: Controls access to the installation page. When set to "true", the installation page is not accessible.
|
||||||
- `SECRET_KEY`: **\<random at every install\>**: Global secret key. This key is VERY IMPORTANT, if you lost it, the data encrypted by it (like 2FA secret) can't be decrypted anymore.
|
- `SECRET_KEY`: **\<random at every install\>**: Global secret key. This key is VERY IMPORTANT, if you lost it, the data encrypted by it (like 2FA secret) can't be decrypted anymore.
|
||||||
- `SECRET_KEY_URI`: **<empty>**: Instead of defining SECRET_KEY, this option can be used to use the key stored in a file (example value: `file:/etc/gitea/secret_key`). It shouldn't be lost like SECRET_KEY.
|
- `SECRET_KEY_URI`: **_empty_**: Instead of defining SECRET_KEY, this option can be used to use the key stored in a file (example value: `file:/etc/gitea/secret_key`). It shouldn't be lost like SECRET_KEY.
|
||||||
- `LOGIN_REMEMBER_DAYS`: **7**: Cookie lifetime, in days.
|
- `LOGIN_REMEMBER_DAYS`: **7**: Cookie lifetime, in days.
|
||||||
- `COOKIE_USERNAME`: **gitea\_awesome**: Name of the cookie used to store the current username.
|
- `COOKIE_USERNAME`: **gitea\_awesome**: Name of the cookie used to store the current username.
|
||||||
- `COOKIE_REMEMBER_NAME`: **gitea\_incredible**: Name of cookie used to store authentication
|
- `COOKIE_REMEMBER_NAME`: **gitea\_incredible**: Name of cookie used to store authentication
|
||||||
@@ -569,7 +567,7 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
|
|||||||
- `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: Set to `false` to allow local users to push to gitea-repositories without setting up the Gitea environment. This is not recommended and if you want local users to push to Gitea repositories you should set the environment appropriately.
|
- `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: Set to `false` to allow local users to push to gitea-repositories without setting up the Gitea environment. This is not recommended and if you want local users to push to Gitea repositories you should set the environment appropriately.
|
||||||
- `IMPORT_LOCAL_PATHS`: **false**: Set to `false` to prevent all users (including admin) from importing local path on server.
|
- `IMPORT_LOCAL_PATHS`: **false**: Set to `false` to prevent all users (including admin) from importing local path on server.
|
||||||
- `INTERNAL_TOKEN`: **\<random at every install if no uri set\>**: Secret used to validate communication within Gitea binary.
|
- `INTERNAL_TOKEN`: **\<random at every install if no uri set\>**: Secret used to validate communication within Gitea binary.
|
||||||
- `INTERNAL_TOKEN_URI`: **<empty>**: Instead of defining INTERNAL_TOKEN in the configuration, this configuration option can be used to give Gitea a path to a file that contains the internal token (example value: `file:/etc/gitea/internal_token`)
|
- `INTERNAL_TOKEN_URI`: **_empty_**: Instead of defining INTERNAL_TOKEN in the configuration, this configuration option can be used to give Gitea a path to a file that contains the internal token (example value: `file:/etc/gitea/internal_token`)
|
||||||
- `PASSWORD_HASH_ALGO`: **pbkdf2**: The hash algorithm to use \[argon2, pbkdf2, pbkdf2_v1, pbkdf2_hi, scrypt, bcrypt\], argon2 and scrypt will spend significant amounts of memory.
|
- `PASSWORD_HASH_ALGO`: **pbkdf2**: The hash algorithm to use \[argon2, pbkdf2, pbkdf2_v1, pbkdf2_hi, scrypt, bcrypt\], argon2 and scrypt will spend significant amounts of memory.
|
||||||
- Note: The default parameters for `pbkdf2` hashing have changed - the previous settings are available as `pbkdf2_v1` but are not recommended.
|
- Note: The default parameters for `pbkdf2` hashing have changed - the previous settings are available as `pbkdf2_v1` but are not recommended.
|
||||||
- The hash functions may be tuned by using `$` after the algorithm:
|
- The hash functions may be tuned by using `$` after the algorithm:
|
||||||
@@ -600,23 +598,23 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
|
|||||||
## Camo (`camo`)
|
## Camo (`camo`)
|
||||||
|
|
||||||
- `ENABLED`: **false**: Enable media proxy, we support images only at the moment.
|
- `ENABLED`: **false**: Enable media proxy, we support images only at the moment.
|
||||||
- `SERVER_URL`: **<empty>**: URL of camo server, it **is required** if camo is enabled.
|
- `SERVER_URL`: **_empty_**: URL of camo server, it **is required** if camo is enabled.
|
||||||
- `HMAC_KEY`: **<empty>**: Provide the HMAC key for encoding URLs, it **is required** if camo is enabled.
|
- `HMAC_KEY`: **_empty_**: Provide the HMAC key for encoding URLs, it **is required** if camo is enabled.
|
||||||
- `ALLWAYS`: **false**: Set to true to use camo for both HTTP and HTTPS content, otherwise only non-HTTPS URLs are proxied
|
- `ALLWAYS`: **false**: Set to true to use camo for both HTTP and HTTPS content, otherwise only non-HTTPS URLs are proxied
|
||||||
|
|
||||||
## OpenID (`openid`)
|
## OpenID (`openid`)
|
||||||
|
|
||||||
- `ENABLE_OPENID_SIGNIN`: **false**: Allow authentication in via OpenID.
|
- `ENABLE_OPENID_SIGNIN`: **false**: Allow authentication in via OpenID.
|
||||||
- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION**: Allow registering via OpenID.
|
- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION**: Allow registering via OpenID.
|
||||||
- `WHITELISTED_URIS`: **\<empty\>**: If non-empty, list of POSIX regex patterns matching
|
- `WHITELISTED_URIS`: **_empty_**: If non-empty, list of POSIX regex patterns matching
|
||||||
OpenID URI's to permit.
|
OpenID URI's to permit.
|
||||||
- `BLACKLISTED_URIS`: **\<empty\>**: If non-empty, list of POSIX regex patterns matching
|
- `BLACKLISTED_URIS`: **_empty_**: If non-empty, list of POSIX regex patterns matching
|
||||||
OpenID URI's to block.
|
OpenID URI's to block.
|
||||||
|
|
||||||
## OAuth2 Client (`oauth2_client`)
|
## OAuth2 Client (`oauth2_client`)
|
||||||
|
|
||||||
- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER\_EMAIL\_CONFIRM**: Set this to enable or disable email confirmation of OAuth2 auto-registration. (Overwrites the REGISTER\_EMAIL\_CONFIRM setting of the `[service]` section)
|
- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER\_EMAIL\_CONFIRM**: Set this to enable or disable email confirmation of OAuth2 auto-registration. (Overwrites the REGISTER\_EMAIL\_CONFIRM setting of the `[service]` section)
|
||||||
- `OPENID_CONNECT_SCOPES`: **\<empty\>**: List of additional openid connect scopes. (`openid` is implicitly added)
|
- `OPENID_CONNECT_SCOPES`: **_empty_**: List of additional openid connect scopes. (`openid` is implicitly added)
|
||||||
- `ENABLE_AUTO_REGISTRATION`: **false**: Automatically create user accounts for new oauth2 users.
|
- `ENABLE_AUTO_REGISTRATION`: **false**: Automatically create user accounts for new oauth2 users.
|
||||||
- `USERNAME`: **nickname**: The source of the username for new oauth2 accounts:
|
- `USERNAME`: **nickname**: The source of the username for new oauth2 accounts:
|
||||||
- userid - use the userid / sub attribute
|
- userid - use the userid / sub attribute
|
||||||
@@ -680,9 +678,9 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
|
|||||||
- `ENABLE_TIMETRACKING`: **true**: Enable Timetracking feature.
|
- `ENABLE_TIMETRACKING`: **true**: Enable Timetracking feature.
|
||||||
- `DEFAULT_ENABLE_TIMETRACKING`: **true**: Allow repositories to use timetracking by default.
|
- `DEFAULT_ENABLE_TIMETRACKING`: **true**: Allow repositories to use timetracking by default.
|
||||||
- `DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME`: **true**: Only allow users with write permissions to track time.
|
- `DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME`: **true**: Only allow users with write permissions to track time.
|
||||||
- `EMAIL_DOMAIN_WHITELIST`: **\<empty\>**: If non-empty, list of domain names that can only be used to register
|
- `EMAIL_DOMAIN_WHITELIST`: **_empty_**: If non-empty, list of domain names that can only be used to register
|
||||||
on this instance.
|
on this instance.
|
||||||
- `EMAIL_DOMAIN_BLOCKLIST`: **\<empty\>**: If non-empty, list of domain names that cannot be used to register on this instance
|
- `EMAIL_DOMAIN_BLOCKLIST`: **_empty_**: If non-empty, list of domain names that cannot be used to register on this instance
|
||||||
- `SHOW_REGISTRATION_BUTTON`: **! DISABLE\_REGISTRATION**: Show Registration Button
|
- `SHOW_REGISTRATION_BUTTON`: **! DISABLE\_REGISTRATION**: Show Registration Button
|
||||||
- `SHOW_MILESTONES_DASHBOARD_PAGE`: **true** Enable this to show the milestones dashboard page - a view of all the user's milestones
|
- `SHOW_MILESTONES_DASHBOARD_PAGE`: **true** Enable this to show the milestones dashboard page - a view of all the user's milestones
|
||||||
- `AUTO_WATCH_NEW_REPOS`: **true**: Enable this to let all organisation users watch new repos when they are created
|
- `AUTO_WATCH_NEW_REPOS`: **true**: Enable this to let all organisation users watch new repos when they are created
|
||||||
@@ -726,8 +724,8 @@ Define allowed algorithms and their minimum key length (use -1 to disable a type
|
|||||||
- Wildcard hosts: `*.mydomain.com`, `192.168.100.*`
|
- Wildcard hosts: `*.mydomain.com`, `192.168.100.*`
|
||||||
- `SKIP_TLS_VERIFY`: **false**: Allow insecure certification.
|
- `SKIP_TLS_VERIFY`: **false**: Allow insecure certification.
|
||||||
- `PAGING_NUM`: **10**: Number of webhook history events that are shown in one page.
|
- `PAGING_NUM`: **10**: Number of webhook history events that are shown in one page.
|
||||||
- `PROXY_URL`: **\<empty\>**: Proxy server URL, support http://, https//, socks://, blank will follow environment http_proxy/https_proxy. If not given, will use global proxy setting.
|
- `PROXY_URL`: **_empty_**: Proxy server URL, support http://, https//, socks://, blank will follow environment http_proxy/https_proxy. If not given, will use global proxy setting.
|
||||||
- `PROXY_HOSTS`: **\<empty\>`**: Comma separated list of host names requiring proxy. Glob patterns (*) are accepted; use ** to match all hosts. If not given, will use global proxy setting.
|
- `PROXY_HOSTS`: **_empty_`**: Comma separated list of host names requiring proxy. Glob patterns (*) are accepted; use ** to match all hosts. If not given, will use global proxy setting.
|
||||||
|
|
||||||
## Mailer (`mailer`)
|
## Mailer (`mailer`)
|
||||||
|
|
||||||
@@ -738,14 +736,14 @@ and
|
|||||||
[Gitea 1.17 configuration document](https://github.com/go-gitea/gitea/blob/release/v1.17/docs/content/doc/advanced/config-cheat-sheet.en-us.md)
|
[Gitea 1.17 configuration document](https://github.com/go-gitea/gitea/blob/release/v1.17/docs/content/doc/advanced/config-cheat-sheet.en-us.md)
|
||||||
|
|
||||||
- `ENABLED`: **false**: Enable to use a mail service.
|
- `ENABLED`: **false**: Enable to use a mail service.
|
||||||
- `PROTOCOL`: **\<empty\>**: Mail server protocol. One of "smtp", "smtps", "smtp+starttls", "smtp+unix", "sendmail", "dummy". _Before 1.18, this was inferred from a combination of `MAILER_TYPE` and `IS_TLS_ENABLED`._
|
- `PROTOCOL`: **_empty_**: Mail server protocol. One of "smtp", "smtps", "smtp+starttls", "smtp+unix", "sendmail", "dummy". _Before 1.18, this was inferred from a combination of `MAILER_TYPE` and `IS_TLS_ENABLED`._
|
||||||
- SMTP family, if your provider does not explicitly say which protocol it uses but does provide a port, you can set SMTP_PORT instead and this will be inferred.
|
- SMTP family, if your provider does not explicitly say which protocol it uses but does provide a port, you can set SMTP_PORT instead and this will be inferred.
|
||||||
- **sendmail** Use the operating system's `sendmail` command instead of SMTP. This is common on Linux systems.
|
- **sendmail** Use the operating system's `sendmail` command instead of SMTP. This is common on Linux systems.
|
||||||
- **dummy** Send email messages to the log as a testing phase.
|
- **dummy** Send email messages to the log as a testing phase.
|
||||||
- Note that enabling sendmail will ignore all other `mailer` settings except `ENABLED`, `FROM`, `SUBJECT_PREFIX` and `SENDMAIL_PATH`.
|
- Note that enabling sendmail will ignore all other `mailer` settings except `ENABLED`, `FROM`, `SUBJECT_PREFIX` and `SENDMAIL_PATH`.
|
||||||
- Enabling dummy will ignore all settings except `ENABLED`, `SUBJECT_PREFIX` and `FROM`.
|
- Enabling dummy will ignore all settings except `ENABLED`, `SUBJECT_PREFIX` and `FROM`.
|
||||||
- `SMTP_ADDR`: **\<empty\>**: Mail server address. e.g. smtp.gmail.com. For smtp+unix, this should be a path to a unix socket instead. _Before 1.18, this was combined with `SMTP_PORT` under the name `HOST`._
|
- `SMTP_ADDR`: **_empty_**: Mail server address. e.g. smtp.gmail.com. For smtp+unix, this should be a path to a unix socket instead. _Before 1.18, this was combined with `SMTP_PORT` under the name `HOST`._
|
||||||
- `SMTP_PORT`: **\<empty\>**: Mail server port. If no protocol is specified, it will be inferred by this setting. Common ports are listed below. _Before 1.18, this was combined with `SMTP_ADDR` under the name `HOST`._
|
- `SMTP_PORT`: **_empty_**: Mail server port. If no protocol is specified, it will be inferred by this setting. Common ports are listed below. _Before 1.18, this was combined with `SMTP_ADDR` under the name `HOST`._
|
||||||
- 25: insecure SMTP
|
- 25: insecure SMTP
|
||||||
- 465: SMTP Secure
|
- 465: SMTP Secure
|
||||||
- 587: StartTLS
|
- 587: StartTLS
|
||||||
@@ -753,16 +751,16 @@ and
|
|||||||
- `CLIENT_CERT_FILE`: **custom/mailer/cert.pem**: Client certificate file.
|
- `CLIENT_CERT_FILE`: **custom/mailer/cert.pem**: Client certificate file.
|
||||||
- `CLIENT_KEY_FILE`: **custom/mailer/key.pem**: Client key file.
|
- `CLIENT_KEY_FILE`: **custom/mailer/key.pem**: Client key file.
|
||||||
- `FORCE_TRUST_SERVER_CERT`: **false**: If set to `true`, completely ignores server certificate validation errors. This option is unsafe. Consider adding the certificate to the system trust store instead.
|
- `FORCE_TRUST_SERVER_CERT`: **false**: If set to `true`, completely ignores server certificate validation errors. This option is unsafe. Consider adding the certificate to the system trust store instead.
|
||||||
- `USER`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address).
|
- `USER`: **_empty_**: Username of mailing user (usually the sender's e-mail address).
|
||||||
- `PASSWD`: **\<empty\>**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password.
|
- `PASSWD`: **_empty_**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password.
|
||||||
- Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup]({{< relref "doc/administration/email-setup.en-us.md" >}}) for more information.
|
- Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup](administration/email-setup.md) for more information.
|
||||||
- `ENABLE_HELO`: **true**: Enable HELO operation.
|
- `ENABLE_HELO`: **true**: Enable HELO operation.
|
||||||
- `HELO_HOSTNAME`: **(retrieved from system)**: HELO hostname.
|
- `HELO_HOSTNAME`: **(retrieved from system)**: HELO hostname.
|
||||||
- `FROM`: **\<empty\>**: Mail from address, RFC 5322. This can be just an email address, or the "Name" \<email@example.com\> format.
|
- `FROM`: **_empty_**: Mail from address, RFC 5322. This can be just an email address, or the "Name" \<email@example.com\> format.
|
||||||
- `ENVELOPE_FROM`: **\<empty\>**: Address set as the From address on the SMTP mail envelope. Set to `<>` to send an empty address.
|
- `ENVELOPE_FROM`: **_empty_**: Address set as the From address on the SMTP mail envelope. Set to `<>` to send an empty address.
|
||||||
- `SUBJECT_PREFIX`: **\<empty\>**: Prefix to be placed before e-mail subject lines.
|
- `SUBJECT_PREFIX`: **_empty_**: Prefix to be placed before e-mail subject lines.
|
||||||
- `SENDMAIL_PATH`: **sendmail**: The location of sendmail on the operating system (can be command or full path).
|
- `SENDMAIL_PATH`: **sendmail**: The location of sendmail on the operating system (can be command or full path).
|
||||||
- `SENDMAIL_ARGS`: **\<empty\>**: Specify any extra sendmail arguments. (NOTE: you should be aware that email addresses can look like options - if your `sendmail` command takes options you must set the option terminator `--`)
|
- `SENDMAIL_ARGS`: **_empty_**: Specify any extra sendmail arguments. (NOTE: you should be aware that email addresses can look like options - if your `sendmail` command takes options you must set the option terminator `--`)
|
||||||
- `SENDMAIL_TIMEOUT`: **5m**: default timeout for sending email through sendmail
|
- `SENDMAIL_TIMEOUT`: **5m**: default timeout for sending email through sendmail
|
||||||
- `SENDMAIL_CONVERT_CRLF`: **true**: Most versions of sendmail prefer LF line endings rather than CRLF line endings. Set this to false if your version of sendmail requires CRLF line endings.
|
- `SENDMAIL_CONVERT_CRLF`: **true**: Most versions of sendmail prefer LF line endings rather than CRLF line endings. Set this to false if your version of sendmail requires CRLF line endings.
|
||||||
- `SEND_BUFFER_LEN`: **100**: Buffer length of mailing queue. **DEPRECATED** use `LENGTH` in `[queue.mailer]`
|
- `SEND_BUFFER_LEN`: **100**: Buffer length of mailing queue. **DEPRECATED** use `LENGTH` in `[queue.mailer]`
|
||||||
@@ -771,11 +769,11 @@ and
|
|||||||
## Incoming Email (`email.incoming`)
|
## Incoming Email (`email.incoming`)
|
||||||
|
|
||||||
- `ENABLED`: **false**: Enable handling of incoming emails.
|
- `ENABLED`: **false**: Enable handling of incoming emails.
|
||||||
- `REPLY_TO_ADDRESS`: **\<empty\>**: The email address including the `%{token}` placeholder that will be replaced per user/action. Example: `incoming+%{token}@example.com`. The placeholder must appear in the user part of the address (before the `@`).
|
- `REPLY_TO_ADDRESS`: **_empty_**: The email address including the `%{token}` placeholder that will be replaced per user/action. Example: `incoming+%{token}@example.com`. The placeholder must appear in the user part of the address (before the `@`).
|
||||||
- `HOST`: **\<empty\>**: IMAP server host.
|
- `HOST`: **_empty_**: IMAP server host.
|
||||||
- `PORT`: **\<empty\>**: IMAP server port.
|
- `PORT`: **_empty_**: IMAP server port.
|
||||||
- `USERNAME`: **\<empty\>**: Username of the receiving account.
|
- `USERNAME`: **_empty_**: Username of the receiving account.
|
||||||
- `PASSWORD`: **\<empty\>**: Password of the receiving account.
|
- `PASSWORD`: **_empty_**: Password of the receiving account.
|
||||||
- `USE_TLS`: **false**: Whether the IMAP server uses TLS.
|
- `USE_TLS`: **false**: Whether the IMAP server uses TLS.
|
||||||
- `SKIP_TLS_VERIFY`: **false**: If set to `true`, completely ignores server certificate validation errors. This option is unsafe.
|
- `SKIP_TLS_VERIFY`: **false**: If set to `true`, completely ignores server certificate validation errors. This option is unsafe.
|
||||||
- `MAILBOX`: **INBOX**: The mailbox name where incoming mail will end up.
|
- `MAILBOX`: **INBOX**: The mailbox name where incoming mail will end up.
|
||||||
@@ -787,7 +785,7 @@ and
|
|||||||
- `ENABLED`: **true**: Enable the cache.
|
- `ENABLED`: **true**: Enable the cache.
|
||||||
- `ADAPTER`: **memory**: Cache engine adapter, either `memory`, `redis`, `twoqueue` or `memcache`. (`twoqueue` represents a size limited LRU cache.)
|
- `ADAPTER`: **memory**: Cache engine adapter, either `memory`, `redis`, `twoqueue` or `memcache`. (`twoqueue` represents a size limited LRU cache.)
|
||||||
- `INTERVAL`: **60**: Garbage Collection interval (sec), for memory and twoqueue cache only.
|
- `INTERVAL`: **60**: Garbage Collection interval (sec), for memory and twoqueue cache only.
|
||||||
- `HOST`: **\<empty\>**: Connection string for `redis` and `memcache`. For `twoqueue` sets configuration for the queue.
|
- `HOST`: **_empty_**: Connection string for `redis` and `memcache`. For `twoqueue` sets configuration for the queue.
|
||||||
- Redis: `redis://:[email protected]:6379/0?pool_size=100&idle_timeout=180s`
|
- Redis: `redis://:[email protected]:6379/0?pool_size=100&idle_timeout=180s`
|
||||||
- Memcache: `127.0.0.1:9090;127.0.0.1:9091`
|
- Memcache: `127.0.0.1:9090;127.0.0.1:9091`
|
||||||
- TwoQueue LRU cache: `{"size":50000,"recent_ratio":0.25,"ghost_ratio":0.5}` or `50000` representing the maximum number of objects stored in the cache.
|
- TwoQueue LRU cache: `{"size":50000,"recent_ratio":0.25,"ghost_ratio":0.5}` or `50000` representing the maximum number of objects stored in the cache.
|
||||||
@@ -807,7 +805,7 @@ and
|
|||||||
- `COOKIE_NAME`: **i\_like\_gitea**: The name of the cookie used for the session ID.
|
- `COOKIE_NAME`: **i\_like\_gitea**: The name of the cookie used for the session ID.
|
||||||
- `GC_INTERVAL_TIME`: **86400**: GC interval in seconds.
|
- `GC_INTERVAL_TIME`: **86400**: GC interval in seconds.
|
||||||
- `SESSION_LIFE_TIME`: **86400**: Session life time in seconds, default is 86400 (1 day)
|
- `SESSION_LIFE_TIME`: **86400**: Session life time in seconds, default is 86400 (1 day)
|
||||||
- `DOMAIN`: **\<empty\>**: Sets the cookie Domain
|
- `DOMAIN`: **_empty_**: Sets the cookie Domain
|
||||||
- `SAME_SITE`: **lax** \[strict, lax, none\]: Set the SameSite setting for the cookie.
|
- `SAME_SITE`: **lax** \[strict, lax, none\]: Set the SameSite setting for the cookie.
|
||||||
|
|
||||||
## Picture (`picture`)
|
## Picture (`picture`)
|
||||||
@@ -861,7 +859,7 @@ Default templates for project boards:
|
|||||||
|
|
||||||
## Log (`log`)
|
## Log (`log`)
|
||||||
|
|
||||||
- `ROOT_PATH`: **\<empty\>**: Root path for log files.
|
- `ROOT_PATH`: **_empty_**: Root path for log files.
|
||||||
- `MODE`: **console**: Logging mode. For multiple modes, use a comma to separate values. You can configure each mode in per mode log subsections `\[log.modename\]`. By default the file mode will log to `$ROOT_PATH/gitea.log`.
|
- `MODE`: **console**: Logging mode. For multiple modes, use a comma to separate values. You can configure each mode in per mode log subsections `\[log.modename\]`. By default the file mode will log to `$ROOT_PATH/gitea.log`.
|
||||||
- `LEVEL`: **Info**: General log level. \[Trace, Debug, Info, Warn, Error, Critical, Fatal, None\]
|
- `LEVEL`: **Info**: General log level. \[Trace, Debug, Info, Warn, Error, Critical, Fatal, None\]
|
||||||
- `STACKTRACE_LEVEL`: **None**: Default log level at which to log create stack traces. \[Trace, Debug, Info, Warn, Error, Critical, Fatal, None\]
|
- `STACKTRACE_LEVEL`: **None**: Default log level at which to log create stack traces. \[Trace, Debug, Info, Warn, Error, Critical, Fatal, None\]
|
||||||
@@ -956,7 +954,7 @@ Default templates for project boards:
|
|||||||
|
|
||||||
- `SCHEDULE`: **@midnight**: Cron syntax for scheduling repository health check.
|
- `SCHEDULE`: **@midnight**: Cron syntax for scheduling repository health check.
|
||||||
- `TIMEOUT`: **60s**: Time duration syntax for health check execution timeout.
|
- `TIMEOUT`: **60s**: Time duration syntax for health check execution timeout.
|
||||||
- `ARGS`: **\<empty\>**: Arguments for command `git fsck`, e.g. `--unreachable --tags`. See more on http://git-scm.com/docs/git-fsck
|
- `ARGS`: **_empty_**: Arguments for command `git fsck`, e.g. `--unreachable --tags`. See more on http://git-scm.com/docs/git-fsck
|
||||||
|
|
||||||
#### Cron - Repository Statistics Check (`cron.check_repo_stats`)
|
#### Cron - Repository Statistics Check (`cron.check_repo_stats`)
|
||||||
|
|
||||||
@@ -998,7 +996,7 @@ Default templates for project boards:
|
|||||||
- `SCHEDULE`: **@every 72h**: Cron syntax for scheduling repository archive cleanup, e.g. `@every 1h`.
|
- `SCHEDULE`: **@every 72h**: Cron syntax for scheduling repository archive cleanup, e.g. `@every 1h`.
|
||||||
- `TIMEOUT`: **60s**: Time duration syntax for garbage collection execution timeout.
|
- `TIMEOUT`: **60s**: Time duration syntax for garbage collection execution timeout.
|
||||||
- `NOTICE_ON_SUCCESS`: **false**: Set to true to switch on success notices.
|
- `NOTICE_ON_SUCCESS`: **false**: Set to true to switch on success notices.
|
||||||
- `ARGS`: **\<empty\>**: Arguments for command `git gc`, e.g. `--aggressive --auto`. The default value is same with [git] -> GC_ARGS
|
- `ARGS`: **_empty_**: Arguments for command `git gc`, e.g. `--aggressive --auto`. The default value is same with [git] -> GC_ARGS
|
||||||
|
|
||||||
#### Cron - Update the '.ssh/authorized_keys' file with Gitea SSH keys (`cron.resync_all_sshkeys`)
|
#### Cron - Update the '.ssh/authorized_keys' file with Gitea SSH keys (`cron.resync_all_sshkeys`)
|
||||||
|
|
||||||
@@ -1080,7 +1078,7 @@ Default templates for project boards:
|
|||||||
- `MAX_GIT_DIFF_FILES`: **100**: Max number of files shown in diff view.
|
- `MAX_GIT_DIFF_FILES`: **100**: Max number of files shown in diff view.
|
||||||
- `COMMITS_RANGE_SIZE`: **50**: Set the default commits range size
|
- `COMMITS_RANGE_SIZE`: **50**: Set the default commits range size
|
||||||
- `BRANCHES_RANGE_SIZE`: **20**: Set the default branches range size
|
- `BRANCHES_RANGE_SIZE`: **20**: Set the default branches range size
|
||||||
- `GC_ARGS`: **\<empty\>**: Arguments for command `git gc`, e.g. `--aggressive --auto`. See more on http://git-scm.com/docs/git-gc/
|
- `GC_ARGS`: **_empty_**: Arguments for command `git gc`, e.g. `--aggressive --auto`. See more on http://git-scm.com/docs/git-gc/
|
||||||
- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: If use Git wire protocol version 2 when Git version >= 2.18, default is true, set to false when you always want Git wire protocol version 1.
|
- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: If use Git wire protocol version 2 when Git version >= 2.18, default is true, set to false when you always want Git wire protocol version 1.
|
||||||
To enable this for Git over SSH when using a OpenSSH server, add `AcceptEnv GIT_PROTOCOL` to your sshd_config file.
|
To enable this for Git over SSH when using a OpenSSH server, add `AcceptEnv GIT_PROTOCOL` to your sshd_config file.
|
||||||
- `PULL_REQUEST_PUSH_MESSAGE`: **true**: Respond to pushes to a non-default branch with a URL for creating a Pull Request (if the repository has them enabled)
|
- `PULL_REQUEST_PUSH_MESSAGE`: **true**: Respond to pushes to a non-default branch with a URL for creating a Pull Request (if the repository has them enabled)
|
||||||
@@ -1109,7 +1107,7 @@ Default templates for project boards:
|
|||||||
- `ENABLED`: **false**: Enables /metrics endpoint for prometheus.
|
- `ENABLED`: **false**: Enables /metrics endpoint for prometheus.
|
||||||
- `ENABLED_ISSUE_BY_LABEL`: **false**: Enable issue by label metrics with format `gitea_issues_by_label{label="bug"} 2`.
|
- `ENABLED_ISSUE_BY_LABEL`: **false**: Enable issue by label metrics with format `gitea_issues_by_label{label="bug"} 2`.
|
||||||
- `ENABLED_ISSUE_BY_REPOSITORY`: **false**: Enable issue by repository metrics with format `gitea_issues_by_repository{repository="org/repo"} 5`.
|
- `ENABLED_ISSUE_BY_REPOSITORY`: **false**: Enable issue by repository metrics with format `gitea_issues_by_repository{repository="org/repo"} 5`.
|
||||||
- `TOKEN`: **\<empty\>**: You need to specify the token, if you want to include in the authorization the metrics . The same token need to be used in prometheus parameters `bearer_token` or `bearer_token_file`.
|
- `TOKEN`: **_empty_**: You need to specify the token, if you want to include in the authorization the metrics . The same token need to be used in prometheus parameters `bearer_token` or `bearer_token_file`.
|
||||||
|
|
||||||
## API (`api`)
|
## API (`api`)
|
||||||
|
|
||||||
@@ -1126,7 +1124,7 @@ Default templates for project boards:
|
|||||||
- `REFRESH_TOKEN_EXPIRATION_TIME`: **730**: Lifetime of an OAuth2 refresh token in hours
|
- `REFRESH_TOKEN_EXPIRATION_TIME`: **730**: Lifetime of an OAuth2 refresh token in hours
|
||||||
- `INVALIDATE_REFRESH_TOKENS`: **false**: Check if refresh token has already been used
|
- `INVALIDATE_REFRESH_TOKENS`: **false**: Check if refresh token has already been used
|
||||||
- `JWT_SIGNING_ALGORITHM`: **RS256**: Algorithm used to sign OAuth2 tokens. Valid values: \[`HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`\]
|
- `JWT_SIGNING_ALGORITHM`: **RS256**: Algorithm used to sign OAuth2 tokens. Valid values: \[`HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`\]
|
||||||
- `JWT_SECRET`: **\<empty\>**: OAuth2 authentication secret for access and refresh tokens, change this to a unique string. This setting is only needed if `JWT_SIGNING_ALGORITHM` is set to `HS256`, `HS384` or `HS512`.
|
- `JWT_SECRET`: **_empty_**: OAuth2 authentication secret for access and refresh tokens, change this to a unique string. This setting is only needed if `JWT_SIGNING_ALGORITHM` is set to `HS256`, `HS384` or `HS512`.
|
||||||
- `JWT_SIGNING_PRIVATE_KEY_FILE`: **jwt/private.pem**: Private key file path used to sign OAuth2 tokens. The path is relative to `APP_DATA_PATH`. This setting is only needed if `JWT_SIGNING_ALGORITHM` is set to `RS256`, `RS384`, `RS512`, `ES256`, `ES384` or `ES512`. The file must contain a RSA or ECDSA private key in the PKCS8 format. If no key exists a 4096 bit key will be created for you.
|
- `JWT_SIGNING_PRIVATE_KEY_FILE`: **jwt/private.pem**: Private key file path used to sign OAuth2 tokens. The path is relative to `APP_DATA_PATH`. This setting is only needed if `JWT_SIGNING_ALGORITHM` is set to `RS256`, `RS384`, `RS512`, `ES256`, `ES384` or `ES512`. The file must contain a RSA or ECDSA private key in the PKCS8 format. If no key exists a 4096 bit key will be created for you.
|
||||||
- `MAX_TOKEN_LENGTH`: **32767**: Maximum length of token/cookie to accept from OAuth2 provider
|
- `MAX_TOKEN_LENGTH`: **32767**: Maximum length of token/cookie to accept from OAuth2 provider
|
||||||
|
|
||||||
@@ -1153,7 +1151,7 @@ IS_INPUT_FILE = false
|
|||||||
|
|
||||||
- ENABLED: **false** Enable markup support; set to **true** to enable this renderer.
|
- ENABLED: **false** Enable markup support; set to **true** to enable this renderer.
|
||||||
- NEED\_POSTPROCESS: **true** set to **true** to replace links / sha1 and etc.
|
- NEED\_POSTPROCESS: **true** set to **true** to replace links / sha1 and etc.
|
||||||
- FILE\_EXTENSIONS: **\<empty\>** List of file extensions that should be rendered by an external
|
- FILE\_EXTENSIONS: **_empty_** List of file extensions that should be rendered by an external
|
||||||
command. Multiple extensions needs a comma as splitter.
|
command. Multiple extensions needs a comma as splitter.
|
||||||
- RENDER\_COMMAND: External command to render all matching extensions.
|
- RENDER\_COMMAND: External command to render all matching extensions.
|
||||||
- IS\_INPUT\_FILE: **false** Input is not a standard input but a file param followed `RENDER_COMMAND`.
|
- IS\_INPUT\_FILE: **false** Input is not a standard input but a file param followed `RENDER_COMMAND`.
|
||||||
@@ -1213,8 +1211,8 @@ Task queue configuration has been moved to `queue.task`. However, the below conf
|
|||||||
|
|
||||||
- `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations.
|
- `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations.
|
||||||
- `RETRY_BACKOFF`: **3**: Backoff time per http/https request retry (seconds)
|
- `RETRY_BACKOFF`: **3**: Backoff time per http/https request retry (seconds)
|
||||||
- `ALLOWED_DOMAINS`: **\<empty\>**: Domains allowlist for migrating repositories, default is blank. It means everything will be allowed. Multiple domains could be separated by commas. Wildcard is supported: `github.com, *.github.com`.
|
- `ALLOWED_DOMAINS`: **_empty_**: Domains allowlist for migrating repositories, default is blank. It means everything will be allowed. Multiple domains could be separated by commas. Wildcard is supported: `github.com, *.github.com`.
|
||||||
- `BLOCKED_DOMAINS`: **\<empty\>**: Domains blocklist for migrating repositories, default is blank. Multiple domains could be separated by commas. When `ALLOWED_DOMAINS` is not blank, this option has a higher priority to deny domains. Wildcard is supported.
|
- `BLOCKED_DOMAINS`: **_empty_**: Domains blocklist for migrating repositories, default is blank. Multiple domains could be separated by commas. When `ALLOWED_DOMAINS` is not blank, this option has a higher priority to deny domains. Wildcard is supported.
|
||||||
- `ALLOW_LOCALNETWORKS`: **false**: Allow private addresses defined by RFC 1918, RFC 1122, RFC 4632 and RFC 4291. If a domain is allowed by `ALLOWED_DOMAINS`, this option will be ignored.
|
- `ALLOW_LOCALNETWORKS`: **false**: Allow private addresses defined by RFC 1918, RFC 1122, RFC 4632 and RFC 4291. If a domain is allowed by `ALLOWED_DOMAINS`, this option will be ignored.
|
||||||
- `SKIP_TLS_VERIFY`: **false**: Allow skip tls verify
|
- `SKIP_TLS_VERIFY`: **false**: Allow skip tls verify
|
||||||
|
|
||||||
@@ -1336,8 +1334,8 @@ is `data/repo-archive` and the default of `MINIO_BASE_PATH` is `repo-archive/`.
|
|||||||
## Proxy (`proxy`)
|
## Proxy (`proxy`)
|
||||||
|
|
||||||
- `PROXY_ENABLED`: **false**: Enable the proxy if true, all requests to external via HTTP will be affected, if false, no proxy will be used even environment http_proxy/https_proxy
|
- `PROXY_ENABLED`: **false**: Enable the proxy if true, all requests to external via HTTP will be affected, if false, no proxy will be used even environment http_proxy/https_proxy
|
||||||
- `PROXY_URL`: **\<empty\>**: Proxy server URL, support http://, https//, socks://, blank will follow environment http_proxy/https_proxy
|
- `PROXY_URL`: **_empty_**: Proxy server URL, support http://, https//, socks://, blank will follow environment http_proxy/https_proxy
|
||||||
- `PROXY_HOSTS`: **\<empty\>**: Comma separated list of host names requiring proxy. Glob patterns (*) are accepted; use ** to match all hosts.
|
- `PROXY_HOSTS`: **_empty_**: Comma separated list of host names requiring proxy. Glob patterns (*) are accepted; use ** to match all hosts.
|
||||||
|
|
||||||
i.e.
|
i.e.
|
||||||
|
|
||||||
+8
-10
@@ -2,14 +2,14 @@
|
|||||||
date: "2016-12-26T16:00:00+02:00"
|
date: "2016-12-26T16:00:00+02:00"
|
||||||
title: "配置说明"
|
title: "配置说明"
|
||||||
slug: "config-cheat-sheet"
|
slug: "config-cheat-sheet"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "配置说明"
|
name: "配置说明"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
identifier: "config-cheat-sheet"
|
identifier: "config-cheat-sheet"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -24,8 +24,6 @@ menu:
|
|||||||
|
|
||||||
此文档的内容可能过于陈旧或者错误,请参考英文文档。
|
此文档的内容可能过于陈旧或者错误,请参考英文文档。
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Overall (`DEFAULT`)
|
## Overall (`DEFAULT`)
|
||||||
|
|
||||||
- `APP_NAME`: 应用名称,改成你希望的名字。
|
- `APP_NAME`: 应用名称,改成你希望的名字。
|
||||||
@@ -45,7 +43,7 @@ menu:
|
|||||||
|
|
||||||
### Repository - Release (`repository.release`)
|
### Repository - Release (`repository.release`)
|
||||||
|
|
||||||
- `ALLOWED_TYPES`: **\<empty\>**: 允许扩展名的列表,用逗号分隔 (`.zip`), mime 类型 (`text/plain`) 或者匹配符号 (`image/*`, `audio/*`, `video/*`). 空值或者 `*/*` 允许所有类型。
|
- `ALLOWED_TYPES`: **_empty_**: 允许扩展名的列表,用逗号分隔 (`.zip`), mime 类型 (`text/plain`) 或者匹配符号 (`image/*`, `audio/*`, `video/*`). 空值或者 `*/*` 允许所有类型。
|
||||||
- `DEFAULT_PAGING_NUM`: **10**: 默认的发布版本页面分页。
|
- `DEFAULT_PAGING_NUM`: **10**: 默认的发布版本页面分页。
|
||||||
|
|
||||||
## UI (`ui`)
|
## UI (`ui`)
|
||||||
@@ -191,7 +189,7 @@ menu:
|
|||||||
- `ENABLED`: **true**: 是否启用。
|
- `ENABLED`: **true**: 是否启用。
|
||||||
- `ADAPTER`: **memory**: 缓存引擎,可以为 `memory`, `redis` 或 `memcache`。
|
- `ADAPTER`: **memory**: 缓存引擎,可以为 `memory`, `redis` 或 `memcache`。
|
||||||
- `INTERVAL`: **60**: 只对内存缓存有效,GC间隔,单位秒。
|
- `INTERVAL`: **60**: 只对内存缓存有效,GC间隔,单位秒。
|
||||||
- `HOST`: **\<empty\>**: 针对redis和memcache有效,主机地址和端口。
|
- `HOST`: **_empty_**: 针对redis和memcache有效,主机地址和端口。
|
||||||
- Redis: `network=tcp,addr=127.0.0.1:6379,password=macaron,db=0,pool_size=100,idle_timeout=180`
|
- Redis: `network=tcp,addr=127.0.0.1:6379,password=macaron,db=0,pool_size=100,idle_timeout=180`
|
||||||
- Memache: `127.0.0.1:9090;127.0.0.1:9091`
|
- Memache: `127.0.0.1:9090;127.0.0.1:9091`
|
||||||
- `ITEM_TTL`: **16h**: 缓存项目失效时间,设置为 -1 则禁用缓存。
|
- `ITEM_TTL`: **16h**: 缓存项目失效时间,设置为 -1 则禁用缓存。
|
||||||
@@ -381,8 +379,8 @@ ALLOW_DATA_URI_IMAGES = true
|
|||||||
|
|
||||||
- `MAX_ATTEMPTS`: **3**: 在迁移过程中的 http/https 请求重试次数。
|
- `MAX_ATTEMPTS`: **3**: 在迁移过程中的 http/https 请求重试次数。
|
||||||
- `RETRY_BACKOFF`: **3**: 等待下一次重试的时间,单位秒。
|
- `RETRY_BACKOFF`: **3**: 等待下一次重试的时间,单位秒。
|
||||||
- `ALLOWED_DOMAINS`: **\<empty\>**: 迁移仓库的域名白名单,默认为空,表示允许从任意域名迁移仓库,多个域名用逗号分隔。
|
- `ALLOWED_DOMAINS`: **_empty_**: 迁移仓库的域名白名单,默认为空,表示允许从任意域名迁移仓库,多个域名用逗号分隔。
|
||||||
- `BLOCKED_DOMAINS`: **\<empty\>**: 迁移仓库的域名黑名单,默认为空,多个域名用逗号分隔。如果 `ALLOWED_DOMAINS` 不为空,此选项有更高的优先级拒绝这里的域名。
|
- `BLOCKED_DOMAINS`: **_empty_**: 迁移仓库的域名黑名单,默认为空,多个域名用逗号分隔。如果 `ALLOWED_DOMAINS` 不为空,此选项有更高的优先级拒绝这里的域名。
|
||||||
- `ALLOW_LOCALNETWORKS`: **false**: Allow private addresses defined by RFC 1918
|
- `ALLOW_LOCALNETWORKS`: **false**: Allow private addresses defined by RFC 1918
|
||||||
- `SKIP_TLS_VERIFY`: **false**: 允许忽略 TLS 认证
|
- `SKIP_TLS_VERIFY`: **false**: 允许忽略 TLS 认证
|
||||||
|
|
||||||
@@ -455,8 +453,8 @@ Repository archive 的存储配置。 如果 `STORAGE_TYPE` 为空,则此配
|
|||||||
## Proxy (`proxy`)
|
## Proxy (`proxy`)
|
||||||
|
|
||||||
- `PROXY_ENABLED`: **false**: 是否启用全局代理。如果为否,则不使用代理,环境变量中的代理也不使用
|
- `PROXY_ENABLED`: **false**: 是否启用全局代理。如果为否,则不使用代理,环境变量中的代理也不使用
|
||||||
- `PROXY_URL`: **\<empty\>**: 代理服务器地址,支持 http://, https//, socks://,为空则不启用代理而使用环境变量中的 http_proxy/https_proxy
|
- `PROXY_URL`: **_empty_**: 代理服务器地址,支持 http://, https//, socks://,为空则不启用代理而使用环境变量中的 http_proxy/https_proxy
|
||||||
- `PROXY_HOSTS`: **\<empty\>**: 逗号分隔的多个需要代理的网址,支持 * 号匹配符号, ** 表示匹配所有网站
|
- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址,支持 * 号匹配符号, ** 表示匹配所有网站
|
||||||
|
|
||||||
i.e.
|
i.e.
|
||||||
|
|
||||||
+4
-8
@@ -2,7 +2,7 @@
|
|||||||
date: "2017-04-15T14:56:00+02:00"
|
date: "2017-04-15T14:56:00+02:00"
|
||||||
title: "Customizing Gitea"
|
title: "Customizing Gitea"
|
||||||
slug: "customizing-gitea"
|
slug: "customizing-gitea"
|
||||||
weight: 100
|
sidebar_position: 100
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
@@ -10,7 +10,7 @@ menu:
|
|||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Customizing Gitea"
|
name: "Customizing Gitea"
|
||||||
identifier: "customizing-gitea"
|
identifier: "customizing-gitea"
|
||||||
weight: 100
|
sidebar_position: 100
|
||||||
---
|
---
|
||||||
|
|
||||||
# Customizing Gitea
|
# Customizing Gitea
|
||||||
@@ -46,10 +46,6 @@ is set under the "Configuration" tab on the site administration page.
|
|||||||
|
|
||||||
**Note:** Gitea must perform a full restart to see configuration changes.
|
**Note:** Gitea must perform a full restart to see configuration changes.
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Serving custom public files
|
## Serving custom public files
|
||||||
|
|
||||||
To make Gitea serve custom public files (like pages and images), use the folder
|
To make Gitea serve custom public files (like pages and images), use the folder
|
||||||
@@ -84,7 +80,7 @@ directory at the top of this document).
|
|||||||
Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/),
|
Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/),
|
||||||
which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory.
|
which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory.
|
||||||
|
|
||||||
To obtain any embedded file (including templates), the [`gitea embedded` tool]({{< relref "doc/administration/cmd-embedded.en-us.md" >}}) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using).
|
To obtain any embedded file (including templates), the [`gitea embedded` tool](administration/cmd-embedded.md) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using).
|
||||||
|
|
||||||
Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
|
Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
|
||||||
shouldn't be touched without fully understanding these components.
|
shouldn't be touched without fully understanding these components.
|
||||||
@@ -296,7 +292,7 @@ The [legacy file format](https://github.com/go-gitea/gitea/blob/main/options/lab
|
|||||||
|
|
||||||
`#hex-color label name ; label description`
|
`#hex-color label name ; label description`
|
||||||
|
|
||||||
For more information, see the [labels documentation]({{< relref "doc/usage/labels.en-us.md" >}}).
|
For more information, see the [labels documentation](usage/labels.md).
|
||||||
|
|
||||||
### Licenses
|
### Licenses
|
||||||
|
|
||||||
+2
-2
@@ -2,14 +2,14 @@
|
|||||||
date: "2017-04-15T14:56:00+02:00"
|
date: "2017-04-15T14:56:00+02:00"
|
||||||
title: "自定义 Gitea 配置"
|
title: "自定义 Gitea 配置"
|
||||||
slug: "customizing-gitea"
|
slug: "customizing-gitea"
|
||||||
weight: 100
|
sidebar_position: 100
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "自定义 Gitea 配置"
|
name: "自定义 Gitea 配置"
|
||||||
weight: 100
|
sidebar_position: 100
|
||||||
identifier: "customizing-gitea"
|
identifier: "customizing-gitea"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -2,23 +2,19 @@
|
|||||||
date: "2019-10-15T10:10:00+05:00"
|
date: "2019-10-15T10:10:00+05:00"
|
||||||
title: "Email setup"
|
title: "Email setup"
|
||||||
slug: "email-setup"
|
slug: "email-setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Email setup"
|
name: "Email setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
identifier: "email-setup"
|
identifier: "email-setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Email setup
|
# Email setup
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea has mailer functionality for sending transactional emails (such as registration confirmation). It can be configured to either use Sendmail (or compatible MTAs like Postfix and msmtp) or directly use SMTP server.
|
Gitea has mailer functionality for sending transactional emails (such as registration confirmation). It can be configured to either use Sendmail (or compatible MTAs like Postfix and msmtp) or directly use SMTP server.
|
||||||
|
|
||||||
## Using Sendmail
|
## Using Sendmail
|
||||||
@@ -58,7 +54,7 @@ Restart Gitea for the configuration changes to take effect.
|
|||||||
|
|
||||||
To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > SMTP Mailer Configuration.
|
To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > SMTP Mailer Configuration.
|
||||||
|
|
||||||
For the full list of options check the [Config Cheat Sheet]({{< relref "doc/administration/config-cheat-sheet.en-us.md" >}})
|
For the full list of options check the [Config Cheat Sheet](administration/config-cheat-sheet.md)
|
||||||
|
|
||||||
Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through:
|
Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through:
|
||||||
|
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "Email 设置"
|
title: "Email 设置"
|
||||||
slug: "email-setup"
|
slug: "email-setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Email 设置"
|
name: "Email 设置"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
identifier: "email-setup"
|
identifier: "email-setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Email 设置
|
# Email 设置
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea 具有邮件功能,用于发送事务性邮件(例如注册确认邮件)。它可以配置为使用 Sendmail(或兼容的 MTA,例如 Postfix 和 msmtp)或直接使用 SMTP 服务器。
|
Gitea 具有邮件功能,用于发送事务性邮件(例如注册确认邮件)。它可以配置为使用 Sendmail(或兼容的 MTA,例如 Postfix 和 msmtp)或直接使用 SMTP 服务器。
|
||||||
|
|
||||||
## 使用 Sendmail
|
## 使用 Sendmail
|
||||||
+2
-6
@@ -2,23 +2,19 @@
|
|||||||
date: "2017-04-08T11:34:00+02:00"
|
date: "2017-04-08T11:34:00+02:00"
|
||||||
title: "Environment variables"
|
title: "Environment variables"
|
||||||
slug: "environment-variables"
|
slug: "environment-variables"
|
||||||
weight: 10
|
sidebar_position: 10
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Environment variables"
|
name: "Environment variables"
|
||||||
weight: 10
|
sidebar_position: 10
|
||||||
identifier: "environment-variables"
|
identifier: "environment-variables"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
This is an inventory of Gitea environment variables. They change Gitea behaviour.
|
This is an inventory of Gitea environment variables. They change Gitea behaviour.
|
||||||
|
|
||||||
Initialize them before Gitea command to be effective, for example:
|
Initialize them before Gitea command to be effective, for example:
|
||||||
+2
-2
@@ -2,14 +2,14 @@
|
|||||||
date: "2017-04-08T11:34:00+02:00"
|
date: "2017-04-08T11:34:00+02:00"
|
||||||
title: "环境变量清单"
|
title: "环境变量清单"
|
||||||
slug: "environment-variables"
|
slug: "environment-variables"
|
||||||
weight: 10
|
sidebar_position: 10
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "环境变量清单"
|
name: "环境变量清单"
|
||||||
weight: 10
|
sidebar_position: 10
|
||||||
identifier: "environment-variables"
|
identifier: "environment-variables"
|
||||||
---
|
---
|
||||||
|
|
||||||
+3
-7
@@ -2,23 +2,19 @@
|
|||||||
date: "2018-11-23:00:00+02:00"
|
date: "2018-11-23:00:00+02:00"
|
||||||
title: "External renderers"
|
title: "External renderers"
|
||||||
slug: "external-renderers"
|
slug: "external-renderers"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "External renderers"
|
name: "External renderers"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
identifier: "external-renderers"
|
identifier: "external-renderers"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Custom files rendering configuration
|
# Custom files rendering configuration
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries,
|
Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries,
|
||||||
it is just a matter of:
|
it is just a matter of:
|
||||||
|
|
||||||
@@ -34,7 +30,7 @@ In order to get file rendering through external binaries, their associated packa
|
|||||||
If you're using a Docker image, your `Dockerfile` should contain something along this lines:
|
If you're using a Docker image, your `Dockerfile` should contain something along this lines:
|
||||||
|
|
||||||
```docker
|
```docker
|
||||||
FROM gitea/gitea:{{< version >}}
|
FROM gitea/gitea:@version@
|
||||||
[...]
|
[...]
|
||||||
|
|
||||||
COPY custom/app.ini /data/gitea/conf/app.ini
|
COPY custom/app.ini /data/gitea/conf/app.ini
|
||||||
+4
-8
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "外部渲染器"
|
title: "外部渲染器"
|
||||||
slug: "external-renderers"
|
slug: "external-renderers"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,23 +11,19 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "外部渲染器"
|
name: "外部渲染器"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
identifier: "external-renderers"
|
identifier: "external-renderers"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 自定义文件渲染配置
|
# 自定义文件渲染配置
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea 通过外部二进制文件支持自定义文件渲染(例如 Jupyter notebooks、asciidoc 等),只需要进行以下步骤:
|
Gitea 通过外部二进制文件支持自定义文件渲染(例如 Jupyter notebooks、asciidoc 等),只需要进行以下步骤:
|
||||||
|
|
||||||
- 安装外部二进制文件
|
- 安装外部二进制文件
|
||||||
- 在您的 `app.ini` 文件中添加一些配置
|
- 在您的 `app.ini` 文件中添加一些配置
|
||||||
- 重新启动 Gitea 实例
|
- 重新启动 Gitea 实例
|
||||||
|
|
||||||
此功能支持整个文件的渲染。如果您想要在 Markdown 中渲染代码块,您需要使用 JavaScript 进行一些操作。请参阅 [自定义 Gitea 配置]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}}) 页面上的一些示例。
|
此功能支持整个文件的渲染。如果您想要在 Markdown 中渲染代码块,您需要使用 JavaScript 进行一些操作。请参阅 [自定义 Gitea 配置](administration/customizing-gitea.md) 页面上的一些示例。
|
||||||
|
|
||||||
## 安装外部二进制文件
|
## 安装外部二进制文件
|
||||||
|
|
||||||
@@ -35,7 +31,7 @@ Gitea 通过外部二进制文件支持自定义文件渲染(例如 Jupyter no
|
|||||||
如果您正在使用 Docker 镜像,则您的 `Dockerfile` 应该包含以下内容:
|
如果您正在使用 Docker 镜像,则您的 `Dockerfile` 应该包含以下内容:
|
||||||
|
|
||||||
```docker
|
```docker
|
||||||
FROM gitea/gitea:{{< version >}}
|
FROM gitea/gitea:@version@
|
||||||
[...]
|
[...]
|
||||||
|
|
||||||
COPY custom/app.ini /data/gitea/conf/app.ini
|
COPY custom/app.ini /data/gitea/conf/app.ini
|
||||||
@@ -2,14 +2,14 @@
|
|||||||
date: "2018-05-11T11:00:00+02:00"
|
date: "2018-05-11T11:00:00+02:00"
|
||||||
title: "Setup fail2ban"
|
title: "Setup fail2ban"
|
||||||
slug: "fail2ban-setup"
|
slug: "fail2ban-setup"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Fail2ban setup"
|
name: "Fail2ban setup"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
identifier: "fail2ban-setup"
|
identifier: "fail2ban-setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -2,14 +2,14 @@
|
|||||||
date: "2022-08-01T00:00:00+00:00"
|
date: "2022-08-01T00:00:00+00:00"
|
||||||
title: "使用: 设置 Fail2ban"
|
title: "使用: 设置 Fail2ban"
|
||||||
slug: "fail2ban-setup"
|
slug: "fail2ban-setup"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "设置 Fail2ban"
|
name: "设置 Fail2ban"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
identifier: "fail2ban-setup"
|
identifier: "fail2ban-setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
+2
-2
@@ -2,14 +2,14 @@
|
|||||||
date: "2019-10-06T08:00:00+05:00"
|
date: "2019-10-06T08:00:00+05:00"
|
||||||
title: "Git LFS setup"
|
title: "Git LFS setup"
|
||||||
slug: "git-lfs-setup"
|
slug: "git-lfs-setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Git LFS setup"
|
name: "Git LFS setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
identifier: "git-lfs-setup"
|
identifier: "git-lfs-setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
+2
-2
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "Git LFS 设置"
|
title: "Git LFS 设置"
|
||||||
slug: "git-lfs-setup"
|
slug: "git-lfs-setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,7 +11,7 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Git LFS 设置"
|
name: "Git LFS 设置"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
identifier: "git-lfs-setup"
|
identifier: "git-lfs-setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -2,29 +2,25 @@
|
|||||||
date: "2018-06-02T11:00:00+02:00"
|
date: "2018-06-02T11:00:00+02:00"
|
||||||
title: "HTTPS setup"
|
title: "HTTPS setup"
|
||||||
slug: "https-setup"
|
slug: "https-setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "HTTPS setup"
|
name: "HTTPS setup"
|
||||||
weight: 12
|
sidebar_position: 12
|
||||||
identifier: "https-setup"
|
identifier: "https-setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
# HTTPS setup to encrypt connections to Gitea
|
# HTTPS setup to encrypt connections to Gitea
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Using the built-in server
|
## Using the built-in server
|
||||||
|
|
||||||
Before you enable HTTPS, make sure that you have valid SSL/TLS certificates.
|
Before you enable HTTPS, make sure that you have valid SSL/TLS certificates.
|
||||||
You could use self-generated certificates for evaluation and testing. Please run `gitea cert --host [HOST]` to generate a self signed certificate.
|
You could use self-generated certificates for evaluation and testing. Please run `gitea cert --host [HOST]` to generate a self signed certificate.
|
||||||
|
|
||||||
If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide]({{< relref "doc/administration/reverse-proxies.en-us.md" >}}).
|
If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide](administration/reverse-proxies.md).
|
||||||
|
|
||||||
To use Gitea's built-in HTTPS support, you must change your `app.ini` file:
|
To use Gitea's built-in HTTPS support, you must change your `app.ini` file:
|
||||||
|
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "日志配置"
|
title: "日志配置"
|
||||||
slug: "logging-config"
|
slug: "logging-config"
|
||||||
weight: 40
|
sidebar_position: 40
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,7 +11,7 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "日志配置"
|
name: "日志配置"
|
||||||
weight: 40
|
sidebar_position: 40
|
||||||
identifier: "logging-config"
|
identifier: "logging-config"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -25,10 +25,6 @@ Gitea 的日志配置主要由以下三种类型的组件组成:
|
|||||||
|
|
||||||
默认情况下,已经有一个完全功能的日志输出,因此不需要重新定义。
|
默认情况下,已经有一个完全功能的日志输出,因此不需要重新定义。
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## `[log]` 部分
|
## `[log]` 部分
|
||||||
|
|
||||||
在 Gitea 中,日志设施的配置在 `[log]` 部分及其子部分。
|
在 Gitea 中,日志设施的配置在 `[log]` 部分及其子部分。
|
||||||
@@ -43,7 +39,7 @@ Gitea 的日志配置主要由以下三种类型的组件组成:
|
|||||||
它还可以包含以下子日志记录器:
|
它还可以包含以下子日志记录器:
|
||||||
|
|
||||||
- `logger.router.MODE`:(默认值:**,**):用于路由器日志记录器的日志输出列表。
|
- `logger.router.MODE`:(默认值:**,**):用于路由器日志记录器的日志输出列表。
|
||||||
- `logger.access.MODE`:(默认值:**\<empty\>**):用于访问日志记录器的日志输出列表。默认情况下,访问日志记录器被禁用。
|
- `logger.access.MODE`:(默认值:**_empty_**):用于访问日志记录器的日志输出列表。默认情况下,访问日志记录器被禁用。
|
||||||
- `logger.xorm.MODE`:(默认值:**,**):用于 XORM 日志记录器的日志输出列表。
|
- `logger.xorm.MODE`:(默认值:**,**):用于 XORM 日志记录器的日志输出列表。
|
||||||
|
|
||||||
将子日志记录器的模式设置为逗号(`,`)表示使用默认的全局 `MODE`。
|
将子日志记录器的模式设置为逗号(`,`)表示使用默认的全局 `MODE`。
|
||||||
+3
-7
@@ -2,14 +2,14 @@
|
|||||||
date: "2019-04-02T17:06:00+01:00"
|
date: "2019-04-02T17:06:00+01:00"
|
||||||
title: "Logging Configuration"
|
title: "Logging Configuration"
|
||||||
slug: "logging-configuration"
|
slug: "logging-configuration"
|
||||||
weight: 40
|
sidebar_position: 40
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Logging Configuration"
|
name: "Logging Configuration"
|
||||||
weight: 40
|
sidebar_position: 40
|
||||||
identifier: "logging-configuration"
|
identifier: "logging-configuration"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -23,13 +23,9 @@ The logging configuration of Gitea mainly consists of 3 types of components:
|
|||||||
|
|
||||||
As mentioned below, there is a fully functional log output by default, so it is not necessary to define one.
|
As mentioned below, there is a fully functional log output by default, so it is not necessary to define one.
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Collecting Logs for Help
|
## Collecting Logs for Help
|
||||||
|
|
||||||
To collect logs for help and issue report, see [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}}).
|
To collect logs for help and issue report, see [Support Options](help/seek-help.md).
|
||||||
|
|
||||||
## The `[log]` section
|
## The `[log]` section
|
||||||
|
|
||||||
@@ -2,23 +2,19 @@
|
|||||||
date: "2019-10-23T17:00:00-03:00"
|
date: "2019-10-23T17:00:00-03:00"
|
||||||
title: "Mail templates"
|
title: "Mail templates"
|
||||||
slug: "mail-templates"
|
slug: "mail-templates"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Mail templates"
|
name: "Mail templates"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
identifier: "mail-templates"
|
identifier: "mail-templates"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Mail templates
|
# Mail templates
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
To craft the e-mail subject and contents for certain operations, Gitea can be customized by using templates. The templates
|
To craft the e-mail subject and contents for certain operations, Gitea can be customized by using templates. The templates
|
||||||
for these functions are located under the [`custom` directory](https://docs.gitea.io/en-us/customizing-gitea/).
|
for these functions are located under the [`custom` directory](https://docs.gitea.io/en-us/customizing-gitea/).
|
||||||
Gitea has an internal template that serves as default in case there's no custom alternative.
|
Gitea has an internal template that serves as default in case there's no custom alternative.
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "邮件模板"
|
title: "邮件模板"
|
||||||
slug: "mail-templates"
|
slug: "mail-templates"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "邮件模板"
|
name: "邮件模板"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
identifier: "mail-templates"
|
identifier: "mail-templates"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 邮件模板
|
# 邮件模板
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
为了定制特定操作的电子邮件主题和内容,可以使用模板来自定义 Gitea。这些功能的模板位于 [`custom` 目录](https://docs.gitea.io/en-us/customizing-gitea/) 下。
|
为了定制特定操作的电子邮件主题和内容,可以使用模板来自定义 Gitea。这些功能的模板位于 [`custom` 目录](https://docs.gitea.io/en-us/customizing-gitea/) 下。
|
||||||
如果没有自定义的替代方案,Gitea 将使用内部模板作为默认模板。
|
如果没有自定义的替代方案,Gitea 将使用内部模板作为默认模板。
|
||||||
|
|
||||||
@@ -2,23 +2,19 @@
|
|||||||
date: "2019-09-06T01:35:00-03:00"
|
date: "2019-09-06T01:35:00-03:00"
|
||||||
title: "Repository indexer"
|
title: "Repository indexer"
|
||||||
slug: "repo-indexer"
|
slug: "repo-indexer"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Repository indexer"
|
name: "Repository indexer"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
identifier: "repo-indexer"
|
identifier: "repo-indexer"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Repository indexer
|
# Repository indexer
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Setting up the repository indexer
|
## Setting up the repository indexer
|
||||||
|
|
||||||
Gitea can search through the files of the repositories by enabling this function in your [`app.ini`](https://docs.gitea.io/en-us/config-cheat-sheet/):
|
Gitea can search through the files of the repositories by enabling this function in your [`app.ini`](https://docs.gitea.io/en-us/config-cheat-sheet/):
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "仓库索引器"
|
title: "仓库索引器"
|
||||||
slug: "repo-indexer"
|
slug: "repo-indexer"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "仓库索引器"
|
name: "仓库索引器"
|
||||||
weight: 45
|
sidebar_position: 45
|
||||||
identifier: "repo-indexer"
|
identifier: "repo-indexer"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 仓库索引器
|
# 仓库索引器
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## 设置仓库索引器
|
## 设置仓库索引器
|
||||||
|
|
||||||
通过在您的 [`app.ini`](https://docs.gitea.io/en-us/config-cheat-sheet/) 中启用此功能,Gitea 可以通过仓库的文件进行搜索:
|
通过在您的 [`app.ini`](https://docs.gitea.io/en-us/config-cheat-sheet/) 中启用此功能,Gitea 可以通过仓库的文件进行搜索:
|
||||||
+2
-6
@@ -2,23 +2,19 @@
|
|||||||
date: "2018-05-22T11:00:00+00:00"
|
date: "2018-05-22T11:00:00+00:00"
|
||||||
title: "Reverse Proxies"
|
title: "Reverse Proxies"
|
||||||
slug: "reverse-proxies"
|
slug: "reverse-proxies"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Reverse Proxies"
|
name: "Reverse Proxies"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
identifier: "reverse-proxies"
|
identifier: "reverse-proxies"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Reverse Proxies
|
# Reverse Proxies
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Nginx
|
## Nginx
|
||||||
|
|
||||||
If you want Nginx to serve your Gitea instance, add the following `server` section to the `http` section of `nginx.conf`:
|
If you want Nginx to serve your Gitea instance, add the following `server` section to the `http` section of `nginx.conf`:
|
||||||
+2
-6
@@ -2,23 +2,19 @@
|
|||||||
date: "2018-05-22T11:00:00+00:00"
|
date: "2018-05-22T11:00:00+00:00"
|
||||||
title: "反向代理"
|
title: "反向代理"
|
||||||
slug: "reverse-proxies"
|
slug: "reverse-proxies"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "反向代理"
|
name: "反向代理"
|
||||||
weight: 16
|
sidebar_position: 16
|
||||||
identifier: "reverse-proxies"
|
identifier: "reverse-proxies"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 反向代理
|
# 反向代理
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## 使用 Nginx 作为反向代理服务
|
## 使用 Nginx 作为反向代理服务
|
||||||
|
|
||||||
如果您想使用 Nginx 作为 Gitea 的反向代理服务,您可以参照以下 `nginx.conf` 配置中 `server` 的 `http` 部分:
|
如果您想使用 Nginx 作为 Gitea 的反向代理服务,您可以参照以下 `nginx.conf` 配置中 `server` 的 `http` 部分:
|
||||||
+3
-3
@@ -2,14 +2,14 @@
|
|||||||
date: "2019-12-31T13:55:00+05:00"
|
date: "2019-12-31T13:55:00+05:00"
|
||||||
title: "Search Engines Indexation"
|
title: "Search Engines Indexation"
|
||||||
slug: "search-engines-indexation"
|
slug: "search-engines-indexation"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "Search Engines Indexation"
|
name: "Search Engines Indexation"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
identifier: "search-engines-indexation"
|
identifier: "search-engines-indexation"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -21,7 +21,7 @@ If you don't want your repository to be visible for search engines read further.
|
|||||||
## Block search engines indexation using robots.txt
|
## Block search engines indexation using robots.txt
|
||||||
|
|
||||||
To make Gitea serve a custom `robots.txt` (default: empty 404) for top level installations,
|
To make Gitea serve a custom `robots.txt` (default: empty 404) for top level installations,
|
||||||
create a file called `robots.txt` in the [`custom` folder or `CustomPath`]({{< relref "doc/administration/customizing-gitea.en-us.md" >}})
|
create a file called `robots.txt` in the [`custom` folder or `CustomPath`](administration/customizing-gitea.md)
|
||||||
|
|
||||||
Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt).
|
Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt).
|
||||||
|
|
||||||
+3
-3
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "搜索引擎索引"
|
title: "搜索引擎索引"
|
||||||
slug: "search-engines-indexation"
|
slug: "search-engines-indexation"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,7 +11,7 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "搜索引擎索引"
|
name: "搜索引擎索引"
|
||||||
weight: 60
|
sidebar_position: 60
|
||||||
identifier: "search-engines-indexation"
|
identifier: "search-engines-indexation"
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ menu:
|
|||||||
|
|
||||||
## 使用 robots.txt 阻止搜索引擎索引
|
## 使用 robots.txt 阻止搜索引擎索引
|
||||||
|
|
||||||
为了使 Gitea 为顶级安装提供自定义的`robots.txt`(默认为空的 404),请在[`custom`文件夹或`CustomPath`]({{< relref "doc/administration/customizing-gitea.zh-cn.md" >}})中创建一个名为 `robots.txt` 的文件。
|
为了使 Gitea 为顶级安装提供自定义的`robots.txt`(默认为空的 404),请在[`custom`文件夹或`CustomPath`](administration/customizing-gitea.md)中创建一个名为 `robots.txt` 的文件。
|
||||||
|
|
||||||
有关如何配置 `robots.txt` 的示例,请参考 [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt)。
|
有关如何配置 `robots.txt` 的示例,请参考 [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt)。
|
||||||
|
|
||||||
@@ -2,23 +2,19 @@
|
|||||||
date: "2019-08-17T10:20:00+01:00"
|
date: "2019-08-17T10:20:00+01:00"
|
||||||
title: "GPG Commit Signatures"
|
title: "GPG Commit Signatures"
|
||||||
slug: "signing"
|
slug: "signing"
|
||||||
weight: 50
|
sidebar_position: 50
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "GPG Commit Signatures"
|
name: "GPG Commit Signatures"
|
||||||
weight: 50
|
sidebar_position: 50
|
||||||
identifier: "signing"
|
identifier: "signing"
|
||||||
---
|
---
|
||||||
|
|
||||||
# GPG Commit Signatures
|
# GPG Commit Signatures
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea will verify GPG commit signatures in the provided tree by
|
Gitea will verify GPG commit signatures in the provided tree by
|
||||||
checking if the commits are signed by a key within the Gitea database,
|
checking if the commits are signed by a key within the Gitea database,
|
||||||
or if the commit matches the default key for Git.
|
or if the commit matches the default key for Git.
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-23T09:00:00+08:00"
|
date: "2023-05-23T09:00:00+08:00"
|
||||||
title: "GPG 提交签名"
|
title: "GPG 提交签名"
|
||||||
slug: "signing"
|
slug: "signing"
|
||||||
weight: 50
|
sidebar_position: 50
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
name: "GPG 提交签名"
|
name: "GPG 提交签名"
|
||||||
weight: 50
|
sidebar_position: 50
|
||||||
identifier: "signing"
|
identifier: "signing"
|
||||||
---
|
---
|
||||||
|
|
||||||
# GPG 提交签名
|
# GPG 提交签名
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
Gitea 将通过检查提交是否由 Gitea 数据库中的密钥签名,或者提交是否与 Git 的默认密钥匹配,来验证提供的树中的 GPG 提交签名。
|
Gitea 将通过检查提交是否由 Gitea 数据库中的密钥签名,或者提交是否与 Git 的默认密钥匹配,来验证提供的树中的 GPG 提交签名。
|
||||||
|
|
||||||
密钥不会被检查以确定它们是否已过期或撤销。密钥也不会与密钥服务器进行检查。
|
密钥不会被检查以确定它们是否已过期或撤销。密钥也不会与密钥服务器进行检查。
|
||||||
@@ -2,12 +2,12 @@
|
|||||||
date: "2021-01-22T00:00:00+02:00"
|
date: "2021-01-22T00:00:00+02:00"
|
||||||
title: "Contributing"
|
title: "Contributing"
|
||||||
slug: "contributing"
|
slug: "contributing"
|
||||||
weight: 35
|
sidebar_position: 35
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
name: "Contributing"
|
name: "Contributing"
|
||||||
weight: 50
|
sidebar_position: 50
|
||||||
identifier: "contributing"
|
identifier: "contributing"
|
||||||
---
|
---
|
||||||
@@ -2,12 +2,12 @@
|
|||||||
date: "2021-01-22T00:00:00+02:00"
|
date: "2021-01-22T00:00:00+02:00"
|
||||||
title: "Übersetzung"
|
title: "Übersetzung"
|
||||||
slug: "contributing"
|
slug: "contributing"
|
||||||
weight: 35
|
sidebar_position: 35
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
name: "Übersetzung"
|
name: "Übersetzung"
|
||||||
weight: 50
|
sidebar_position: 50
|
||||||
identifier: "contributing"
|
identifier: "contributing"
|
||||||
---
|
---
|
||||||
@@ -2,12 +2,12 @@
|
|||||||
date: "2021-01-22T00:00:00+02:00"
|
date: "2021-01-22T00:00:00+02:00"
|
||||||
title: "貢獻"
|
title: "貢獻"
|
||||||
slug: "contributing"
|
slug: "contributing"
|
||||||
weight: 35
|
sidebar_position: 35
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
name: "貢獻"
|
name: "貢獻"
|
||||||
weight: 50
|
sidebar_position: 50
|
||||||
identifier: "contributing"
|
identifier: "contributing"
|
||||||
---
|
---
|
||||||
+2
-6
@@ -2,23 +2,19 @@
|
|||||||
date: "2021-11-01T23:41:00+08:00"
|
date: "2021-11-01T23:41:00+08:00"
|
||||||
title: "Guidelines for Backend Development"
|
title: "Guidelines for Backend Development"
|
||||||
slug: "guidelines-backend"
|
slug: "guidelines-backend"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
name: "Guidelines for Backend"
|
name: "Guidelines for Backend"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "guidelines-backend"
|
identifier: "guidelines-backend"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Guidelines for Backend Development
|
# Guidelines for Backend Development
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Background
|
## Background
|
||||||
|
|
||||||
Gitea uses Golang as the backend programming language. It uses many third-party packages and also write some itself.
|
Gitea uses Golang as the backend programming language. It uses many third-party packages and also write some itself.
|
||||||
+2
-6
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-25T23:41:00+08:00"
|
date: "2023-05-25T23:41:00+08:00"
|
||||||
title: "后端开发指南"
|
title: "后端开发指南"
|
||||||
slug: "guidelines-backend"
|
slug: "guidelines-backend"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
name: "后端开发指南"
|
name: "后端开发指南"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "guidelines-backend"
|
identifier: "guidelines-backend"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 后端开发指南
|
# 后端开发指南
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## 背景
|
## 背景
|
||||||
|
|
||||||
Gitea使用Golang作为后端编程语言。它使用了许多第三方包,并且自己也编写了一些包。
|
Gitea使用Golang作为后端编程语言。它使用了许多第三方包,并且自己也编写了一些包。
|
||||||
+2
-6
@@ -2,23 +2,19 @@
|
|||||||
date: "2021-10-13T16:00:00+02:00"
|
date: "2021-10-13T16:00:00+02:00"
|
||||||
title: "Guidelines for Frontend Development"
|
title: "Guidelines for Frontend Development"
|
||||||
slug: "guidelines-frontend"
|
slug: "guidelines-frontend"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
name: "Guidelines for Frontend"
|
name: "Guidelines for Frontend"
|
||||||
weight: 30
|
sidebar_position: 30
|
||||||
identifier: "guidelines-frontend"
|
identifier: "guidelines-frontend"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Guidelines for Frontend Development
|
# Guidelines for Frontend Development
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Background
|
## Background
|
||||||
|
|
||||||
Gitea uses [Fomantic-UI](https://fomantic-ui.com/introduction/getting-started.html) (based on [jQuery](https://api.jquery.com)) and [Vue3](https://vuejs.org/) for its frontend.
|
Gitea uses [Fomantic-UI](https://fomantic-ui.com/introduction/getting-started.html) (based on [jQuery](https://api.jquery.com)) and [Vue3](https://vuejs.org/) for its frontend.
|
||||||
+2
-6
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-25T16:00:00+02:00"
|
date: "2023-05-25T16:00:00+02:00"
|
||||||
title: "前端开发指南"
|
title: "前端开发指南"
|
||||||
slug: "guidelines-frontend"
|
slug: "guidelines-frontend"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
name: "前端开发指南"
|
name: "前端开发指南"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "guidelines-frontend"
|
identifier: "guidelines-frontend"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 前端开发指南
|
# 前端开发指南
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## 背景
|
## 背景
|
||||||
|
|
||||||
Gitea 在其前端中使用[Fomantic-UI](https://fomantic-ui.com/introduction/getting-started.html)(基于[jQuery](https://api.jquery.com))和 [Vue3](https://vuejs.org/)。
|
Gitea 在其前端中使用[Fomantic-UI](https://fomantic-ui.com/introduction/getting-started.html)(基于[jQuery](https://api.jquery.com))和 [Vue3](https://vuejs.org/)。
|
||||||
+2
-6
@@ -2,23 +2,19 @@
|
|||||||
date: "2023-02-14T00:00:00+00:00"
|
date: "2023-02-14T00:00:00+00:00"
|
||||||
title: "Guidelines for Refactoring"
|
title: "Guidelines for Refactoring"
|
||||||
slug: "guidelines-refactoring"
|
slug: "guidelines-refactoring"
|
||||||
weight: 40
|
sidebar_position: 40
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
name: "Guidelines for Refactoring"
|
name: "Guidelines for Refactoring"
|
||||||
weight: 40
|
sidebar_position: 40
|
||||||
identifier: "guidelines-refactoring"
|
identifier: "guidelines-refactoring"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Guidelines for Refactoring
|
# Guidelines for Refactoring
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## Background
|
## Background
|
||||||
|
|
||||||
Since the first line of code was written at Feb 12, 2014, Gitea has grown to be a large project.
|
Since the first line of code was written at Feb 12, 2014, Gitea has grown to be a large project.
|
||||||
+2
-6
@@ -2,7 +2,7 @@
|
|||||||
date: "2023-05-25T00:00:00+00:00"
|
date: "2023-05-25T00:00:00+00:00"
|
||||||
title: "重构指南"
|
title: "重构指南"
|
||||||
slug: "guidelines-refactoring"
|
slug: "guidelines-refactoring"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
aliases:
|
aliases:
|
||||||
@@ -11,16 +11,12 @@ menu:
|
|||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
name: "重构指南"
|
name: "重构指南"
|
||||||
weight: 20
|
sidebar_position: 20
|
||||||
identifier: "guidelines-refactoring"
|
identifier: "guidelines-refactoring"
|
||||||
---
|
---
|
||||||
|
|
||||||
# 重构指南
|
# 重构指南
|
||||||
|
|
||||||
**目录**
|
|
||||||
|
|
||||||
{{< toc >}}
|
|
||||||
|
|
||||||
## 背景
|
## 背景
|
||||||
|
|
||||||
自2014年2月12日编写了第一行代码以来,Gitea已经发展成为一个庞大的项目。
|
自2014年2月12日编写了第一行代码以来,Gitea已经发展成为一个庞大的项目。
|
||||||
@@ -2,14 +2,14 @@
|
|||||||
date: "2021-01-22T00:00:00+02:00"
|
date: "2021-01-22T00:00:00+02:00"
|
||||||
title: "Übersetzungs Richtlinien"
|
title: "Übersetzungs Richtlinien"
|
||||||
slug: "localization"
|
slug: "localization"
|
||||||
weight: 70
|
sidebar_position: 70
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
name: "Übersetzungsrichtlinien"
|
name: "Übersetzungsrichtlinien"
|
||||||
weight: 70
|
sidebar_position: 70
|
||||||
identifier: "localization"
|
identifier: "localization"
|
||||||
---
|
---
|
||||||
|
|
||||||
Loaded 50 of 217 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user