diff options
| author | Moritz Poldrack <33086936+mpldr@users.noreply.github.com> | 2023-11-01 19:00:20 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-01 18:00:20 +0000 |
| commit | 9b6e77c489edf3af3a9782c977cc04fde7aa2fd9 (patch) | |
| tree | aa9ae5e2374b2b75d97324c88f61fff0e2dac810 /docs | |
| parent | 665d12cf8485d8be2189208b60f371365d56bb0e (diff) | |
| download | gitea-9b6e77c489edf3af3a9782c977cc04fde7aa2fd9.tar.gz gitea-9b6e77c489edf3af3a9782c977cc04fde7aa2fd9.zip | |
refactor postgres connection string building (#27723)
This patchset changes the connection string builder to use net.URL and
the host/port parser to use the stdlib function for splitting host from
port. It also adds a footnote about a potentially required portnumber
for postgres UNIX sockets.
Fixes: #24552
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/administration/config-cheat-sheet.en-us.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/content/administration/config-cheat-sheet.en-us.md b/docs/content/administration/config-cheat-sheet.en-us.md index 617715fbaa..715bd6d325 100644 --- a/docs/content/administration/config-cheat-sheet.en-us.md +++ b/docs/content/administration/config-cheat-sheet.en-us.md @@ -424,7 +424,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a ## Database (`database`) - `DB_TYPE`: **mysql**: The database type in use \[mysql, postgres, mssql, sqlite3\]. -- `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[^1]\] (ex: /var/run/mysqld/mysqld.sock). - `NAME`: **gitea**: Database name. - `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. @@ -455,6 +455,8 @@ The following configuration set `Content-Type: application/vnd.android.package-a - `CONN_MAX_LIFETIME` **0 or 3s**: Sets the maximum amount of time a DB connection may be reused - default is 0, meaning there is no limit (except on MySQL where it is 3s - see #6804 & #7071). - `AUTO_MIGRATION` **true**: Whether execute database models migrations automatically. +[^1]: It may be necessary to specify a hostport even when listening on a unix socket, as the port is part of the socket name. see [#24552](https://github.com/go-gitea/gitea/issues/24552#issuecomment-1681649367) for additional details. + Please see #8540 & #8273 for further discussion of the appropriate values for `MAX_OPEN_CONNS`, `MAX_IDLE_CONNS` & `CONN_MAX_LIFETIME` and their relation to port exhaustion. |