kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-13 12:35:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 83514d1 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-10-24 02:23:34 +00:00
parent e7481646f7
commit cafc0c20b8
8 changed files with 676 additions and 681 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/rest-api/authentication/index.html
+1 -1
View File
@@ -2509,7 +2509,7 @@
<div class="admonition warning">
<p class="admonition-title">The server will not start without a key</p>
<p>If you start <code>unshackle serve</code> with no <code>api_secret</code> configured, and you have <em>not</em> passed <code>--no-key</code>, the command fails immediately with:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>API secret key is not configured. Please add 'api_secret' to the 'serve' section in your config.
<div class="language-text highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>No 'api_secret' in the 'serve' section of your config
</span></code></pre></div>
<p>Choose a long, unpredictable value. The API key is the only thing standing between the internet and your CDM and download endpoints.</p>
</div>
dev/rest-api/remote-sessions/index.html
+1 -1
View File
@@ -3173,7 +3173,7 @@ remote session API and a good template for any client.</p>
<hr />
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h2>
<div class="admonition example">
<p class="admonition-title">\"Could not connect to remote server ... Is it running?\"</p>
<p class="admonition-title">\"Could not connect to remote server at ...\"</p>
<p>The client could not reach the URL. Make sure that <code>unshackle serve</code> operates on
the server, the <code>url</code>/port in <code>remote_services</code> are correct (default port <code>8786</code>),
and any firewall or reverse proxy allows the connection.</p>
guide/proxies-and-vpn/index.html
+3 -3
View File
@@ -3339,8 +3339,7 @@ machine (a <code>remote_services</code> URL on <code>127.0.0.1</code>) can reach
<div class="admonition warning">
<p class="admonition-title">Docker is required</p>
<p>Gluetun needs a working <a href="https://docs.docker.com/get-docker/">Docker</a> installation on
your <code>PATH</code>. If Docker is not found, the proxy provider fails to load with an error linking
to the install docs. The container also needs the <code>NET_ADMIN</code> capability and access
your <code>PATH</code>. If Docker is not found, the proxy provider fails to load. The container also needs the <code>NET_ADMIN</code> capability and access
to <code>/dev/net/tun</code> to bring up the tunnel. unshackle requests both automatically.</p>
</div>
<h3 id="query-format">Query format<a class="headerlink" href="#query-format" title="Permanent link">&para;</a></h3>
@@ -3434,7 +3433,8 @@ credentials, and how your region aliases map onto Gluetun's server selectors.</p
<li><code>private_key</code> is <strong>always</strong> required.</li>
<li><code>surfshark</code>, <code>mullvad</code>, and <code>ivpn</code> also require <code>addresses</code>.</li>
<li><code>windscribe</code> additionally requires <strong>both</strong> <code>addresses</code> and <code>preshared_key</code>
(<code>preshared_key</code> may be an empty string, but the config key must be present).</li>
(<code>preshared_key</code> may be an empty string, but the config key must be present).
Get both from the <a href="https://windscribe.com/getconfig/wireguard">Windscribe WireGuard config generator</a>.</li>
<li>NordVPN and Proton VPN need only <code>private_key</code>.</li>
</ul>
</div>
guide/troubleshooting/index.html
+5
View File
@@ -2605,6 +2605,11 @@
<p><strong>Inspect:</strong> set <code>debug_requests: true</code> and operate unshackle with <code>-d</code> to show the underlying <code>urllib3</code> / <code>rnet</code> / <code>httpx</code> logs. In the JSON debug log, filter for <code>service_call</code> operations to see which request failed. If you use a proxy, also read <a href="../proxies-and-vpn/">Proxies &amp; VPN</a>.</p>
</div>
<div class="admonition example">
<p class="admonition-title">A segment download fails after every retry</p>
<p><strong>Symptom:</strong> the download stops with a line like <code>MaxRetriesError: GET &lt;host&gt; failed: RequestError (stream closed because of a broken pipe), gave up after 5 failed attempts over 30s</code>.</p>
<p><strong>Inspect:</strong> the connection to the CDN host dropped on every attempt. This is almost always the network, the VPN, or the proxy, not the service. Run the download again: unshackle keeps the segments it already has. Over HTTP/2, all segments share one connection, so one drop fails every segment in flight. Set <code>network.http1_only: true</code> (see <a href="../../reference/configuration/network/">Network &amp; proxy</a>) to spread them over separate connections. Operate unshackle with <code>-d</code> to see each retry as a <code>segment_retry</code> entry in the JSON debug log.</p>
</div>
<div class="admonition example">
<p class="admonition-title">The wrong titles/metadata keep coming back</p>
<p><strong>Symptom:</strong> a service returns outdated titles even after the source changed.</p>
<p><strong>Inspect:</strong> the title cache is likely serving stale data. Clear it with <code>unshackle env clear cache &lt;SERVICE&gt;</code>, or bypass it for one run using the <code>dl</code> no-cache / reset-cache options (see <a href="../downloading/">Downloading</a> and the <a href="../cli-reference/#dl">CLI Reference</a>).</p>
reference/api/service/index.html
+627 -637
View File
File diff suppressed because it is too large Load Diff
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+38 -38
View File
@@ -2,154 +2,154 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.unshackle.dev/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/dashboard/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-10-23</lastmod>
<lastmod>2026-10-24</lastmod>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.