From 0e7d1521658d69b75ebadd5c55ff68960cdfdda5 Mon Sep 17 00:00:00 2001 From: sbourdeauducq Date: Wed, 21 Aug 2024 04:23:27 +0000 Subject: [PATCH 1/2] add warning about choice of database type --- docs/installation/database-preparation.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/installation/database-preparation.md b/docs/installation/database-preparation.md index 90252d3a..25af91fc 100644 --- a/docs/installation/database-preparation.md +++ b/docs/installation/database-preparation.md @@ -10,6 +10,10 @@ aliases: You need a database to use Gitea. Gitea supports PostgreSQL (>= 12), MySQL (>= 8.0), MariaDB (>= 10.4), SQLite (builtin), and MSSQL (>= 2012 SP4). This page will guide into preparing database. Only PostgreSQL and MySQL will be covered here since those database engines are widely-used in production. If you plan to use SQLite, you can ignore this chapter. +:::warning +Converting one database type to another is not a well-tested process and you may experience issues. It is better to choose the final database type at the type of the first installation. Be aware that SQLite does not scale; if you expect your instance to grow at a later time, you should choose another database type. +::: + If you use an unsupported database version, please [get in touch](/help/support) with us for information on our Extended Support Contracts. We can provide testing and support for older databases and integrate those fixes into the Gitea codebase. Database instance can be on same machine as Gitea (local database setup), or on different machine (remote database). From 5ecafa9a56b3e0ea7e743da4b0325e0526abbcb9 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 22 Aug 2024 04:09:23 +0000 Subject: [PATCH 2/2] Fix outdated cheat sheet about ALLOWED_DOMAINS (#55) Reviewed-on: https://gitea.com/gitea/docs/pulls/55 Reviewed-by: yp05327 --- docs/administration/config-cheat-sheet.md | 2 +- .../current/administration/config-cheat-sheet.md | 2 +- .../version-1.21/administration/config-cheat-sheet.md | 2 +- .../version-1.22/administration/config-cheat-sheet.md | 2 +- .../version-1.19/administration/config-cheat-sheet.md | 2 +- .../version-1.20/administration/config-cheat-sheet.md | 2 +- .../version-1.21/administration/config-cheat-sheet.md | 2 +- .../version-1.22/administration/config-cheat-sheet.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/administration/config-cheat-sheet.md b/docs/administration/config-cheat-sheet.md index 8db300a9..b5539b1a 100644 --- a/docs/administration/config-cheat-sheet.md +++ b/docs/administration/config-cheat-sheet.md @@ -1239,7 +1239,7 @@ in this mapping or the filetype using heuristics. - `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations. - `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 external hosts 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. - `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 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md index 4b0dd7da..9de1303d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md @@ -1126,7 +1126,7 @@ ALLOW_DATA_URI_IMAGES = true - `MAX_ATTEMPTS`：**3**：每次 http/https 请求的最大尝试次数（用于迁移）。 - `RETRY_BACKOFF`：**3**：每次 http/https 请求重试的退避时间（秒）。 -- `ALLOWED_DOMAINS`：**_empty_**：允许迁移仓库的域名允许列表，默认为空。这意味着允许一切。多个域名可以用逗号分隔。支持通配符：`github.com, *.github.com`。 +- `ALLOWED_DOMAINS`：**_empty_**：允许迁移仓库的域名允许列表，默认为空。这意味着允许外部网址。多个域名可以用逗号分隔。支持通配符：`github.com, *.github.com`。 - `BLOCKED_DOMAINS`：**_empty_**：阻止迁移仓库的域名阻止列表，默认为空。多个域名可以用逗号分隔。当 `ALLOWED_DOMAINS` 不为空时，此选项优先级较高，用于拒绝域名。支持通配符。 - `ALLOW_LOCALNETWORKS`：**false**：允许 RFC 1918、RFC 1122、RFC 4632 和 RFC 4291 中定义的私有地址。如果域名被 `ALLOWED_DOMAINS` 允许，此选项将被忽略。 - `SKIP_TLS_VERIFY`：**false**：允许跳过 TLS 验证。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md index d500ef4e..ee5768a2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md @@ -1125,7 +1125,7 @@ ALLOW_DATA_URI_IMAGES = true - `MAX_ATTEMPTS`：**3**：每次 http/https 请求的最大尝试次数（用于迁移）。 - `RETRY_BACKOFF`：**3**：每次 http/https 请求重试的退避时间（秒）。 -- `ALLOWED_DOMAINS`：**_empty_**：允许迁移仓库的域名允许列表，默认为空。这意味着允许一切。多个域名可以用逗号分隔。支持通配符：`github.com, *.github.com`。 +- `ALLOWED_DOMAINS`：**_empty_**：允许迁移仓库的域名允许列表，默认为空。这意味着允许外部网址。多个域名可以用逗号分隔。支持通配符：`github.com, *.github.com`。 - `BLOCKED_DOMAINS`：**_empty_**：阻止迁移仓库的域名阻止列表，默认为空。多个域名可以用逗号分隔。当 `ALLOWED_DOMAINS` 不为空时，此选项优先级较高，用于拒绝域名。支持通配符。 - `ALLOW_LOCALNETWORKS`：**false**：允许 RFC 1918、RFC 1122、RFC 4632 和 RFC 4291 中定义的私有地址。如果域名被 `ALLOWED_DOMAINS` 允许，此选项将被忽略。 - `SKIP_TLS_VERIFY`：**false**：允许跳过 TLS 验证。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md index 24e27258..3f6cb91d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md @@ -1125,7 +1125,7 @@ ALLOW_DATA_URI_IMAGES = true - `MAX_ATTEMPTS`：**3**：每次 http/https 请求的最大尝试次数（用于迁移）。 - `RETRY_BACKOFF`：**3**：每次 http/https 请求重试的退避时间（秒）。 -- `ALLOWED_DOMAINS`：**_empty_**：允许迁移仓库的域名允许列表，默认为空。这意味着允许一切。多个域名可以用逗号分隔。支持通配符：`github.com, *.github.com`。 +- `ALLOWED_DOMAINS`：**_empty_**：允许迁移仓库的域名允许列表，默认为空。这意味着允许外部网址。多个域名可以用逗号分隔。支持通配符：`github.com, *.github.com`。 - `BLOCKED_DOMAINS`：**_empty_**：阻止迁移仓库的域名阻止列表，默认为空。多个域名可以用逗号分隔。当 `ALLOWED_DOMAINS` 不为空时，此选项优先级较高，用于拒绝域名。支持通配符。 - `ALLOW_LOCALNETWORKS`：**false**：允许 RFC 1918、RFC 1122、RFC 4632 和 RFC 4291 中定义的私有地址。如果域名被 `ALLOWED_DOMAINS` 允许，此选项将被忽略。 - `SKIP_TLS_VERIFY`：**false**：允许跳过 TLS 验证。 diff --git a/versioned_docs/version-1.19/administration/config-cheat-sheet.md b/versioned_docs/version-1.19/administration/config-cheat-sheet.md index 3aa54483..3a51e767 100644 --- a/versioned_docs/version-1.19/administration/config-cheat-sheet.md +++ b/versioned_docs/version-1.19/administration/config-cheat-sheet.md @@ -1224,7 +1224,7 @@ Task queue configuration has been moved to `queue.task`. However, the below conf - `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations. - `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 external hosts 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. - `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 diff --git a/versioned_docs/version-1.20/administration/config-cheat-sheet.md b/versioned_docs/version-1.20/administration/config-cheat-sheet.md index a7430a10..65b88c58 100644 --- a/versioned_docs/version-1.20/administration/config-cheat-sheet.md +++ b/versioned_docs/version-1.20/administration/config-cheat-sheet.md @@ -1191,7 +1191,7 @@ Task queue configuration has been moved to `queue.task`. However, the below conf - `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations. - `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 external hosts 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. - `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 diff --git a/versioned_docs/version-1.21/administration/config-cheat-sheet.md b/versioned_docs/version-1.21/administration/config-cheat-sheet.md index 7281ca01..3b38f2b6 100644 --- a/versioned_docs/version-1.21/administration/config-cheat-sheet.md +++ b/versioned_docs/version-1.21/administration/config-cheat-sheet.md @@ -1193,7 +1193,7 @@ in this mapping or the filetype using heuristics. - `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations. - `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 external hosts 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. - `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 diff --git a/versioned_docs/version-1.22/administration/config-cheat-sheet.md b/versioned_docs/version-1.22/administration/config-cheat-sheet.md index 3334356f..4bd505af 100644 --- a/versioned_docs/version-1.22/administration/config-cheat-sheet.md +++ b/versioned_docs/version-1.22/administration/config-cheat-sheet.md @@ -1215,7 +1215,7 @@ in this mapping or the filetype using heuristics. - `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations. - `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 external hosts 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. - `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