This commit is contained in:
heeckhau
2025-05-05 20:55:18 +00:00
parent ef2fd481e5
commit 9fe825a2a2
5 changed files with 10 additions and 38 deletions

View File

@@ -229,24 +229,7 @@ You can verify the software attestation by visiting <code>https://notary.pse.dev
<p>To check the status of the notary server, visit the <code>healthcheck</code> endpoint at:
<code>https://notary.pse.dev/&lt;version&gt;/healthcheck</code></p>
<h3 id="websocket-proxy-server"><a class="header" href="#websocket-proxy-server">WebSocket Proxy Server</a></h3>
<p>Because web browsers don't have the ability to make TCP connections directly, TLSNotary requires a WebSocket proxy to set up TCP connections when it is used in a browser. To facilitate the exploration of TLSNotary and to run the examples easily, the TLSNotary team hosts a public WebSocket proxy server. This server can be used to access the following whitelisted domains:</p>
<pre><code>api.twitter.com:443
twitter.com:443
gateway.reddit.com:443
reddit.com:443
swapi.dev:443
api.x.com:443
x.com:443
discord.com:443
connect.garmin.com:443
uber.com:443
riders.uber.com:443
m.uber.com:443
wise.com:443
coinbase.com:443
accounts.coinbase.com:443
www.agoda.com:443
</code></pre>
<p>Because web browsers don't have the ability to make TCP connections directly, TLSNotary requires a WebSocket proxy to set up TCP connections when it is used in a browser. To facilitate the exploration of TLSNotary and to run the examples easily, the TLSNotary team hosts a public WebSocket proxy server. Note that this proxy only supports a predefined set of domains. You can view the full list of supported domains in the <a href="https://github.com/privacy-scaling-explorations/tlsn-infra/blob/main/docker/websockify/websockify_config">websockify configuration file</a>.</p>
<p>You can utilize this WebSocket proxy with the following syntax:</p>
<pre><code>wss://notary.pse.dev/proxy?token=&lt;domain&gt;
</code></pre>

View File

@@ -477,6 +477,9 @@ cargo run --release -- --tls-enabled false
<li>Enter <code>wss://notary.pse.dev/proxy</code> as <strong>proxy API</strong></li>
<li>Click <strong>Save</strong></li>
</ol>
<blockquote>
<p>⚠️ <strong>Note:</strong> The TLSNotary hosted proxy only supports a predefined set of domains. You can view the full list of supported domains in the <a href="https://github.com/privacy-scaling-explorations/tlsn-infra/blob/main/docker/websockify/websockify_config">websockify configuration file</a>.</p>
</blockquote>
<p>To run your own websocket proxy <strong>locally</strong>, run:</p>
<ol>
<li>Install <a href="https://github.com/sile/wstcp">wstcp</a>:</li>
@@ -615,24 +618,7 @@ You can verify the software attestation by visiting <code>https://notary.pse.dev
<p>To check the status of the notary server, visit the <code>healthcheck</code> endpoint at:
<code>https://notary.pse.dev/&lt;version&gt;/healthcheck</code></p>
<h3 id="websocket-proxy-server"><a class="header" href="#websocket-proxy-server">WebSocket Proxy Server</a></h3>
<p>Because web browsers don't have the ability to make TCP connections directly, TLSNotary requires a WebSocket proxy to set up TCP connections when it is used in a browser. To facilitate the exploration of TLSNotary and to run the examples easily, the TLSNotary team hosts a public WebSocket proxy server. This server can be used to access the following whitelisted domains:</p>
<pre><code>api.twitter.com:443
twitter.com:443
gateway.reddit.com:443
reddit.com:443
swapi.dev:443
api.x.com:443
x.com:443
discord.com:443
connect.garmin.com:443
uber.com:443
riders.uber.com:443
m.uber.com:443
wise.com:443
coinbase.com:443
accounts.coinbase.com:443
www.agoda.com:443
</code></pre>
<p>Because web browsers don't have the ability to make TCP connections directly, TLSNotary requires a WebSocket proxy to set up TCP connections when it is used in a browser. To facilitate the exploration of TLSNotary and to run the examples easily, the TLSNotary team hosts a public WebSocket proxy server. Note that this proxy only supports a predefined set of domains. You can view the full list of supported domains in the <a href="https://github.com/privacy-scaling-explorations/tlsn-infra/blob/main/docker/websockify/websockify_config">websockify configuration file</a>.</p>
<p>You can utilize this WebSocket proxy with the following syntax:</p>
<pre><code>wss://notary.pse.dev/proxy?token=&lt;domain&gt;
</code></pre>

View File

@@ -185,6 +185,9 @@
<li>Enter <code>wss://notary.pse.dev/proxy</code> as <strong>proxy API</strong></li>
<li>Click <strong>Save</strong></li>
</ol>
<blockquote>
<p>⚠️ <strong>Note:</strong> The TLSNotary hosted proxy only supports a predefined set of domains. You can view the full list of supported domains in the <a href="https://github.com/privacy-scaling-explorations/tlsn-infra/blob/main/docker/websockify/websockify_config">websockify configuration file</a>.</p>
</blockquote>
<p>To run your own websocket proxy <strong>locally</strong>, run:</p>
<ol>
<li>Install <a href="https://github.com/sile/wstcp">wstcp</a>:</li>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long