mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-31 22:28:05 +01:00 
			
		
		
		
	Update docs for versions (#20750)
This commit is contained in:
		
							parent
							
								
									802c5313e1
								
							
						
					
					
						commit
						3d76d6034e
					
				| @ -1503,6 +1503,11 @@ ROUTER = console | ||||
| ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | ||||
| ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | ||||
| ;; | ||||
| ;; NOTICE: this section is for Gitea 1.18 and later. If you are using Gitea 1.17 or older, | ||||
| ;; please refer to | ||||
| ;; https://github.com/go-gitea/gitea/blob/release/v1.17/custom/conf/app.example.ini | ||||
| ;; https://github.com/go-gitea/gitea/blob/release/v1.17/docs/content/doc/advanced/config-cheat-sheet.en-us.md | ||||
| ;; | ||||
| ;ENABLED = false | ||||
| ;; | ||||
| ;; Buffer length of channel, keep it as it is if you don't know what it is. | ||||
| @ -1516,12 +1521,12 @@ ROUTER = console | ||||
| ;; - dummy: send email messages to the log as a testing phase. | ||||
| ;; 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. | ||||
| ;; (Before 1.18, this was controlled via MAILER_TYPE and IS_TLS_ENABLED.) | ||||
| ;; (Before 1.18, see the notice, this was controlled via MAILER_TYPE and IS_TLS_ENABLED.) | ||||
| ;PROTOCOL = | ||||
| ;; | ||||
| ;; 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 as HOST.) | ||||
| ;; (Before 1.18, see the notice, this was combined with SMTP_PORT as HOST.) | ||||
| ;SMTP_ADDR = | ||||
| ;; | ||||
| ;; Mail server port. Common ports are: | ||||
|  | ||||
| @ -296,8 +296,8 @@ The following configuration set `Content-Type: application/vnd.android.package-a | ||||
| - `MINIMUM_KEY_SIZE_CHECK`: **true**: Indicate whether to check minimum key size with corresponding type. | ||||
| 
 | ||||
| - `OFFLINE_MODE`: **false**: Disables use of CDN for static files and Gravatar for profile pictures. | ||||
| - `CERT_FILE`: **https/cert.pem**: Cert file path used for HTTPS. When chaining, the server certificate must come first, then intermediate CA certificates (if any). This is ignored if `ENABLE_ACME=true`. From 1.11 paths are relative to `CUSTOM_PATH`. | ||||
| - `KEY_FILE`: **https/key.pem**: Key file path used for HTTPS. This is ignored if `ENABLE_ACME=true`. From 1.11 paths are relative to `CUSTOM_PATH`. | ||||
| - `CERT_FILE`: **https/cert.pem**: Cert file path used for HTTPS. When chaining, the server certificate must come first, then intermediate CA certificates (if any). This is ignored if `ENABLE_ACME=true`. Paths are relative to `CUSTOM_PATH`. | ||||
| - `KEY_FILE`: **https/key.pem**: Key file path used for HTTPS. This is ignored if `ENABLE_ACME=true`. Paths are relative to `CUSTOM_PATH`. | ||||
| - `STATIC_ROOT_PATH`: **./**: Upper level of template and static files path. | ||||
| - `APP_DATA_PATH`: **data** (**/data/gitea** on docker): Default path for application data. | ||||
| - `STATIC_CACHE_TIME`: **6h**: Web browser cache time for static resources on `custom/`, `public/` and all uploaded avatars. Note that this cache is disabled when `RUN_MODE` is "dev". | ||||
| @ -438,11 +438,11 @@ Configuration at `[queue]` will set defaults for queues with overrides for indiv | ||||
| - `MAX_ATTEMPTS`: **10**: Maximum number of attempts to create the wrapped queue | ||||
| - `TIMEOUT`: **GRACEFUL_HAMMER_TIME + 30s**: Timeout the creation of the wrapped queue if it takes longer than this to create. | ||||
| - Queues by default come with a dynamically scaling worker pool. The following settings configure this: | ||||
| - `WORKERS`: **0** (v1.14 and before: **1**): Number of initial workers for the queue. | ||||
| - `WORKERS`: **0**: Number of initial workers for the queue. | ||||
| - `MAX_WORKERS`: **10**: Maximum number of worker go-routines for the queue. | ||||
| - `BLOCK_TIMEOUT`: **1s**: If the queue blocks for this time, boost the number of workers - the `BLOCK_TIMEOUT` will then be doubled before boosting again whilst the boost is ongoing. | ||||
| - `BOOST_TIMEOUT`: **5m**: Boost workers will timeout after this long. | ||||
| - `BOOST_WORKERS`: **1** (v1.14 and before: **5**): This many workers will be added to the worker pool if there is a boost. | ||||
| - `BOOST_WORKERS`: **1**: This many workers will be added to the worker pool if there is a boost. | ||||
| 
 | ||||
| Gitea creates the following non-unique queues: | ||||
| 
 | ||||
| @ -634,7 +634,7 @@ Define allowed algorithms and their minimum key length (use -1 to disable a type | ||||
| 
 | ||||
| - `QUEUE_LENGTH`: **1000**: Hook task queue length. Use caution when editing this value. | ||||
| - `DELIVER_TIMEOUT`: **5**: Delivery timeout (sec) for shooting webhooks. | ||||
| - `ALLOWED_HOST_LIST`: **external**: Since 1.15.7. Default to `*` for 1.15.x, `external` for 1.16 and later. Webhook can only call allowed hosts for security reasons. Comma separated list. | ||||
| - `ALLOWED_HOST_LIST`: **external**: Webhook can only call allowed hosts for security reasons. Comma separated list. | ||||
|   - Built-in networks: | ||||
|     - `loopback`: 127.0.0.0/8 for IPv4 and ::1/128 for IPv6, localhost is included. | ||||
|     - `private`: RFC 1918 (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) and RFC 4193 (FC00::/7). Also called LAN/Intranet. | ||||
| @ -649,6 +649,12 @@ Define allowed algorithms and their minimum key length (use -1 to disable a type | ||||
| 
 | ||||
| ## Mailer (`mailer`) | ||||
| 
 | ||||
| ⚠️ This section is for Gitea 1.18 and later. If you are using Gitea 1.17 or older, | ||||
| please refer to | ||||
| [Gitea 1.17 app.ini example](https://github.com/go-gitea/gitea/blob/release/v1.17/custom/conf/app.example.ini) | ||||
| 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) | ||||
| 
 | ||||
| - `ENABLED`: **false**: Enable to use a mail service. | ||||
| - `PROTOCOL`: **\<empty\>**: Mail server protocol. One of "smtp", "smtps", "smtp+startls", "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. | ||||
|  | ||||
| @ -15,7 +15,14 @@ menu: | ||||
| 
 | ||||
| # 配置说明 | ||||
| 
 | ||||
| 这是针对Gitea配置文件的说明,你可以了解Gitea的强大配置。需要说明的是,你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。所有默认值可以通过 [app.example.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) 查看到。如果你发现 `%(X)s` 这样的内容,请查看 [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义,否则最好使用默认值。 | ||||
| 这是针对Gitea配置文件的说明,你可以了解Gitea的强大配置。需要说明的是,你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 | ||||
| 所有默认值可以通过 [app.example.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) 查看到。 | ||||
| 如果你发现 `%(X)s` 这样的内容,请查看 [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。 | ||||
| 标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义,否则最好使用默认值。 | ||||
| 
 | ||||
| ## ⚠️时效性警告⚠️ | ||||
| 
 | ||||
| 此文档的内容可能过于陈旧或者错误,请参考英文文档。 | ||||
| 
 | ||||
| {{< toc >}} | ||||
| 
 | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user