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 aec45e3 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-09-16 21:08:00 +00:00
parent 76df4106d3
commit 45f076eac8
11 changed files with 1043 additions and 911 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/creating-a-service/index.html
+12
View File
@@ -2450,6 +2450,11 @@ Click <code>cli</code> entry point plus three abstract methods.</p>
<td>IP region codes the service requires. Empty = no geofence. unshackle treats the <strong>first</strong> entry as the main region for auto-proxy.</td>
</tr>
<tr>
<td><code>GEOBLOCK</code></td>
<td><code>tuple[str, ...]</code></td>
<td>IP region codes where the service refuses to work. Every other region is allowed. Default <code>()</code>.</td>
</tr>
<tr>
<td><code>VAULT_TAG</code></td>
<td><code>Optional[str]</code></td>
<td>Overrides the key-vault namespace so sibling services can share one vault. Default <code>None</code> (use the service's own tag).</td>
@@ -2486,10 +2491,17 @@ subtitle work for services that never carry subtitles. Leave it off otherwise.</
<p><code>GEOFENCE</code> drives an automatic proxy: on startup, if you did not pass an
explicit <code>--proxy</code>, the base class does a live IP check and, if your region is
blocked, fetches a proxy to <code>GEOFENCE[0]</code> from your configured proxy providers.</p>
<p><code>GEOBLOCK</code> is the negative form: the service works everywhere except the listed
regions. With no <code>GEOFENCE</code> to name a main region, a <code>GEOBLOCK</code> hit stops the run
with a "not available in your region" error; pass <code>--proxy</code> yourself.</p>
<div class="language-python highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">EXAMPLE</span><span class="p">(</span><span class="n">Service</span><span class="p">):</span>
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> <span class="n">ALIASES</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"EX"</span><span class="p">,</span> <span class="s2">"DOMAIN"</span><span class="p">)</span>
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> <span class="n">GEOFENCE</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"US"</span><span class="p">,</span> <span class="s2">"UK"</span><span class="p">)</span>
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> <span class="n">VAULT_TAG</span> <span class="o">=</span> <span class="s2">"DIFFERENT_NAME"</span>
</span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>
</span><span id="__span-3-6"><a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
</span><span id="__span-3-7"><a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="k">class</span><span class="w"> </span><span class="nc">WORLDWIDE</span><span class="p">(</span><span class="n">Service</span><span class="p">):</span>
</span><span id="__span-3-8"><a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a> <span class="n">GEOBLOCK</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"GB"</span><span class="p">,)</span>
</span></code></pre></div>
<h3 id="what-service__init__-wires-up">What <code>Service.__init__</code> wires up<a class="headerlink" href="#what-service__init__-wires-up" title="Permanent link">&para;</a></h3>
<p>When you call <code>super().__init__(ctx)</code>, the base class sets up the attributes you