improve hints/docs regarding http proxy user/pass auth (#1462)

in the web UI (Settings > Network > Proxy) it's unclear that shelfmark's
proxy option supports proxies that require user/pass auth. this PR adds
a note to the web UI's hint to explain this. it updates the associated
documentation as well.

also removed the `e.g.` note, since the form field already includes an
example and this was redundant.

a side note: i think the verbiage "HTTPS proxy URL (leave empty to use
HTTP proxy for HTTPS)" is a little confusing. i believe it's referring
to the fact that a user can specify one proxy address for HTTP requests
that shelfmark would make, and another proxy address for HTTPS requests
that shelfmark would make. i'll leave this for the maintainer to decide
whether to clarify.
This commit is contained in:
FarawayMagnet authored and GitHub committed 2026-10-20 01:10:41 -04:00
1 parent d3bcf0674d
commit ad62f41edc
2 files changed
+6 -6

No files matched your search

+4 -4
View File
@@ -1037,8 +1037,8 @@ Custom label for the OIDC sign-in button on the login page.
| `USE_DOH` | Use encrypted DNS queries for improved reliability and privacy. | boolean | `true` |
| `USING_TOR` | Route all traffic through Tor for enhanced privacy. Requires root startup. | boolean | `false` |
| `PROXY_MODE` | Choose proxy type. SOCKS5 handles all traffic through a single proxy. | string (choice) | `none` |
| `HTTP_PROXY` | HTTP proxy URL (e.g., http://proxy:8080) | string | _none_ |
| `HTTPS_PROXY` | HTTPS proxy URL (leave empty to use HTTP proxy for HTTPS) | string | _none_ |
| `HTTP_PROXY` | HTTP proxy URL. Supports auth: http://user:pass@host:port | string | _none_ |
| `HTTPS_PROXY` | HTTPS proxy URL (leave empty to use HTTP proxy for HTTPS). Supports auth: http://user:pass@host:port | string | _none_ |
| `SOCKS5_PROXY` | SOCKS5 proxy URL. Supports auth: socks5://user:pass@host:port | string | _none_ |
| `NO_PROXY` | Comma-separated hosts to bypass proxy (e.g., localhost,127.0.0.1,10.*,*.local) | string | _none_ |
@@ -1106,7 +1106,7 @@ Choose proxy type. SOCKS5 handles all traffic through a single proxy.
**HTTP Proxy**
HTTP proxy URL (e.g., http://proxy:8080)
HTTP proxy URL. Supports auth: http://user:pass@host:port
- **Type:** string
- **Default:** _none_
@@ -1115,7 +1115,7 @@ HTTP proxy URL (e.g., http://proxy:8080)
**HTTPS Proxy**
HTTPS proxy URL (leave empty to use HTTP proxy for HTTPS)
HTTPS proxy URL (leave empty to use HTTP proxy for HTTPS). Supports auth: http://user:pass@host:port
- **Type:** string
- **Default:** _none_
+2 -2
View File
@@ -772,7 +772,7 @@ def network_settings() -> list[SettingsField]:
TextField(
key="HTTP_PROXY",
label="HTTP Proxy",
description="HTTP proxy URL (e.g., http://proxy:8080)",
description="HTTP proxy URL. Supports auth: http://user:pass@host:port",
placeholder="http://proxy:8080",
disabled=tor_overrides_network,
disabled_reason="Proxy settings are not used when Tor routing is enabled.",
@@ -781,7 +781,7 @@ def network_settings() -> list[SettingsField]:
TextField(
key="HTTPS_PROXY",
label="HTTPS Proxy",
description="HTTPS proxy URL (leave empty to use HTTP proxy for HTTPS)",
description="HTTPS proxy URL (leave empty to use HTTP proxy for HTTPS). Supports auth: http://user:pass@host:port",
placeholder="http://proxy:8080",
disabled=tor_overrides_network,
disabled_reason="Proxy settings are not used when Tor routing is enabled.",