deploy: 98f84256e9
This commit is contained in:
MadLittleMods
@@ -1149,8 +1149,20 @@ this is necessary is in corporate environments behind a DMZ (demilitarized zone)
|
||||
Synapse supports routing outbound HTTP(S) requests via a proxy. Only HTTP(S)
|
||||
proxy is supported, not SOCKS proxy or anything else.</p>
|
||||
<h2 id="configure"><a class="header" href="#configure">Configure</a></h2>
|
||||
<p>The <code>http_proxy</code>, <code>https_proxy</code>, <code>no_proxy</code> environment variables are used to
|
||||
specify proxy settings. The environment variable is not case sensitive.</p>
|
||||
<p>The proxy settings can be configured in the homeserver configuration file via
|
||||
<a href="setup/../usage/configuration/config_documentation.html#http_proxy"><code>http_proxy</code></a>,
|
||||
<a href="setup/../usage/configuration/config_documentation.html#https_proxy"><code>https_proxy</code></a>, and
|
||||
<a href="setup/../usage/configuration/config_documentation.html#no_proxy_hosts"><code>no_proxy_hosts</code></a>.</p>
|
||||
<p><code>homeserver.yaml</code> example:</p>
|
||||
<pre><code class="language-yaml">http_proxy: http://USERNAME:PASSWORD@10.0.1.1:8080/
|
||||
https_proxy: http://USERNAME:PASSWORD@proxy.example.com:8080/
|
||||
no_proxy_hosts:
|
||||
- master.hostname.example.com
|
||||
- 10.1.0.0/16
|
||||
- 172.30.0.0/16
|
||||
</code></pre>
|
||||
<p>The proxy settings can also be configured via the <code>http_proxy</code>, <code>https_proxy</code>,
|
||||
<code>no_proxy</code> environment variables. The environment variable is not case sensitive.</p>
|
||||
<ul>
|
||||
<li><code>http_proxy</code>: Proxy server to use for HTTP requests.</li>
|
||||
<li><code>https_proxy</code>: Proxy server to use for HTTPS requests.</li>
|
||||
@@ -1192,7 +1204,7 @@ will apply blacklisting of IP addresses.</p>
|
||||
<li>phone-home stats</li>
|
||||
<li>recaptcha validation</li>
|
||||
<li>CAS auth validation</li>
|
||||
<li>OpenID Connect</li>
|
||||
<li>OpenID Connect (OIDC)</li>
|
||||
<li>Outbound federation</li>
|
||||
<li>Federation (checking public key revocation)</li>
|
||||
<li>Fetching public keys of other servers</li>
|
||||
@@ -1201,7 +1213,7 @@ will apply blacklisting of IP addresses.</p>
|
||||
<p>It will <strong>not be used</strong> for:</p>
|
||||
<ul>
|
||||
<li>Application Services</li>
|
||||
<li>Identity servers</li>
|
||||
<li>Matrix Identity servers</li>
|
||||
<li>In worker configurations
|
||||
<ul>
|
||||
<li>connections between workers</li>
|
||||
@@ -4375,6 +4387,30 @@ shown.</p>
|
||||
ssh_pub_key_path: CONFDIR/id_rsa.pub
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="http_proxy"><a class="header" href="#http_proxy"><code>http_proxy</code></a></h3>
|
||||
<p><em>(string|null)</em> Proxy server to use for HTTP requests.
|
||||
For more details, see the <a href="usage/configuration/../../setup/forward_proxy.html">forward proxy documentation</a>. There is no default for this option.</p>
|
||||
<p>Example configuration:</p>
|
||||
<pre><code class="language-yaml">http_proxy: http://USERNAME:PASSWORD@10.0.1.1:8080/
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="https_proxy"><a class="header" href="#https_proxy"><code>https_proxy</code></a></h3>
|
||||
<p><em>(string|null)</em> Proxy server to use for HTTPS requests.
|
||||
For more details, see the <a href="usage/configuration/../../setup/forward_proxy.html">forward proxy documentation</a>. There is no default for this option.</p>
|
||||
<p>Example configuration:</p>
|
||||
<pre><code class="language-yaml">https_proxy: http://USERNAME:PASSWORD@proxy.example.com:8080/
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="no_proxy_hosts"><a class="header" href="#no_proxy_hosts"><code>no_proxy_hosts</code></a></h3>
|
||||
<p><em>(array)</em> List of hosts, IP addresses, or IP ranges in CIDR format which should not use the proxy. Synapse will directly connect to these hosts.
|
||||
For more details, see the <a href="usage/configuration/../../setup/forward_proxy.html">forward proxy documentation</a>. There is no default for this option.</p>
|
||||
<p>Example configuration:</p>
|
||||
<pre><code class="language-yaml">no_proxy_hosts:
|
||||
- master.hostname.example.com
|
||||
- 10.1.0.0/16
|
||||
- 172.30.0.0/16
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="dummy_events_threshold"><a class="header" href="#dummy_events_threshold"><code>dummy_events_threshold</code></a></h3>
|
||||
<p><em>(integer)</em> Forward extremities can build up in a room due to networking delays between homeservers. Once this happens in a large room, calculation of the state of that room can become quite expensive. To mitigate this, once the number of forward extremities reaches a given threshold, Synapse will send an <code>org.matrix.dummy_event</code> event, which will reduce the forward extremities in the room.</p>
|
||||
<p>This setting defines the threshold (i.e. number of forward extremities in the room) at which dummy events are sent.</p>
|
||||
|
||||
@@ -547,6 +547,37 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"http_proxy": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "Proxy server to use for HTTP requests.\nFor more details, see the [forward proxy documentation](../../setup/forward_proxy.md).",
|
||||
"examples": [
|
||||
"http://USERNAME:PASSWORD@10.0.1.1:8080/"
|
||||
]
|
||||
},
|
||||
"https_proxy": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "Proxy server to use for HTTPS requests.\nFor more details, see the [forward proxy documentation](../../setup/forward_proxy.md).",
|
||||
"examples": [
|
||||
"http://USERNAME:PASSWORD@proxy.example.com:8080/"
|
||||
]
|
||||
},
|
||||
"no_proxy_hosts": {
|
||||
"type": "array",
|
||||
"description": "List of hosts, IP addresses, or IP ranges in CIDR format which should not use the proxy. Synapse will directly connect to these hosts.\nFor more details, see the [forward proxy documentation](../../setup/forward_proxy.md).",
|
||||
"examples": [
|
||||
[
|
||||
"master.hostname.example.com",
|
||||
"10.1.0.0/16",
|
||||
"172.30.0.0/16"
|
||||
]
|
||||
]
|
||||
},
|
||||
"dummy_events_threshold": {
|
||||
"type": "integer",
|
||||
"description": "Forward extremities can build up in a room due to networking delays between homeservers. Once this happens in a large room, calculation of the state of that room can become quite expensive. To mitigate this, once the number of forward extremities reaches a given threshold, Synapse will send an `org.matrix.dummy_event` event, which will reduce the forward extremities in the room.\n\nThis setting defines the threshold (i.e. number of forward extremities in the room) at which dummy events are sent.",
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -165,8 +165,20 @@ this is necessary is in corporate environments behind a DMZ (demilitarized zone)
|
||||
Synapse supports routing outbound HTTP(S) requests via a proxy. Only HTTP(S)
|
||||
proxy is supported, not SOCKS proxy or anything else.</p>
|
||||
<h2 id="configure"><a class="header" href="#configure">Configure</a></h2>
|
||||
<p>The <code>http_proxy</code>, <code>https_proxy</code>, <code>no_proxy</code> environment variables are used to
|
||||
specify proxy settings. The environment variable is not case sensitive.</p>
|
||||
<p>The proxy settings can be configured in the homeserver configuration file via
|
||||
<a href="../usage/configuration/config_documentation.html#http_proxy"><code>http_proxy</code></a>,
|
||||
<a href="../usage/configuration/config_documentation.html#https_proxy"><code>https_proxy</code></a>, and
|
||||
<a href="../usage/configuration/config_documentation.html#no_proxy_hosts"><code>no_proxy_hosts</code></a>.</p>
|
||||
<p><code>homeserver.yaml</code> example:</p>
|
||||
<pre><code class="language-yaml">http_proxy: http://USERNAME:PASSWORD@10.0.1.1:8080/
|
||||
https_proxy: http://USERNAME:PASSWORD@proxy.example.com:8080/
|
||||
no_proxy_hosts:
|
||||
- master.hostname.example.com
|
||||
- 10.1.0.0/16
|
||||
- 172.30.0.0/16
|
||||
</code></pre>
|
||||
<p>The proxy settings can also be configured via the <code>http_proxy</code>, <code>https_proxy</code>,
|
||||
<code>no_proxy</code> environment variables. The environment variable is not case sensitive.</p>
|
||||
<ul>
|
||||
<li><code>http_proxy</code>: Proxy server to use for HTTP requests.</li>
|
||||
<li><code>https_proxy</code>: Proxy server to use for HTTPS requests.</li>
|
||||
@@ -208,7 +220,7 @@ will apply blacklisting of IP addresses.</p>
|
||||
<li>phone-home stats</li>
|
||||
<li>recaptcha validation</li>
|
||||
<li>CAS auth validation</li>
|
||||
<li>OpenID Connect</li>
|
||||
<li>OpenID Connect (OIDC)</li>
|
||||
<li>Outbound federation</li>
|
||||
<li>Federation (checking public key revocation)</li>
|
||||
<li>Fetching public keys of other servers</li>
|
||||
@@ -217,7 +229,7 @@ will apply blacklisting of IP addresses.</p>
|
||||
<p>It will <strong>not be used</strong> for:</p>
|
||||
<ul>
|
||||
<li>Application Services</li>
|
||||
<li>Identity servers</li>
|
||||
<li>Matrix Identity servers</li>
|
||||
<li>In worker configurations
|
||||
<ul>
|
||||
<li>connections between workers</li>
|
||||
|
||||
@@ -659,6 +659,30 @@ shown.</p>
|
||||
ssh_pub_key_path: CONFDIR/id_rsa.pub
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="http_proxy"><a class="header" href="#http_proxy"><code>http_proxy</code></a></h3>
|
||||
<p><em>(string|null)</em> Proxy server to use for HTTP requests.
|
||||
For more details, see the <a href="../../setup/forward_proxy.html">forward proxy documentation</a>. There is no default for this option.</p>
|
||||
<p>Example configuration:</p>
|
||||
<pre><code class="language-yaml">http_proxy: http://USERNAME:PASSWORD@10.0.1.1:8080/
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="https_proxy"><a class="header" href="#https_proxy"><code>https_proxy</code></a></h3>
|
||||
<p><em>(string|null)</em> Proxy server to use for HTTPS requests.
|
||||
For more details, see the <a href="../../setup/forward_proxy.html">forward proxy documentation</a>. There is no default for this option.</p>
|
||||
<p>Example configuration:</p>
|
||||
<pre><code class="language-yaml">https_proxy: http://USERNAME:PASSWORD@proxy.example.com:8080/
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="no_proxy_hosts"><a class="header" href="#no_proxy_hosts"><code>no_proxy_hosts</code></a></h3>
|
||||
<p><em>(array)</em> List of hosts, IP addresses, or IP ranges in CIDR format which should not use the proxy. Synapse will directly connect to these hosts.
|
||||
For more details, see the <a href="../../setup/forward_proxy.html">forward proxy documentation</a>. There is no default for this option.</p>
|
||||
<p>Example configuration:</p>
|
||||
<pre><code class="language-yaml">no_proxy_hosts:
|
||||
- master.hostname.example.com
|
||||
- 10.1.0.0/16
|
||||
- 172.30.0.0/16
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h3 id="dummy_events_threshold"><a class="header" href="#dummy_events_threshold"><code>dummy_events_threshold</code></a></h3>
|
||||
<p><em>(integer)</em> Forward extremities can build up in a room due to networking delays between homeservers. Once this happens in a large room, calculation of the state of that room can become quite expensive. To mitigate this, once the number of forward extremities reaches a given threshold, Synapse will send an <code>org.matrix.dummy_event</code> event, which will reduce the forward extremities in the room.</p>
|
||||
<p>This setting defines the threshold (i.e. number of forward extremities in the room) at which dummy events are sent.</p>
|
||||
|
||||
Reference in New Issue
Block a user