Publish new build of docs

maintenance/_sources/configuration/config_yaml.rst.txt

@@ -921,9 +921,18 @@ Use the following settings to configure the server:
        # the connecting client's IP address. A reverse proxy on the same machine as OctoPrint (e.g. as
        # found on OctoPi) will be handled correctly by the default setting of 127.0.0.1 and ::1, further
        # proxies in front of that you'll have to add yourself.
-       trustedDownstream:
-       - 127.0.0.1
-       - "::1"
+
+       # List of trusted proxy servers for which to ignore the IP address when trying to determine
+       # the connecting client's IP address. A reverse proxy on the same machine as OctoPrint (e.g. as
+       # found on OctoPi) will be handled correctly by default through `trustLocalhostProxies`, further
+       # proxies in front of that you'll have to add yourself here.
+       trustedProxies: []
+
+       # Whether to trust the local machine to act as a reverse proxy. Defaults to true, will ensure
+       # that `127.0.0.0/8` and `::1` will always be considered to be included in `trustedProxies`. If
+       # you want to explicitly disable trusting the local machine, set this to false and don't include
+       # the local machine in trustedProxies (as in, don't include "127.0.0.1", "127.0.0.0/8" or "::1").
+       trustLocalhostProxies: true
 
      # Whether to allow OctoPrint to be embedded in a frame or not. Note that depending on your setup you might
      # have to set SameSite to None, Secure to true and serve OctoPrint through a reverse proxy that enables https

maintenance/configuration/config_yaml.html

@@ -1026,9 +1026,18 @@
 <span class="w">    </span><span class="c1"># the connecting client&#39;s IP address. A reverse proxy on the same machine as OctoPrint (e.g. as</span>
 <span class="w">    </span><span class="c1"># found on OctoPi) will be handled correctly by the default setting of 127.0.0.1 and ::1, further</span>
 <span class="w">    </span><span class="c1"># proxies in front of that you&#39;ll have to add yourself.</span>
-<span class="w">    </span><span class="nt">trustedDownstream</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">127.0.0.1</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;::1&quot;</span>
+
+<span class="w">    </span><span class="c1"># List of trusted proxy servers for which to ignore the IP address when trying to determine</span>
+<span class="w">    </span><span class="c1"># the connecting client&#39;s IP address. A reverse proxy on the same machine as OctoPrint (e.g. as</span>
+<span class="w">    </span><span class="c1"># found on OctoPi) will be handled correctly by default through `trustLocalhostProxies`, further</span>
+<span class="w">    </span><span class="c1"># proxies in front of that you&#39;ll have to add yourself here.</span>
+<span class="w">    </span><span class="nt">trustedProxies</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
+
+<span class="w">    </span><span class="c1"># Whether to trust the local machine to act as a reverse proxy. Defaults to true, will ensure</span>
+<span class="w">    </span><span class="c1"># that `127.0.0.0/8` and `::1` will always be considered to be included in `trustedProxies`. If</span>
+<span class="w">    </span><span class="c1"># you want to explicitly disable trusting the local machine, set this to false and don&#39;t include</span>
+<span class="w">    </span><span class="c1"># the local machine in trustedProxies (as in, don&#39;t include &quot;127.0.0.1&quot;, &quot;127.0.0.0/8&quot; or &quot;::1&quot;).</span>
+<span class="w">    </span><span class="nt">trustLocalhostProxies</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
 
 <span class="w">  </span><span class="c1"># Whether to allow OctoPrint to be embedded in a frame or not. Note that depending on your setup you might</span>
 <span class="w">  </span><span class="c1"># have to set SameSite to None, Secure to true and serve OctoPrint through a reverse proxy that enables https</span>

maintenance/genindex.html

@@ -3694,9 +3694,11 @@ <h2 id="T">T</h2>
 </li>
       <li><a href="modules/schema.html#octoprint.schema.config.access_control.AccessControlConfig.trustBasicAuthentication">trustBasicAuthentication (octoprint.schema.config.access_control.AccessControlConfig attribute)</a>
 </li>
-      <li><a href="modules/schema.html#octoprint.schema.config.server.ReverseProxyConfig.trustedDownstream">trustedDownstream (octoprint.schema.config.server.ReverseProxyConfig attribute)</a>
+      <li><a href="modules/schema.html#octoprint.schema.config.server.ReverseProxyConfig.trustedProxies">trustedProxies (octoprint.schema.config.server.ReverseProxyConfig attribute)</a>
 </li>
       <li><a href="modules/schema.html#octoprint.schema.config.server.IpCheckConfig.trustedSubnets">trustedSubnets (octoprint.schema.config.server.IpCheckConfig attribute)</a>
+</li>
+      <li><a href="modules/schema.html#octoprint.schema.config.server.ReverseProxyConfig.trustLocalhostProxies">trustLocalhostProxies (octoprint.schema.config.server.ReverseProxyConfig attribute)</a>
 </li>
       <li><a href="modules/schema.html#octoprint.schema.config.access_control.AccessControlConfig.trustRemoteUser">trustRemoteUser (octoprint.schema.config.access_control.AccessControlConfig attribute)</a>
 </li>

maintenance/modules/index.html

@@ -1009,7 +1009,8 @@
 <li class="toctree-l3"><a class="reference internal" href="schema.html#octoprint.schema.config.server.ReverseProxyConfig.schemeHeader"><code class="docutils literal notranslate"><span class="pre">ReverseProxyConfig.schemeHeader</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="schema.html#octoprint.schema.config.server.ReverseProxyConfig.serverFallback"><code class="docutils literal notranslate"><span class="pre">ReverseProxyConfig.serverFallback</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="schema.html#octoprint.schema.config.server.ReverseProxyConfig.serverHeader"><code class="docutils literal notranslate"><span class="pre">ReverseProxyConfig.serverHeader</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="schema.html#octoprint.schema.config.server.ReverseProxyConfig.trustedDownstream"><code class="docutils literal notranslate"><span class="pre">ReverseProxyConfig.trustedDownstream</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#octoprint.schema.config.server.ReverseProxyConfig.trustLocalhostProxies"><code class="docutils literal notranslate"><span class="pre">ReverseProxyConfig.trustLocalhostProxies</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#octoprint.schema.config.server.ReverseProxyConfig.trustedProxies"><code class="docutils literal notranslate"><span class="pre">ReverseProxyConfig.trustedProxies</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="schema.html#octoprint.schema.config.server.SameSiteEnum"><code class="docutils literal notranslate"><span class="pre">SameSiteEnum</span></code></a><ul>