From 00102c44e23e26aa016670b777346d2dbda67847 Mon Sep 17 00:00:00 2001 From: 0ko <0ko@noreply.codeberg.org> Date: Wed, 10 Jul 2024 12:16:58 +0500 Subject: [PATCH] admin: cheat sheet, clarify proxy configuration --- docs/admin/config-cheat-sheet.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/admin/config-cheat-sheet.md b/docs/admin/config-cheat-sheet.md index 447750c1..af2181ec 100644 --- a/docs/admin/config-cheat-sheet.md +++ b/docs/admin/config-cheat-sheet.md @@ -1288,7 +1288,7 @@ The settings for all these sections are [explained in detail in the storage docu - `PROXY_URL`: **\**: Proxy server URL, support http://, https//, socks5://, blank will follow environment http_proxy/https_proxy - `PROXY_HOSTS`: **\**: Comma separated list of host names requiring proxy. Glob patterns (\*) are accepted; use \*\* to match all hosts. -i.e. +For example, the following configuration can be used to proxy connections GitHub subdomains, such as api.github.com: ```ini PROXY_ENABLED = true @@ -1296,6 +1296,14 @@ PROXY_URL = socks5://127.0.0.1:1080 PROXY_HOSTS = *.github.com ``` +If you intend to proxy all connections to github.com, specify it's second-level domain too: + +``` +PROXY_HOSTS = github.com,*.github.com +``` + +Note that you may need to set `[migrations].ALLOW_LOCALNETWORKS` option to `true` in order to allow performing migrations via proxy. + ## Actions (`actions`) - `ENABLED`: **true**: Enable/Disable actions