diff --git a/src/content/docs/docs/configuration.md b/src/content/docs/docs/configuration.md index 47e8d32..401179f 100644 --- a/src/content/docs/docs/configuration.md +++ b/src/content/docs/docs/configuration.md @@ -216,6 +216,12 @@ checked. connection's `Host`. Have the proxy of the Instance's own host drop this header. - `SPHERICON_TRACKING_EDGE_CIDRS` (default: `127.0.0.0/8,::1/128`) - Comma-separated CIDRs the edge connects from: the only peers whose `SPHERICON_TRACKING_HOST_HEADER` is believed. A proxy on another machine must be listed. + - `SPHERICON_TRUSTED_PROXY_CIDRS` (default: `127.0.0.0/8,::1/128,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,fc00::/7`) - Comma-separated CIDRs of the reverse proxies in front of the Instance (ADR 0175): a request's +`X-Forwarded-For` is read only when it comes from one of them, and its rightmost address +outside them is the client's, the one the rate limits key on and consent records keep. The +default trusts loopback and the private networks, where a proxy on the same host, in a +container network or in a cluster connects from; list a proxy on a public address. Empty trusts +none: the connection's own address is the client's. - `SPHERICON_SYSTEM_EMAIL_PROVIDER` (default: `smtp`) - The provider of the Instance's own mail (verification, password reset, invitations): `smtp`, through `SPHERICON_SMTP_HOST`, or `ses`, through the `SPHERICON_SES_*` credentials. - `SPHERICON_SYSTEM_EMAIL_FROM` (default: `noreply@sphericon.localhost`) - The bare From address of the Instance's own mail, such as `noreply@example.com`. diff --git a/src/content/docs/docs/self-hosting.md b/src/content/docs/docs/self-hosting.md index 5d06e9c..49356ce 100644 --- a/src/content/docs/docs/self-hosting.md +++ b/src/content/docs/docs/self-hosting.md @@ -315,6 +315,13 @@ server { Do not expose `SPHERICON_METRICS_ADDR` through the proxy. +Sphericon reads a client's address (for the rate limits and the proof kept with a consent) from +`X-Forwarded-For` only when the connection comes from a trusted proxy, +`SPHERICON_TRUSTED_PROXY_CIDRS`: loopback and the private networks by default, so a proxy on the same +host, in a Docker network or in a cluster needs nothing. A proxy that connects from a public address +must be listed there, or every client looks like the proxy. A client that reaches port 3000 directly is +never believed about its address. + ### Tracking domains A workspace can serve its mail's links and its tracker on a host of its own, such as `t.example.com`