mirror of
https://github.com/unshackle-dl/unshackle.git
synced 2026-11-12 20:15:10 +00:00
Deployed dcc1c8a with MkDocs version: 1.6.1
This commit is contained in:
@@ -3078,7 +3078,7 @@
|
||||
<td>string</td>
|
||||
<td>no</td>
|
||||
<td><code>null</code></td>
|
||||
<td>Proxy URI or country code.</td>
|
||||
<td>Full proxy URI, or a country code when the API key has <code>server_proxy</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>no_proxy</code></td>
|
||||
@@ -3186,7 +3186,7 @@
|
||||
<td><code>proxy</code></td>
|
||||
<td>string</td>
|
||||
<td>no</td>
|
||||
<td>Proxy URI or country code.</td>
|
||||
<td>Full proxy URI, or a country code when the API key has <code>server_proxy</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>no_proxy</code></td>
|
||||
@@ -3699,7 +3699,7 @@ ignore it safely. See <a href="../../creating-a-service/#split-episodes">Split e
|
||||
<td><code>proxy</code> / <code>no_proxy</code> / <code>no_proxy_download</code></td>
|
||||
<td>string / bool / bool</td>
|
||||
<td><code>null</code> / <code>false</code> / <code>false</code></td>
|
||||
<td>Proxy controls.</td>
|
||||
<td>Proxy controls. <code>proxy</code> must be a full proxy URI unless the API key has <code>server_proxy</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>no_folder</code> / <code>no_source</code> / <code>no_mux</code></td>
|
||||
@@ -4442,6 +4442,7 @@ an HTTP caller would be remote code execution. You configure post-scripts only i
|
||||
</span></code></pre></div>
|
||||
<h3 id="post-apisessioncreate"><code>POST /api/session/create</code><a class="headerlink" href="#post-apisessioncreate" title="Permanent link">¶</a></h3>
|
||||
<p>Make a remote session for a service and title. Authentication runs asynchronously in the background. This call returns immediately with <code>status: "authenticating"</code>, and you then poll the prompt endpoint. The body accepts <code>service</code> and <code>title_id</code> (both required). It also accepts a broad set of optional keys, because the body allows <code>additionalProperties</code>. These are <code>credentials</code> (<code>{username, password, extra?}</code>), <code>cookies</code> (base64 of zlib-compressed Netscape cookie file), <code>proxy</code>, <code>no_proxy</code>, <code>profile</code>, <code>cache</code> (map of forwarded cache files), <code>client_region</code>, <code>cdm_type</code>, <code>range_</code>, <code>vcodec</code>, <code>quality</code>, <code>best_available</code>, and any service CLI options.</p>
|
||||
<p>The <code>proxy</code> value must be a full proxy URI, unless the operator gives your API key <code>server_proxy</code> in the <code>serve.users</code> config. Without it, the server does not resolve country codes with its own proxy providers. It rejects the request with <code>INVALID_PROXY</code> when no <code>proxy</code> is set and the reported <code>client_region</code> differs from the server's region. A request that reports no <code>client_region</code> is not blocked. Pass <code>proxy</code> with your own proxy, or <code>no_proxy</code> to accept the server's own connection. With <code>server_proxy</code>, the server resolves a country code and picks a proxy for your <code>client_region</code> itself.</p>
|
||||
<div class="tabbed-set tabbed-alternate" data-tabs="18:1"><input checked="checked" id="__tabbed_18_1" name="__tabbed_18" type="radio" /><div class="tabbed-labels"><label for="__tabbed_18_1">Response <code>200</code></label></div>
|
||||
<div class="tabbed-content">
|
||||
<div class="tabbed-block">
|
||||
|
||||
@@ -2454,7 +2454,14 @@ server does not have to prompt:</p>
|
||||
<li>Local <strong>credentials</strong> for the service/profile (<code>{username, password, extra?}</code>)</li>
|
||||
<li>Local <strong>cookies</strong>, compressed and base64-encoded</li>
|
||||
<li>A resolved <strong>proxy</strong>, or, if you did not set one, your detected
|
||||
<strong>client region</strong> so the server can auto-proxy to match it</li>
|
||||
<strong>client region</strong>. A client that reports no region is not blocked. The
|
||||
proxy must be a full proxy URI unless the operator gives your API key
|
||||
<code>server_proxy</code>. Without <code>server_proxy</code> the server does not resolve country
|
||||
codes with its own proxy providers, and it rejects the remote session when
|
||||
it sits in a different region from the reported one, asking the client to
|
||||
pass <code>--proxy</code> with its own proxy, or <code>--no-proxy</code> to accept the server's
|
||||
own connection. With <code>server_proxy</code> the server picks a proxy that matches
|
||||
the client region itself</li>
|
||||
<li>Track-selection hints (<code>range_</code>, <code>vcodec</code>, <code>quality</code>, <code>best_available</code>) so
|
||||
the server fetches the right manifests</li>
|
||||
<li>Your local per-service <strong>cache files</strong> (e.g. refreshed tokens)</li>
|
||||
|
||||
+523
-513
File diff suppressed because it is too large
Load Diff
@@ -2272,6 +2272,16 @@ client configured with <code>server_cdm: true</code> to license with its own loc
|
||||
client that asks anyway gets a <code>FORBIDDEN</code> error. Because a download job always licenses with the server's CDM,
|
||||
an API key without <code>server_cdm</code> for that service also cannot submit or retry <code>/api/download</code>
|
||||
jobs. Keys that have no <code>users</code> entry, such as <code>api_secret</code>, keep server CDM access.</p>
|
||||
<p><code>server_proxy</code> decides whether that API key may use the proxy providers the server has
|
||||
configured. There is no implicit access: only the boolean <code>true</code> on the API key's <code>users</code> entry
|
||||
grants it, and an API key without a <code>users</code> entry has no access either. Without the opt-in the
|
||||
server never spends its own proxy subscriptions on a remote client: not to resolve a country code
|
||||
in <code>proxy</code>, not to match the client's region, and not for a service geofence. This applies to
|
||||
remote sessions, search, title lists, and <code>/api/download</code> jobs alike. Such a client must send a
|
||||
full proxy URI, or <code>no_proxy</code> to accept the server's own connection. Set <code>server_proxy: true</code>
|
||||
to let that API key send a country code or a <code>provider:country</code> value, and to let the server
|
||||
pick a proxy for the client's region and for a service geofence. The client reports its own
|
||||
region; a client that reports none is not blocked.</p>
|
||||
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nt">serve</span><span class="p">:</span>
|
||||
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="nt">api_secret</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">change-me</span>
|
||||
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="nt">remote_only</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
@@ -2288,6 +2298,7 @@ jobs. Keys that have no <code>users</code> entry, such as <code>api_secret</code
|
||||
</span><span id="__span-2-14"><a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="w"> </span><span class="nt">c9d0e1f2</span><span class="p">:</span>
|
||||
</span><span id="__span-2-15"><a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a><span class="w"> </span><span class="nt">services</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">EXAMPLE1</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">EXAMPLE2</span><span class="p p-Indicator">]</span>
|
||||
</span><span id="__span-2-16"><a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="w"> </span><span class="nt">server_cdm</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">EXAMPLE1</span><span class="p p-Indicator">]</span><span class="w"> </span><span class="c1"># the server licenses only EXAMPLE1; EXAMPLE2 needs a local CDM</span>
|
||||
</span><span id="__span-2-17"><a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a><span class="w"> </span><span class="nt">server_proxy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># this key may also use the server's proxy providers</span>
|
||||
</span></code></pre></div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title"><code>dl</code> keys inside <code>serve</code></p>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user