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

Deployed 3fd69e8 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-10-07 00:25:30 +00:00
parent 8ca9bd78df
commit ab7534754f
4 changed files with 51 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/rest-api/index.html
+12 -1
View File
@@ -2172,6 +2172,11 @@ how the <code>X-Secret-Key</code> header works.</p>
<td>Serve only the REST API, without the Widevine/PlayReady CDM HTTP endpoints.</td>
</tr>
<tr>
<td><code>--cdm-only</code></td>
<td>off</td>
<td>Serve only the Widevine/PlayReady CDM HTTP endpoints, plus <code>/api/health</code> and the dashboard. No REST API, no remote sessions, no Swagger UI. Cannot be combined with <code>--api-only</code> or <code>--remote-only</code>.</td>
</tr>
<tr>
<td><code>--no-widevine</code></td>
<td>off</td>
<td>Disable the Widevine CDM endpoints. Cannot be combined with <code>--api-only</code>.</td>
@@ -2219,7 +2224,7 @@ TLS-terminating reverse proxy (Caddy, nginx) in front for anything internet-faci
</div>
<h3 id="server-modes">Server modes<a class="headerlink" href="#server-modes" title="Permanent link">&para;</a></h3>
<p>The routes the server mounts depend on how you start the server:</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Default (CDM + REST)</label><label for="__tabbed_1_2"><code>--api-only</code></label><label for="__tabbed_1_3"><code>--remote-only</code></label></div>
<div class="tabbed-set tabbed-alternate" data-tabs="1:4"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><input id="__tabbed_1_4" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Default (CDM + REST)</label><label for="__tabbed_1_2"><code>--api-only</code></label><label for="__tabbed_1_3"><code>--remote-only</code></label><label for="__tabbed_1_4"><code>--cdm-only</code></label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<p>The server mounts both the pywidevine/pyplayready CDM endpoints and the full REST API.
@@ -2234,6 +2239,12 @@ Authentication uses the single configured API key (or none, with <code>--no-key<
and everything under <code>/api/session/*</code>). This mode implies <code>--api-only</code>, and the
interactive Swagger UI is <strong>not</strong> mounted.</p>
</div>
<div class="tabbed-block">
<p>The server mounts only the pywidevine and pyplayready CDM endpoints. Under <code>/api/</code> it
answers <code>/api/health</code> and, when <code>serve.dashboard.key</code> is set, the dashboard. It does not
start the remote session store, the service refresh loop or the Swagger UI. Use it for a
CDM backend that a proxy reaches on its own hostname.</p>
</div>
</div>
</div>
<h2 id="base-url">Base URL<a class="headerlink" href="#base-url" title="Permanent link">&para;</a></h2>