Skip to content

Commit

Permalink
Deployed 763dd33 to master with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 20, 2024
1 parent c2c4044 commit 1b7aaa8
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 8 deletions.
40 changes: 37 additions & 3 deletions master/configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#blackout-times" class="md-nav__link">
<span class="md-ellipsis">
Blackout Times
</span>
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -799,6 +808,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#blackout-times" class="md-nav__link">
<span class="md-ellipsis">
Blackout Times
</span>
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -915,11 +933,17 @@ <h2 id="general-configuration">General Configuration</h2>
</tr>
<tr>
<td><code>DOLCE_EVENTS</code></td>
<td>Container Action[] <sup id="fnref:3"><a class="footnote-ref" href="#fn:3">3</a></sup></td>
<td>Container Action[] <sup id="fnref2:3"><a class="footnote-ref" href="#fn:3">3</a></sup></td>
<td>All available</td>
<td>See <a href="#event-selection">Event Selection</a></td>
</tr>
<tr>
<td><code>DOLCE_BLACKOUT_WINDOWS</code></td>
<td>[PlainTime, PlainTime][] <sup id="fnref:3"><a class="footnote-ref" href="#fn:3">3</a></sup></td>
<td>[]</td>
<td>See <a href="#event-selection">Blackout Times</a></td>
</tr>
<tr>
<td><code>DOLCE_MIN_TIMEOUT</code></td>
<td><code>number</code></td>
<td>10</td>
Expand Down Expand Up @@ -1037,11 +1061,21 @@ <h2 id="event-selection">Event Selection</h2>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dangrie158/dolce</span>
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
<span class="w"> </span><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="nt">DOLCE_EVENTS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">die:start</span>
<span class="w"> </span><span class="nt">DOLCE_EVENTS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">die,start</span>
</code></pre></div>
<p>This is the list of all available events:</p>
<p><code>attach</code>, <code>commit</code>, <code>copy</code>, <code>create</code>, <code>destroy</code>, <code>detach</code>, <code>die</code>, <code>exec_create</code>, <code>exec_detach</code>, <code>exec_start</code>, <code>export</code>,
<code>health_status</code>, <code>kill</code>, <code>oom</code>, <code>pause</code>, <code>rename</code>, <code>resize</code>, <code>restart</code>, <code>start</code>, <code>stop</code>, <code>top</code>, <code>unpause</code>, <code>update</code>.</p>
<h2 id="blackout-times">Blackout Times</h2>
<p>You can specify a list of time ranges in which all events should be ignored. This is useful if you have a maintenance
window or if you regularly stop and start containers for some reason. The format is <code>HH:[MM[:SS]]-HH:[MM[:SS]]</code> and you
can specify multiple ranges by separating them with a comma.</p>
<div class="highlight"><pre><span></span><code><span class="nt">dolce</span><span class="p">:</span>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dangrie158/dolce</span>
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
<span class="w"> </span><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="nt">DOLCE_BLACKOUT_WINDOWS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">02:00-04:00,22:00-23:59</span>
</code></pre></div>
<h2 id="run-directory">Run Directory</h2>
<p>If you plan on using multiple instances of Dolce (e.g. to enable multiple configurations) make sure that if this is
mounted in a volume, no two different services access the same file.</p>
Expand Down Expand Up @@ -1071,7 +1105,7 @@ <h2 id="use-local-timezone-for-eventdates">Use Local Timezone for Eventdates</h2
<p><a href="https://github.com/search?q=repo%3Adangrie158/dolce%20SupervisorMode&amp;type=code">SupervisionMode</a>&#160;<a class="footnote-backref" href="#fnref:2" title="Jump back to footnote 2 in the text">&#8617;</a></p>
</li>
<li id="fn:3">
<p><a href="https://docs.docker.com/engine/api/v1.27/#tag/System/operation/SystemEvents">Container Action</a>&#160;<a class="footnote-backref" href="#fnref:3" title="Jump back to footnote 3 in the text">&#8617;</a></p>
<p><a href="https://docs.docker.com/engine/api/v1.27/#tag/System/operation/SystemEvents">Container Action</a>&#160;<a class="footnote-backref" href="#fnref:3" title="Jump back to footnote 3 in the text">&#8617;</a><a class="footnote-backref" href="#fnref2:3" title="Jump back to footnote 3 in the text">&#8617;</a></p>
</li>
</ol>
</div>
Expand Down
4 changes: 2 additions & 2 deletions master/notifiers/smtp/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ <h2 id="available-settings">Available Settings:</h2>
<td><code>SMTP_RECIPIENTS</code></td>
<td><code>string[]</code></td>
<td style="text-align: center;"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2c1.85 0 3.55.78 4.9 2.1l1.7-2.17 1.58 1.23-1.98 2.52C19.33 7.41 20 9.6 20 12c0 5.5-3.58 10-8 10-1.85 0-3.55-.78-4.9-2.1l-1.7 2.17-1.58-1.23 1.98-2.52C4.67 16.59 4 14.4 4 12 4 6.5 7.58 2 12 2m0 2c-3.31 0-6 3.58-6 8 0 1.73.41 3.33 1.11 4.64l8.56-10.97C14.66 4.62 13.38 4 12 4m0 16c3.31 0 6-3.58 6-8 0-1.73-.41-3.33-1.11-4.64L8.33 18.33C9.34 19.38 10.62 20 12 20"/></svg></span></td>
<td>A colon-separated list of recipient adresses</td>
<td>A comma-separated list of recipient adresses</td>
</tr>
<tr>
<td><code>SMTP_PORT</code></td>
Expand Down Expand Up @@ -790,7 +790,7 @@ <h2 id="example">Example</h2>
<span class="w"> </span><span class="nt">SMTP_HOSTNAME</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">smtp.example.com</span>
<span class="w"> </span><span class="nt">SMTP_USETLS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
<span class="w"> </span><span class="c1"># SMTP_PORT: 465 # (1)</span>
<span class="w"> </span><span class="nt">SMTP_RECIPIENTS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">[email protected]:[email protected]</span>
<span class="w"> </span><span class="nt">SMTP_RECIPIENTS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">[email protected],[email protected]</span>
<span class="w"> </span><span class="c1"># SMTP_USERNAME: # (2)</span>
<span class="w"> </span><span class="c1"># SMTP_PASSWORD:</span>
<span class="w"> </span><span class="nt">SMTP_FROM</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Dolce</span><span class="nv"> </span><span class="s">Container</span><span class="nv"> </span><span class="s">Monitor</span><span class="nv"> </span><span class="s">&lt;[email protected]&gt;&quot;</span>
Expand Down
4 changes: 2 additions & 2 deletions master/notifiers/telegram/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ <h2 id="available-settings">Available Settings:</h2>
<td><code>TELEGRAM_RECIPIENT_IDS</code></td>
<td><code>string[]</code></td>
<td><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2c1.85 0 3.55.78 4.9 2.1l1.7-2.17 1.58 1.23-1.98 2.52C19.33 7.41 20 9.6 20 12c0 5.5-3.58 10-8 10-1.85 0-3.55-.78-4.9-2.1l-1.7 2.17-1.58-1.23 1.98-2.52C4.67 16.59 4 14.4 4 12 4 6.5 7.58 2 12 2m0 2c-3.31 0-6 3.58-6 8 0 1.73.41 3.33 1.11 4.64l8.56-10.97C14.66 4.62 13.38 4 12 4m0 16c3.31 0 6-3.58 6-8 0-1.73-.41-3.33-1.11-4.64L8.33 18.33C9.34 19.38 10.62 20 12 20"/></svg></span></td>
<td>Colon-separated list of chat IDs</td>
<td>Comma-separated list of chat IDs</td>
</tr>
</tbody>
</table>
Expand All @@ -757,7 +757,7 @@ <h2 id="example">Example</h2>
<span class="w"> </span><span class="nt">volumes</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/var/run/docker.sock:/var/run/docker.sock</span>
<span class="w"> </span><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="nt">TELEGRAM_HTTP_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123456789123456:AABBCCDDEEFFGGHHIIJJKKLLMM</span>
<span class="w"> </span><span class="nt">TELEGRAM_HTTP_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123456789123456,AABBCCDDEEFFGGHHIIJJKKLLMM</span>
<span class="w"> </span><span class="nt">TELEGRAM_RECIPIENT_IDS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">12345678912:456789123</span>
</code></pre></div>
<h2 id="step-by-step">Step by Step:</h2>
Expand Down
2 changes: 1 addition & 1 deletion master/quickstart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -701,7 +701,7 @@ <h2 id="getting-started">Getting Started</h2>
<span class="w"> </span><span class="nt">DISCORD_WEBHOOK</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://ptb.discord.com/api/webhooks/&lt;YOUR_WEBHOOK&gt;</span>

<span class="w"> </span><span class="c1"># get notified via Telegram</span>
<span class="w"> </span><span class="nt">TELEGRAM_HTTP_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123456789123456:AABBCCDDEEFFGGHHIIJJKKLLMM</span>
<span class="w"> </span><span class="nt">TELEGRAM_HTTP_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123456789123456,AABBCCDDEEFFGGHHIIJJKKLLMM</span>
<span class="w"> </span><span class="nt">TELEGRAM_RECIPIENT_IDS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">12345678912:456789123</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span><span class="w"> </span><span class="c1"># (5)!</span>
</code></pre></div>
Expand Down

0 comments on commit 1b7aaa8

Please sign in to comment.