diff options
| author | E.T. <190912194+ElectricTea@users.noreply.github.com> | 2026-01-17 09:17:23 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-01-17 14:17:23 +0000 |
| commit | a02644ef8adb1f93f81ad2b5425f113387b71c28 (patch) | |
| tree | 72d2800c7abd851a6bbb77112bc3bf5847a834e3 | |
| parent | 086b464dc66e61e182702e58a6b2f102eda1ab50 (diff) | |
| download | karakeep-a02644ef8adb1f93f81ad2b5425f113387b71c28.tar.zst | |
docs: Update CRAWLER_ALLOWED_INTERNAL_HOSTNAMES documentation with tailscale examples (#2355)
* Update CRAWLER_ALLOWED_INTERNAL_HOSTNAMES documentation with tailscale examples
* docs: Update CRAWLER_ALLOWED_INTERNAL_HOSTNAMES documentation with tailscale examples
Added to general documentation, not just version v0.30.0 docs
| -rw-r--r-- | docs/docs/03-configuration/01-environment-variables.md | 2 | ||||
| -rw-r--r-- | docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/docs/03-configuration/01-environment-variables.md b/docs/docs/03-configuration/01-environment-variables.md index d20b968e..a7f45221 100644 --- a/docs/docs/03-configuration/01-environment-variables.md +++ b/docs/docs/03-configuration/01-environment-variables.md @@ -236,7 +236,7 @@ If your Karakeep instance needs to connect through a proxy server, you can confi | CRAWLER_HTTP_PROXY | No | Not set | HTTP proxy server URL for outgoing HTTP requests (e.g., `http://proxy.example.com:8080`). You can pass multiple comma separated proxies and the used one will be chosen at random. The proxy is used for crawling, RSS feed fetches and webhooks. | | CRAWLER_HTTPS_PROXY | No | Not set | HTTPS proxy server URL for outgoing HTTPS requests (e.g., `http://proxy.example.com:8080`). You can pass multiple comma separated proxies and the used one will be chosen at random. The proxy is used for crawling, RSS feed fetches and webhooks. | | CRAWLER_NO_PROXY | No | Not set | Comma-separated list of hostnames/IPs that should bypass the proxy (e.g., `localhost,127.0.0.1,.local`) | -| CRAWLER_ALLOWED_INTERNAL_HOSTNAMES | No | Not set | By default, Karakeep blocks worker-initiated requests whose DNS resolves to private, loopback, or link-local IP addresses. Use this to allowlist specific hostnames for internal access (e.g., `internal.company.com,.local`). Supports domain wildcards by prefixing with a dot (e.g., `.internal.company.com`). Passing `.` allowlists all domains. Note: Internal IP validation is bypassed when a proxy is configured for the URL as the local DNS resolver won't necessarily be the same as the one used by the proxy. | +| CRAWLER_ALLOWED_INTERNAL_HOSTNAMES | No | Not set | By default, Karakeep blocks worker-initiated requests whose DNS resolves to private, loopback, link-local, or Tailscale CGNAT IP addresses. Use this to allowlist specific hostnames for internal access (e.g., `internal.company.com`, `app-name.local`). Supports domain wildcards by prefixing with a dot (e.g., `.internal.company.com`, `.<tailnet-name>.ts.net`). Passing `.` allowlists all domains. Note: Internal IP validation is bypassed when a proxy is configured for the URL as the local DNS resolver won't necessarily be the same as the one used by the proxy. | :::info These proxy settings will be used by the crawler and other components that make outgoing HTTP requests. diff --git a/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md b/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md index a8bf8ba6..23a6f3b9 100644 --- a/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md +++ b/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md @@ -235,7 +235,7 @@ If your Karakeep instance needs to connect through a proxy server, you can confi | CRAWLER_HTTP_PROXY | No | Not set | HTTP proxy server URL for outgoing HTTP requests (e.g., `http://proxy.example.com:8080`). You can pass multiple comma separated proxies and the used one will be chosen at random. The proxy is used for crawling, RSS feed fetches and webhooks. | | CRAWLER_HTTPS_PROXY | No | Not set | HTTPS proxy server URL for outgoing HTTPS requests (e.g., `http://proxy.example.com:8080`). You can pass multiple comma separated proxies and the used one will be chosen at random. The proxy is used for crawling, RSS feed fetches and webhooks. | | CRAWLER_NO_PROXY | No | Not set | Comma-separated list of hostnames/IPs that should bypass the proxy (e.g., `localhost,127.0.0.1,.local`) | -| CRAWLER_ALLOWED_INTERNAL_HOSTNAMES | No | Not set | By default, Karakeep blocks worker-initiated requests whose DNS resolves to private, loopback, or link-local IP addresses. Use this to allowlist specific hostnames for internal access (e.g., `internal.company.com,.local`). Supports domain wildcards by prefixing with a dot (e.g., `.internal.company.com`). Passing `.` allowlists all domains. Note: Internal IP validation is bypassed when a proxy is configured for the URL as the local DNS resolver won't necessarily be the same as the one used by the proxy. | +| CRAWLER_ALLOWED_INTERNAL_HOSTNAMES | No | Not set | By default, Karakeep blocks worker-initiated requests whose DNS resolves to private, loopback, link-local, or Tailscale CGNAT IP addresses. Use this to allowlist specific hostnames for internal access (e.g., `internal.company.com`, `app-name.local`). Supports domain wildcards by prefixing with a dot (e.g., `.internal.company.com`, `.<tailnet-name>.ts.net`). Passing `.` allowlists all domains. Note: Internal IP validation is bypassed when a proxy is configured for the URL as the local DNS resolver won't necessarily be the same as the one used by the proxy. | :::info These proxy settings will be used by the crawler and other components that make outgoing HTTP requests. |