Deployed 746bf18 with MkDocs version: 1.6.1

This commit is contained in:
2026-09-26 00:15:33 +00:00
parent 1fbec8c9d5
commit 532ceaba46
5 changed files with 64 additions and 57 deletions
+23 -15
View File
@@ -2698,15 +2698,19 @@ them in this order.</p>
<ol> <ol>
<li><strong>An explicit URI.</strong> unshackle uses anything shaped like <code>http://...</code>, <li><strong>An explicit URI.</strong> unshackle uses anything shaped like <code>http://...</code>,
<code>https://...</code>, or a <code>socks...</code> URI exactly as you give it. unshackle logs <code>https://...</code>, or a <code>socks...</code> URI exactly as you give it. unshackle logs
<code>Using explicit Proxy: ...</code> and does no lookup.</li> <code>Using explicit Proxy: ...</code> and does no lookup. A <code>host:port</code> value such as
<code>localhost:8080</code> is also an explicit proxy.</li>
<li><strong>A provider-prefixed query</strong>: <code>provider:query</code>, for example <code>nordvpn:us</code> or <li><strong>A provider-prefixed query</strong>: <code>provider:query</code>, for example <code>nordvpn:us</code> or
<code>gluetun:windscribe:us</code>. unshackle finds the proxy provider whose name matches <code>gluetun:windscribe:us</code>. unshackle finds the proxy provider whose name matches
the prefix (case-insensitive). It then asks <em>only</em> that proxy provider to find a the prefix (case-insensitive). It then asks <em>only</em> that proxy provider to find a
proxy for the remainder. If unshackle loads no such proxy provider, or if that proxy for the remainder. If unshackle loads no such proxy provider, or if that
proxy provider returns no proxy, the download errors.</li> proxy provider returns no proxy, the download errors.</li>
<li><strong>A bare query</strong>: a region like <code>us</code>, <code>gb</code>, <code>us:seattle</code>, or <code>us1234</code>. unshackle <li><strong>A bare query</strong>: a region like <code>us</code>, <code>gb</code>, or <code>us1234</code>. unshackle asks each
asks each loaded proxy provider <strong>in order</strong> and uses the first proxy any of them loaded proxy provider <strong>in order</strong> and uses the first proxy any of them returns. A
returns.</li> bare city query such as <code>us:seattle</code> does not work: unshackle reads <code>us</code> as a proxy
provider name. Use the proxy provider prefix, for example <code>nordvpn:us:seattle</code>.
If no proxy provider has a proxy for the query, unshackle stops with
<code>No proxy provider had a proxy for &lt;query&gt;</code> and does not continue without a proxy.</li>
</ol> </ol>
<p>unshackle compares the query against a region grammar: a country or location code of two <p>unshackle compares the query against a region grammar: a country or location code of two
to four letters, with an optional <code>_code</code> part (<code>res_yyz</code>), then an optional server to four letters, with an optional <code>_code</code> part (<code>res_yyz</code>), then an optional server
@@ -3363,7 +3367,7 @@ country-code confusion that <code>uk</code> invites.</p>
<td>The specific server <code>us1234</code>.</td> <td>The specific server <code>us1234</code>.</td>
</tr> </tr>
<tr> <tr>
<td><code>us:seattle</code></td> <td><code>nordvpn:us:seattle</code></td>
<td>A recommended server in Seattle.</td> <td>A recommended server in Seattle.</td>
</tr> </tr>
<tr> <tr>
@@ -3476,19 +3480,23 @@ have non-contiguous IDs like <code>#203</code>, <code>#813</code>, and so on. Co
previous run's log line (e.g. <code>DE#203</code>) instead.</p> previous run's log line (e.g. <code>DE#203</code>) instead.</p>
</div> </div>
<h2 id="hola">Hola<a class="headerlink" href="#hola" title="Permanent link">&para;</a></h2> <h2 id="hola">Hola<a class="headerlink" href="#hola" title="Permanent link">&para;</a></h2>
<p>Hola requires no configuration at all. It uses the <p>Hola requires no configuration at all. It uses the <code>hola-proxy</code> binary, and
<a href="https://github.com/Snawoot/hola-proxy"><code>hola-proxy</code></a> binary, and <strong>auto-loads</strong> whenever <strong>auto-loads</strong> whenever that binary is found on your <code>PATH</code>. If you query Hola but the
that binary is found on your <code>PATH</code>. If you query Hola but the binary is missing, the binary is missing, the proxy provider raises an error that tells you to install it.</p>
proxy provider raises an error that tells you to install it.</p> <p>The <code>hola-proxy</code> GitHub repository is no longer online, so build the binary with Go. The
<div class="language-shell highlight"><span class="filename">Install hola-proxy, then just query a country</span><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--proxy<span class="w"> </span>hola:us<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span> Go module proxy still has the source for version 1.18.2. <code>go install</code> puts the binary in
<code>$(go env GOPATH)/bin</code>, which must be on your <code>PATH</code>.</p>
<div class="language-shell highlight"><span class="filename">Build hola-proxy, then query a country</span><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>go<span class="w"> </span>install<span class="w"> </span>github.com/Snawoot/hola-proxy@v1.18.2
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--proxy<span class="w"> </span>hola:us<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div> </span></code></pre></div>
<p><strong>Query forms:</strong> a two-letter country code (e.g. <code>us</code>, <code>gb</code>). unshackle asks <code>hola-proxy</code> <p><strong>Query forms:</strong> a two-letter country code (e.g. <code>us</code>, <code>gb</code>). unshackle asks <code>hola-proxy</code>
for available proxies in that country and picks one at random, returning an HTTP proxy.</p> for available proxies in that country and picks one at random, returning an HTTP proxy.</p>
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Temporary bans</p> <p class="admonition-title">Temporary bans</p>
<p>Hola's free tier can rate-limit or temporarily ban you if queried too aggressively. If <p>Hola's free tier can rate-limit or temporarily ban you if queried too aggressively. If
you see a <em>temporary ban detected</em> error, wait before retrying. Hola currently uses you see a <em>temporary ban detected</em> error, wait before retrying. While a ban is active,
only datacenter proxies.</p> <code>hola-proxy</code> does not stop, so unshackle waits 30 seconds and then reports the ban.
Hola currently uses only datacenter proxies.</p>
</div> </div>
<h2 id="surfshark">Surfshark<a class="headerlink" href="#surfshark" title="Permanent link">&para;</a></h2> <h2 id="surfshark">Surfshark<a class="headerlink" href="#surfshark" title="Permanent link">&para;</a></h2>
<p>Surfshark, like NordVPN, uses <strong>Service Credentials</strong> rather than your login. Make <p>Surfshark, like NordVPN, uses <strong>Service Credentials</strong> rather than your login. Make
@@ -3533,8 +3541,8 @@ fall back to the <code>us</code> entry.</p>
</table> </table>
<p>unshackle ignores case, spaces, hyphens and accents in a city name, so <code>us:new-york</code> <p>unshackle ignores case, spaces, hyphens and accents in a city name, so <code>us:new-york</code>
matches New York. A city also matches the start of a longer name: <code>de:frankfurt</code> matches matches New York. A city also matches the start of a longer name: <code>de:frankfurt</code> matches
Frankfurt am Main. A bare <code>us</code> also reaches Surfshark, but a bare <code>us-bos</code> or Frankfurt am Main. A bare <code>us</code> also reaches Surfshark. A bare <code>us-bos</code> can stop at a
<code>us:seattle</code> can stop at a proxy provider earlier in the order, so use the proxy provider earlier in the order, and a bare <code>us:seattle</code> does not work, so use the
<code>surfsharkvpn:</code> prefix for those forms.</p> <code>surfsharkvpn:</code> prefix for those forms.</p>
<p>The returned proxy is HTTPS on <strong>port 443</strong>.</p> <p>The returned proxy is HTTPS on <strong>port 443</strong>.</p>
<h2 id="windscribe">Windscribe<a class="headerlink" href="#windscribe" title="Permanent link">&para;</a></h2> <h2 id="windscribe">Windscribe<a class="headerlink" href="#windscribe" title="Permanent link">&para;</a></h2>
@@ -3569,7 +3577,7 @@ sure that a username and a password are present (there is no 48-character rule).
<td>A specific numbered server.</td> <td>A specific numbered server.</td>
</tr> </tr>
<tr> <tr>
<td><code>us:seattle</code></td> <td><code>windscribevpn:us:seattle</code></td>
<td>A random server in Seattle.</td> <td>A random server in Seattle.</td>
</tr> </tr>
</tbody> </tbody>
+2 -3
View File
@@ -2345,9 +2345,8 @@ for the full proxy provider guide. Recognised proxy providers and their exit por
</table> </table>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Provider loading differs between CLI and REST server</p> <p class="admonition-title">Provider loading differs between CLI and REST server</p>
<p>The <code>dl</code> CLI loads all providers, including <code>windscribevpn</code> and <code>gluetun</code>. The REST API / <p>The <code>dl</code> CLI loads all providers, including <code>gluetun</code>. The REST API / remote-client path
remote-client path uses a separate resolver that does <strong>not</strong> load <code>windscribevpn</code> or does <strong>not</strong> load <code>gluetun</code>, because it starts a local Docker container. ExpressVPN and ProtonVPN also auto-load when their cached session exists, and Hola
<code>gluetun</code>. ExpressVPN and ProtonVPN also auto-load when their cached session exists, and Hola
auto-loads whenever the <code>hola-proxy</code> binary is present.</p> auto-loads whenever the <code>hola-proxy</code> binary is present.</p>
</div> </div>
File diff suppressed because one or more lines are too long
+38 -38
View File
@@ -2,154 +2,154 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>https://docs.unshackle.dev/</loc> <loc>https://docs.unshackle.dev/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc> <loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc> <loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/dashboard/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/dashboard/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc> <loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc> <loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc> <loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc> <loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc> <loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc> <loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc> <loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc> <loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc> <loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc> <loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc> <loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc> <loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc> <loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc> <loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc> <loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc> <loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc> <loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc> <loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc> <loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc> <loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc> <loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc> <loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc> <loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc> <loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc> <loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc> <loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc> <loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
<url> <url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc> <loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-09-25</lastmod> <lastmod>2026-09-26</lastmod>
</url> </url>
</urlset> </urlset>
BIN
View File
Binary file not shown.