Andreas/watchtower
1
0
Fork 0
mirror of https://github.com/containrrr/watchtower.git synced 2025-12-16 15:10:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deployed 40ab6fd with MkDocs version: 1.1.2

Browse source
This commit is contained in:
2021-01-10 10:32:13 +00:00
parent ad1d0546ca
commit c362b32912
32 changed files with 988 additions and 246 deletions
Download patch file Download diff file Expand all files Collapse all files

43
notifications/index.html
View file

@ -12,7 +12,7 @@
<link rel="canonical" href="http://containrrr.github.io/watchtower/notifications/">
<link rel="shortcut icon" href="../images/favicon.ico">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.2.3">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.2.4">
@ -20,10 +20,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.3b61ea93.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.15aa0b43.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.39b8e14a.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.75751829.min.css">
@ -445,6 +445,19 @@
</li>
<li class="md-nav__item">
<a href="../metrics/" class="md-nav__link">
Metrics
</a>
</li>
</ul>
</nav>
</div>
@ -553,13 +566,13 @@ The types of notifications to send are set by passing a comma-separated list of
</ul>
<blockquote>
<p>There is currently a <a href="https://github.com/spf13/viper/issues/380">bug</a> in Viper, which prevents comma-separated slices to be used when using the environment variable. A workaround is available where we instead put quotes around the environment variable value and replace the commas with spaces, as <code>WATCHTOWER_NOTIFICATIONS="slack msteams"</code></p>
<p>If you're a <code>docker-compose</code> user, make sure to specify environment variables' values in your <code>.yml</code> file without double quotes (<code>"</code>). </p>
<p>If you're a <code>docker-compose</code> user, make sure to specify environment variables' values in your <code>.yml</code> file without double quotes (<code>"</code>).</p>
<p>This prevents unexpected errors when watchtower starts.</p>
</blockquote>
<h2 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h2>
<ul>
<li><code>--notifications-level</code> (env. <code>WATCHTOWER_NOTIFICATIONS_LEVEL</code>): Controls the log level which is used for the notifications. If omitted, the default log level is <code>info</code>. Possible values are: <code>panic</code>, <code>fatal</code>, <code>error</code>, <code>warn</code>, <code>info</code>, <code>debug</code> or <code>trace</code>.</li>
<li>Watchtower will post a notification every time it is started. This behavior <a href="https://containrrr.github.io/watchtower/arguments/#without_sending_a_startup_message">can be changed</a> with an argument. </li>
<li>Watchtower will post a notification every time it is started. This behavior <a href="https://containrrr.github.io/watchtower/arguments/#without_sending_a_startup_message">can be changed</a> with an argument.</li>
</ul>
<h2 id="available_services">Available services<a class="headerlink" href="#available_services" title="Permanent link">&para;</a></h2>
<h3 id="email">Email<a class="headerlink" href="#email" title="Permanent link">&para;</a></h3>
@ -583,7 +596,7 @@ The types of notifications to send are set by passing a comma-separated list of
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_FROM</span><span class="o">=</span>fromaddress@gmail.com <span class="se">\</span>
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_TO</span><span class="o">=</span>toaddress@gmail.com <span class="se">\</span>
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_SERVER</span><span class="o">=</span>smtp.gmail.com <span class="se">\</span>
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PORT</span><span class="o">=</span><span class="m">587</span> <span class="se">\ </span>
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PORT</span><span class="o">=</span><span class="m">587</span> <span class="se">\</span>
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_SERVER_USER</span><span class="o">=</span>fromaddress@gmail.com <span class="se">\</span>
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PASSWORD</span><span class="o">=</span>app_password <span class="se">\</span>
-e <span class="nv">WATCHTOWER_NOTIFICATION_EMAIL_DELAY</span><span class="o">=</span><span class="m">2</span> <span class="se">\</span>
@ -591,16 +604,16 @@ The types of notifications to send are set by passing a comma-separated list of
</code></pre></div>
<p>The previous example assumes, that you already have an SMTP server up and running you can connect to. If you don't or you want to bring up watchtower with your own simple SMTP relay the following <code>docker-compose.yml</code> might be a good start for you.</p>
<p>The following example assumes, that your domain is called <code>your-domain.com</code> and that you are going to use a certificate valid for <code>smtp.your-domain.com</code>. This hostname has to be used as <code>WATCHTOWER_NOTIFICATION_EMAIL_SERVER</code> otherwise the TLS connection is going to fail with <code>Failed to send notification email</code> or <code>connect: connection refused</code>. We also have to add a network for this setup in order to add an alias to it. If you also want to enable DKIM or other features on the SMTP server, you will find more information at <a href="https://hub.docker.com/r/freinet/postfix-relay">freinet/postfix-relay</a>.</p>
<p>The following example assumes, that your domain is called <code>your-domain.com</code> and that you are going to use a certificate valid for <code>smtp.your-domain.com</code>. This hostname has to be used as <code>WATCHTOWER_NOTIFICATION_EMAIL_SERVER</code> otherwise the TLS connection is going to fail with <code>Failed to send notification email</code> or <code>connect: connection refused</code>. We also have to add a network for this setup in order to add an alias to it. If you also want to enable DKIM or other features on the SMTP server, you will find more information at <a href="https://hub.docker.com/r/freinet/postfix-relay">freinet/postfix-relay</a>.</p>
<p>Example including an SMTP relay:</p>
<div class="codehilite"><pre><span></span><code><span class="nn">---</span>
<span class="nt">version</span><span class="p">:</span> <span class="s">&quot;3.8&quot;</span>
<span class="nt">version</span><span class="p">:</span> <span class="s">&#39;3.8&#39;</span>
<span class="nt">services</span><span class="p">:</span>
<span class="nt">watchtower</span><span class="p">:</span>
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">containrrr/watchtower:latest</span>
<span class="nt">container_name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">watchtower</span>
<span class="nt">environment</span><span class="p">:</span>
<span class="nt">WATCHTOWER_MONITOR_ONLY</span><span class="p">:</span> <span class="s">&quot;true&quot;</span>
<span class="nt">WATCHTOWER_MONITOR_ONLY</span><span class="p">:</span> <span class="s">&#39;true&#39;</span>
<span class="nt">WATCHTOWER_NOTIFICATIONS</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">email</span>
<span class="nt">WATCHTOWER_NOTIFICATION_EMAIL_FROM</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">from-address@your-domain.com</span>
<span class="nt">WATCHTOWER_NOTIFICATION_EMAIL_TO</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">to-address@your-domain.com</span>
@ -622,9 +635,9 @@ The types of notifications to send are set by passing a comma-separated list of
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">25</span>
<span class="nt">environment</span><span class="p">:</span>
<span class="nt">MAILNAME</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">somename.your-domain.com</span>
<span class="nt">TLS_KEY</span><span class="p">:</span> <span class="s">&quot;/etc/ssl/domains/your-domain.com/your-domain.com.key&quot;</span>
<span class="nt">TLS_CRT</span><span class="p">:</span> <span class="s">&quot;/etc/ssl/domains/your-domain.com/your-domain.com.crt&quot;</span>
<span class="nt">TLS_CA</span><span class="p">:</span> <span class="s">&quot;/etc/ssl/domains/your-domain.com/intermediate.crt&quot;</span>
<span class="nt">TLS_KEY</span><span class="p">:</span> <span class="s">&#39;/etc/ssl/domains/your-domain.com/your-domain.com.key&#39;</span>
<span class="nt">TLS_CRT</span><span class="p">:</span> <span class="s">&#39;/etc/ssl/domains/your-domain.com/your-domain.com.crt&#39;</span>
<span class="nt">TLS_CA</span><span class="p">:</span> <span class="s">&#39;/etc/ssl/domains/your-domain.com/intermediate.crt&#39;</span>
<span class="nt">volumes</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">/etc/ssl/domains/your-domain.com/:/etc/ssl/domains/your-domain.com/:ro</span>
<span class="nt">networks</span><span class="p">:</span>
@ -687,7 +700,7 @@ The types of notifications to send are set by passing a comma-separated list of
</code></pre></div>
<p><code>-e WATCHTOWER_NOTIFICATION_GOTIFY_TOKEN</code> or <code>--notification-gotify-token</code> can also reference a file, in which case the contents of the file are used.</p>
<p>If you want to disable TLS verification for the Gotify instance, you can use either <code>-e WATCHTOWER_NOTIFICATION_GOTIFY_TLS_SKIP_VERIFY=true</code> or <code>--notification-gotify-tls-skip-verify</code>. </p>
<p>If you want to disable TLS verification for the Gotify instance, you can use either <code>-e WATCHTOWER_NOTIFICATION_GOTIFY_TLS_SKIP_VERIFY=true</code> or <code>--notification-gotify-tls-skip-verify</code>.</p>
<h3 id="containrrrshoutrrr"><a href="https://github.com/containrrr/shoutrrr">containrrr/shoutrrr</a><a class="headerlink" href="#containrrrshoutrrr" title="Permanent link">&para;</a></h3>
<p>To send notifications via shoutrrr, the following command-line options, or their corresponding environment variables, can be set:</p>
<ul>
@ -776,8 +789,8 @@ You can define multiple services by space separating the URLs. (See example belo
</div>
<script src="../assets/javascripts/vendor.08c56446.min.js"></script>
<script src="../assets/javascripts/bundle.6ced434e.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
<script src="../assets/javascripts/vendor.93c04032.min.js"></script>
<script src="../assets/javascripts/bundle.83e5331e.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
<script>
app = initialize({