Skip to content

Commit 0f289e9

Browse files
committed
1 parent 9e40181 commit 0f289e9

9 files changed

Lines changed: 417 additions & 136 deletions

File tree

fa/features/secrets/index.html

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1408,15 +1408,20 @@ <h2 id="secret-labels">Secret Labels<a class="headerlink" href="#secret-labels"
14081408
<p>CLI:</p>
14091409
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>./teleproxy<span class="w"> </span>...<span class="w"> </span>-S<span class="w"> </span>cafe...ab:family<span class="w"> </span>-S<span class="w"> </span>dead...ef:friends
14101410
</code></pre></div>
1411+
<p>Installer:</p>
1412+
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nv">SECRET_1</span><span class="o">=</span>cafe...ab<span class="w"> </span><span class="nv">SECRET_LABEL_1</span><span class="o">=</span>family<span class="w"> </span><span class="se">\</span>
1413+
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nv">SECRET_2</span><span class="o">=</span>dead...ef<span class="w"> </span><span class="nv">SECRET_LABEL_2</span><span class="o">=</span>friends<span class="w"> </span><span class="se">\</span>
1414+
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span>curl<span class="w"> </span>-sSL<span class="w"> </span>.../install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
1415+
</code></pre></div>
14111416
<p>Docker:</p>
1412-
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># Inline labels</span>
1413-
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nv">SECRET</span><span class="o">=</span>cafe...ab:family,dead...ef:friends
1414-
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>
1415-
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="c1"># Or numbered</span>
1416-
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="nv">SECRET_1</span><span class="o">=</span>cafe...ab
1417-
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="nv">SECRET_LABEL_1</span><span class="o">=</span>family
1418-
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="nv">SECRET_2</span><span class="o">=</span>dead...ef
1419-
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="nv">SECRET_LABEL_2</span><span class="o">=</span>friends
1417+
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># Inline labels</span>
1418+
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="nv">SECRET</span><span class="o">=</span>cafe...ab:family,dead...ef:friends
1419+
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
1420+
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1"># Or numbered</span>
1421+
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="nv">SECRET_1</span><span class="o">=</span>cafe...ab
1422+
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="nv">SECRET_LABEL_1</span><span class="o">=</span>family
1423+
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="nv">SECRET_2</span><span class="o">=</span>dead...ef
1424+
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="nv">SECRET_LABEL_2</span><span class="o">=</span>friends
14201425
</code></pre></div>
14211426
<p>Labels appear in:</p>
14221427
<ul>
@@ -1428,19 +1433,24 @@ <h2 id="secret-labels">Secret Labels<a class="headerlink" href="#secret-labels"
14281433
<p>Label rules: max 32 chars, alphanumeric plus <code>_</code> and <code>-</code>.</p>
14291434
<h2 id="per-secret-connection-limits">Per-Secret Connection Limits<a class="headerlink" href="#per-secret-connection-limits" title="Permanent link">&para;</a></h2>
14301435
<p>Prevent a leaked secret from consuming all resources:</p>
1431-
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># CLI: append :LIMIT after the label</span>
1432-
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>./teleproxy<span class="w"> </span>...<span class="w"> </span>-S<span class="w"> </span>cafe...ab:family:1000<span class="w"> </span>-S<span class="w"> </span>dead...ef:public:200
1433-
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
1434-
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1"># Without a label</span>
1435-
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>./teleproxy<span class="w"> </span>...<span class="w"> </span>-S<span class="w"> </span>cafe...ab::500
1436+
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># CLI: append :LIMIT after the label</span>
1437+
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>./teleproxy<span class="w"> </span>...<span class="w"> </span>-S<span class="w"> </span>cafe...ab:family:1000<span class="w"> </span>-S<span class="w"> </span>dead...ef:public:200
1438+
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
1439+
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1"># Without a label</span>
1440+
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>./teleproxy<span class="w"> </span>...<span class="w"> </span>-S<span class="w"> </span>cafe...ab::500
1441+
</code></pre></div>
1442+
<p>Installer:</p>
1443+
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nv">SECRET_1</span><span class="o">=</span>cafe...ab<span class="w"> </span><span class="nv">SECRET_LABEL_1</span><span class="o">=</span>family<span class="w"> </span><span class="nv">SECRET_LIMIT_1</span><span class="o">=</span><span class="m">1000</span><span class="w"> </span><span class="se">\</span>
1444+
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="nv">SECRET_2</span><span class="o">=</span>dead...ef<span class="w"> </span><span class="nv">SECRET_LABEL_2</span><span class="o">=</span>public<span class="w"> </span><span class="nv">SECRET_LIMIT_2</span><span class="o">=</span><span class="m">200</span><span class="w"> </span><span class="se">\</span>
1445+
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span>curl<span class="w"> </span>-sSL<span class="w"> </span>.../install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
14361446
</code></pre></div>
14371447
<p>Docker:</p>
1438-
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># Environment variables</span>
1439-
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="nv">SECRET_LIMIT_1</span><span class="o">=</span><span class="m">1000</span>
1440-
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="nv">SECRET_LIMIT_2</span><span class="o">=</span><span class="m">200</span>
1441-
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a>
1442-
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="c1"># Inline</span>
1443-
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="nv">SECRET</span><span class="o">=</span>cafe...ab:family:1000,dead...ef:public:200
1448+
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="c1"># Environment variables</span>
1449+
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="nv">SECRET_LIMIT_1</span><span class="o">=</span><span class="m">1000</span>
1450+
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="nv">SECRET_LIMIT_2</span><span class="o">=</span><span class="m">200</span>
1451+
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a>
1452+
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="c1"># Inline</span>
1453+
<a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a><span class="nv">SECRET</span><span class="o">=</span>cafe...ab:family:1000,dead...ef:public:200
14441454
</code></pre></div>
14451455
<p>When the limit is reached:</p>
14461456
<ul>

0 commit comments

Comments
 (0)