CyberShell/backy
1
1
Fork 0
Code Issues 10 Pull Requests Packages Projects 1 Releases 20 Wiki Activity

update docs and CI config

Browse Source
This commit is contained in:
Andrew Woodlee
2024-11-20 00:08:16 -06:00
parent 2daf2f130d
commit b7d1be495e
41 changed files with 4072 additions and 2650 deletions
Download Patch File Download Diff File Expand all files Collapse all files

251
docs/public/config/command-lists/index.html
View File

@ -3,24 +3,24 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.110.0">
<meta name="generator" content="Relearn 5.11.2">
<meta name="generator" content="Hugo 0.135.0">
<meta name="generator" content="Relearn 5.16.2">
<meta name="description" content="This page tells you how to get started with Backy.
">
<title>Command Lists - A tool for commands</title>
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/auto-complete.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1676866111" rel="stylesheet">
<link href="/css/nucleus.css?1676866111" rel="stylesheet">
<link href="/css/fonts.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/theme.css?1676866111" rel="stylesheet">
<link href="/css/theme-auto.css?1676866111" rel="stylesheet" id="variant-style">
<link href="/css/ie.css?1676866111" rel="stylesheet">
<link href="/css/variant.css?1676866111" rel="stylesheet">
<link href="/css/print.css?1676866111" rel="stylesheet" media="print">
<script src="/js/url.js?1676866111"></script>
<script src="/js/variant.js?1676866111"></script>
<link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/nucleus.css?1732082585" rel="stylesheet">
<link href="/css/auto-complete.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1732082585" rel="stylesheet">
<link href="/css/fonts.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/theme.css?1732082585" rel="stylesheet">
<link href="/css/theme-auto.css?1732082585" rel="stylesheet" id="variant-style">
<link href="/css/variant.css?1732082585" rel="stylesheet">
<link href="/css/print.css?1732082585" rel="stylesheet" media="print">
<link href="/css/ie.css?1732082585" rel="stylesheet">
<script src="/js/url.js?1732082585"></script>
<script src="/js/variant.js?1732082585"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
@ -43,7 +43,7 @@
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<nav id="topbar" class="highlightable">
<div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
@ -55,12 +55,12 @@
</span>
</div>
<div class="default-animation progress">
<div class="toc-wrapper" dir="ltr">
<nav id="TableOfContents">
<div class="toc-wrapper"><nav id="TableOfContents">
<ul>
<li>
<ul>
<li><a href="#order">Order</a></li>
<li><a href="#getoutput">getOutput</a></li>
<li><a href="#notifications">Notifications</a></li>
<li><a href="#name">Name</a></li>
<li><a href="#cron-mode">Cron mode</a></li>
@ -74,91 +74,120 @@
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="default">
<header class="headline">
</header>
<h1 id="command-lists">Command Lists</h1>
<p>Command lists are for executing commands in sequence and getting notifications from them.</p>
<p>The top-level object key can be anything you want.</p>
<table>
<thead>
<tr>
<th>key</th>
<th>description</th>
<th>type</th>
<th>required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>order</code></td>
<td>Defines the sequence of commands to execute</td>
<td><code>[]string</code></td>
<td>yes</td>
</tr>
<tr>
<td><code>notifications</code></td>
<td>The notification IDs to use on success and failure</td>
<td><code>[]string</code></td>
<td>no</td>
</tr>
<tr>
<td><code>name</code></td>
<td>Optional name of the list</td>
<td><code>string</code></td>
<td>no</td>
</tr>
<tr>
<td><code>cron</code></td>
<td>Time at which to schedule the list.</td>
<td><code>string</code></td>
<td>no</td>
</tr>
</tbody>
<p>The top-level object key can be anything you want but not the same as another.</p>
<p>Lists can go in a separate file. Command lists should be in a separate file if:</p>
<ol>
<li>key &lsquo;cmd-lists.file&rsquo; is found</li>
<li>hosts.yml or hosts.yaml is found in the same directory as the backy config file</li>
</ol>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span> <span style="color:#f92672">test2</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">name</span>: <span style="color:#ae81ff">test2</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">order</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">test</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">test2</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">notifications</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">mail.prod-email</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">matrix.sysadmin</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cron</span>: <span style="color:#e6db74">&#34;0 * * * * *&#34;</span>
</span></span></code></pre></div><table>
<thead>
<tr>
<th style="text-align: left">key</th>
<th style="text-align: left">description</th>
<th style="text-align: left">type</th>
<th style="text-align: left">required</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left"><code>order</code></td>
<td style="text-align: left">Defines the sequence of commands to execute</td>
<td style="text-align: left"><code>[]string</code></td>
<td style="text-align: left">yes</td>
</tr>
<tr>
<td style="text-align: left"><code>getOutput</code></td>
<td style="text-align: left">Command(s) output is in the notification(s)</td>
<td style="text-align: left"><code>bool</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>notifications</code></td>
<td style="text-align: left">The notification service(s) and ID(s) to use on success and failure. Must be <em><code>service.id</code></em>. See the <a href="/config/notifications/">notifications documentation page</a> for more</td>
<td style="text-align: left"><code>[]string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>name</code></td>
<td style="text-align: left">Optional name of the list</td>
<td style="text-align: left"><code>string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>cron</code></td>
<td style="text-align: left">Time at which to schedule the list. Only has affect when cron subcommand is run.</td>
<td style="text-align: left"><code>string</code></td>
<td style="text-align: left">no</td>
</tr>
</tbody>
</table>
<h3 id="order">Order</h3>
<p>The order is an array of commands to execute in order. Each command must be defined.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">order</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">cmd-1</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">cmd-2</span>
</span></span></code></pre></div><h3 id="getoutput">getOutput</h3>
<p>Get command output when a notification is sent.</p>
<p>Is not required. Can be <code>true</code> or <code>false</code>. Default is <code>false</code>.</p>
<h3 id="notifications">Notifications</h3>
<p>An array of notification IDs to use on success and failure. Must match any of the <code>notifications</code> object map keys.</p>
<h3 id="name">Name</h3>
<p>Name is optional for logging. If name is not defined, name will be the object&rsquo;s map key.</p>
<p>Name is optional. If name is not defined, name will be the object&rsquo;s map key.</p>
<h3 id="cron-mode">Cron mode</h3>
<p>Backy also has a cron mode, so one can run <code>backy cron</code> and start a process that schedules jobs to run at times defined in the configuration file.</p>
<p>Adding <code>cron: 0 0 1 * * *</code> to a <code>cmd-configs</code> object will schedule the list at 1 in the morning. See <a href="https://crontab.guru/" target="_blank">https://crontab.guru/</a> for reference.</p>
<p>Adding <code>cron: 0 0 1 * * *</code> to a <code>cmd-lists</code> object will schedule the list at 1 in the morning. See <a href="https://crontab.guru/" target="_blank">https://crontab.guru/</a> for reference.</p>
<div class="box notices cstyle tip">
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
<div class="box-content">
<p>Note: Backy uses the second field of cron, so add anything except * to the beginning of a regular cron expression.</p>
</div>
</div>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">cmd-configs</span>:
</span></span><span style="display:flex;"><span><span style="color:#f92672">  cmds-to-run</span>: <span style="color:#75715e"># this can be any name you want</span>
</span></span><span style="display:flex;"><span><span style="color:#ae81ff">   </span> <span style="color:#75715e"># all commands have to be defined</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">    order</span>:
</span></span><span style="display:flex;"><span><span style="color:#ae81ff">      - stop-docker-container</span>
</span></span><span style="display:flex;"><span><span style="color:#ae81ff">      - backup-docker-container-script</span>
</span></span><span style="display:flex;"><span><span style="color:#ae81ff">      - shell-cmd</span>
</span></span><span style="display:flex;"><span><span style="color:#ae81ff">      - hostname</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">    notifications</span>:
</span></span><span style="display:flex;"><span><span style="color:#ae81ff">      - matrix</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">    name</span>: <span style="color:#ae81ff">backup-some-server</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">    cron</span>: <span style="color:#e6db74">&#34;0 0 1 * * *&#34;</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">  hostname</span>:
</span></span><span style="display:flex;"><span><span style="color:#f92672">    name</span>: <span style="color:#ae81ff">hostname</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">    order</span>:
</span></span><span style="display:flex;"><span><span style="color:#ae81ff">      - hostname</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">    notifications</span>:
</span></span><span style="display:flex;"><span> <span style="color:#ae81ff">    - prod-email</span>
</div>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">cmd-lists</span>:
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">docker-container-backup</span>: <span style="color:#75715e"># this can be any name you want</span>
</span></span><span style="display:flex;"><span>    <span style="color:#75715e"># all commands have to be defined</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">order</span>:
</span></span><span style="display:flex;"><span>      - <span style="color:#ae81ff">stop-docker-container</span>
</span></span><span style="display:flex;"><span>      - <span style="color:#ae81ff">backup-docker-container-script</span>
</span></span><span style="display:flex;"><span>      - <span style="color:#ae81ff">shell-cmd</span>
</span></span><span style="display:flex;"><span>      - <span style="color:#ae81ff">hostname</span>
</span></span><span style="display:flex;"><span>      - <span style="color:#ae81ff">start-docker-container</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">notifications</span>:
</span></span><span style="display:flex;"><span>      - <span style="color:#ae81ff">matrix.id</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">name</span>: <span style="color:#ae81ff">backup-some-container</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">cron</span>: <span style="color:#e6db74">&#34;0 0 1 * * *&#34;</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">hostname</span>:
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">name</span>: <span style="color:#ae81ff">hostname</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">order</span>:
</span></span><span style="display:flex;"><span>      - <span style="color:#ae81ff">hostname</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">notifications</span>:
</span></span><span style="display:flex;"><span>     - <span style="color:#ae81ff">mail.prod-email</span>
</span></span></code></pre></div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<aside id="sidebar" class="default-animation" dir="ltr">
<aside id="sidebar" class="default-animation">
<div id="header-wrapper" class="default-animation">
<div id="header" class="default-animation">
<style>
@ -217,27 +246,28 @@
<script>
var contentLangs=['en'];
</script>
<script src="/js/auto-complete.js?1676866111" defer></script>
<script src="/js/lunr/lunr.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.en.min.js?1676866111" defer></script>
<script src="/js/search.js?1676866111" defer></script>
<script src="/js/auto-complete.js?1732082585" defer></script>
<script src="/js/lunr/lunr.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.en.min.js?1732082585" defer></script>
<script src="/js/search.js?1732082585" defer></script>
</div>
<div id="content-wrapper" class="highlightable">
<ul class="topics collapsible-menu">
<li data-nav-id="/getting-started/index.html" class="dd-item"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle"><label class="a11y-only toggle" for="section-c727fab97b4d77e5b28ce8c448fb9000" >Submenu Getting started</label><a href="/getting-started/index.html">Getting started</a><ul id="subsections-c727fab97b4d77e5b28ce8c448fb9000">
<li data-nav-id="/getting-started/install/index.html" class="dd-item"><a href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class="dd-item"><a href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="dd-item parent"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle" checked><label class="a11y-only toggle" for="section-98a8c13bcd8ebb34cfcbafd00ee6590b" >Submenu Configuring Backy</label><a href="/config/index.html">Configuring Backy</a><ul id="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b">
<li data-nav-id="/config/command-lists/index.html" class="dd-item active"><a href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/commands/index.html" class="dd-item"><a href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/notifications/index.html" class="dd-item"><a href="/config/notifications/index.html">Notifications</a></li></ul></li>
<li data-nav-id="/cli/index.html" class="dd-item"><a href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class="dd-item"><a href="/repositories/index.html">Repositories</a></li>
<ul class="topics enlarge morespace collapsible-menu">
<li data-nav-id="/getting-started/index.html" class=""><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b"><label for="section-ffe9773a38b1e1cbc000aa49823cb86b"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Getting started</span></label><a class="padding" href="/getting-started/index.html">Getting started</a><ul id="subsections-ffe9773a38b1e1cbc000aa49823cb86b" class="morespace collapsible-menu">
<li data-nav-id="/getting-started/install/index.html" class=""><a class="padding" href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class=""><a class="padding" href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="parent "><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019" checked><label for="section-05a1934784c32ed5016a6c9b2dd9e019"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Configuring Backy</span></label><a class="padding" href="/config/index.html">Configuring Backy</a><ul id="subsections-05a1934784c32ed5016a6c9b2dd9e019" class="morespace collapsible-menu">
<li data-nav-id="/config/commands/index.html" class=""><a class="padding" href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/command-lists/index.html" class="active"><a class="padding" href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/notifications/index.html" class=""><a class="padding" href="/config/notifications/index.html">Notifications</a></li>
<li data-nav-id="/config/vault/index.html" class=""><a class="padding" href="/config/vault/index.html">Vault</a></li></ul></li>
<li data-nav-id="/cli/index.html" class=""><a class="padding" href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class=""><a class="padding" href="/repositories/index.html">Repositories</a></li>
</ul>
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div class="padding footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="padding default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
<ul>
<li id="select-language-container" class="footerLangSwitch">
@ -247,6 +277,7 @@
<div class="select-style">
<label class="a11y-only" for="select-language">Language</label>
<select id="select-language" onchange="location = baseUri + this.value;">
<option lang="en" id="en" value="/config/command-lists/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -266,7 +297,7 @@
</div>
<script>window.variants && variants.markSelectedVariant();</script>
</li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i><span>&nbsp;</span>Clear History</button></li>
</ul>
</div>
<div id="footer" class="footerFooter showFooter">
@ -274,8 +305,8 @@
</div>
</div>
</aside>
<script src="/js/clipboard.min.js?1676866111" defer></script>
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
<script src="/js/clipboard.min.js?1732082585" defer></script>
<script src="/js/perfect-scrollbar.min.js?1732082585" defer></script>
<script>
function useMathJax( config ){
if( !Object.assign ){
@ -305,23 +336,19 @@
useMathJax( JSON.parse("{}") );
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="/js/d3/d3-color.min.js?1676866111" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1676866111" defer></script>
<script src="/js/d3/d3-drag.min.js?1676866111" defer></script>
<script src="/js/d3/d3-ease.min.js?1676866111" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1676866111" defer></script>
<script src="/js/d3/d3-selection.min.js?1676866111" defer></script>
<script src="/js/d3/d3-timer.min.js?1676866111" defer></script>
<script src="/js/d3/d3-transition.min.js?1676866111" defer></script>
<script src="/js/d3/d3-zoom.min.js?1676866111" defer></script>
<script src="/js/d3/d3-color.min.js?1732082585" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1732082585" defer></script>
<script src="/js/d3/d3-drag.min.js?1732082585" defer></script>
<script src="/js/d3/d3-ease.min.js?1732082585" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1732082585" defer></script>
<script src="/js/d3/d3-selection.min.js?1732082585" defer></script>
<script src="/js/d3/d3-timer.min.js?1732082585" defer></script>
<script src="/js/d3/d3-transition.min.js?1732082585" defer></script>
<script src="/js/d3/d3-zoom.min.js?1732082585" defer></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js" defer></script>
<script>
window.themeUseMermaid = JSON.parse("{ \"theme\": \"default\" }");
</script>
<script src="https://unpkg.com/rapidoc/dist/rapidoc-min.js" defer></script>
<script>
window.themeUseSwagger = JSON.parse("{ \"theme\": \"light\" }");
</script>
<script src="/js/theme.js?1676866111" defer></script>
<script src="/js/theme.js?1732082585" defer></script>
</body>
</html>

269
docs/public/config/commands/index.html
View File

@ -3,23 +3,23 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.110.0">
<meta name="generator" content="Relearn 5.11.2">
<meta name="generator" content="Hugo 0.135.0">
<meta name="generator" content="Relearn 5.16.2">
<meta name="description" content="">
<title>Commands - A tool for commands</title>
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/auto-complete.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1676866111" rel="stylesheet">
<link href="/css/nucleus.css?1676866111" rel="stylesheet">
<link href="/css/fonts.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/theme.css?1676866111" rel="stylesheet">
<link href="/css/theme-auto.css?1676866111" rel="stylesheet" id="variant-style">
<link href="/css/ie.css?1676866111" rel="stylesheet">
<link href="/css/variant.css?1676866111" rel="stylesheet">
<link href="/css/print.css?1676866111" rel="stylesheet" media="print">
<script src="/js/url.js?1676866111"></script>
<script src="/js/variant.js?1676866111"></script>
<link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/nucleus.css?1732082585" rel="stylesheet">
<link href="/css/auto-complete.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1732082585" rel="stylesheet">
<link href="/css/fonts.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/theme.css?1732082585" rel="stylesheet">
<link href="/css/theme-auto.css?1732082585" rel="stylesheet" id="variant-style">
<link href="/css/variant.css?1732082585" rel="stylesheet">
<link href="/css/print.css?1732082585" rel="stylesheet" media="print">
<link href="/css/ie.css?1732082585" rel="stylesheet">
<script src="/js/url.js?1732082585"></script>
<script src="/js/variant.js?1732082585"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
@ -42,7 +42,7 @@
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<nav id="topbar" class="highlightable">
<div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
@ -54,14 +54,17 @@
</span>
</div>
<div class="default-animation progress">
<div class="toc-wrapper" dir="ltr">
<nav id="TableOfContents">
<div class="toc-wrapper"><nav id="TableOfContents">
<ul>
<li>
<ul>
<li></li>
<li><a href="#example-config">Example Config</a></li>
<li><a href="#getoutput">getOutput</a></li>
<li><a href="#shell">shell</a></li>
<li><a href="#scriptenvfile">scriptEnvFile</a></li>
<li><a href="#type">type</a></li>
<li><a href="#environment">environment</a></li>
<li><a href="#hooks">hooks</a></li>
</ul>
</li>
</ul>
@ -72,13 +75,14 @@
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="default">
<header class="headline">
</header>
<h1 id="commands">Commands</h1>
<p>The yaml top-level map can be any string.</p>
<p>The top-level name must be unique.</p>
<h3 id="example-config">Example Config</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">commands</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">stop-docker-container</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cmd</span>: <span style="color:#ae81ff">docker</span>
@ -87,56 +91,88 @@
</span></span><span style="display:flex;"><span> - -<span style="color:#ae81ff">f /some/path/to/docker-compose.yaml</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">down</span>
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># if host is not defined, command will be run locally</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">host</span>: <span style="color:#ae81ff">some-host </span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">backup-docker-container-script</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cmd</span>: <span style="color:#ae81ff">/path/to/script</span>
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># The host has to be defined in either the config file or the SSH Config files</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">host</span>: <span style="color:#ae81ff">some-host</span>
</span></span><span style="display:flex;"><span> <span style="color:#ae81ff">hooks</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">error</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">some-other-command-when-failing</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">success</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">success-command</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">final</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">final-command</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">backup-docker-container-script</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cmd</span>: <span style="color:#ae81ff">/path/to/local/script</span>
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># script file is input as stdin to SSH</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">type</span>: <span style="color:#ae81ff">scriptFile</span> <span style="color:#75715e"># also can be script</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">environment</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">FOO=BAR</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">APP=$VAR</span>
</span></span></code></pre></div><p>Values available for this section:</p>
<table>
<thead>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cmd</code></td>
<td>Defines the command to execute</td>
<td><code>string</code></td>
<td>yes</td>
</tr>
<tr>
<td><code>args</code></td>
<td>Defines the arguments to the command</td>
<td><code>[]string</code></td>
<td>no</td>
</tr>
<tr>
<td><code>environment</code></td>
<td>Defines evironment variables for the command</td>
<td><code>[]string</code></td>
<td>no</td>
</tr>
<tr>
<td><code>host</code></td>
<td>If not specified, the command will execute locally.</td>
<td><code>string</code></td>
<td>no</td>
</tr>
<tr>
<td><code>shell</code></td>
<td>Only applicable when host is not specified</td>
<td><code>string</code></td>
<td>no</td>
</tr>
</tbody>
<thead>
<tr>
<th style="text-align: left">name</th>
<th style="text-align: left">notes</th>
<th style="text-align: left">type</th>
<th style="text-align: left">required</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left"><code>cmd</code></td>
<td style="text-align: left">Defines the command to execute</td>
<td style="text-align: left"><code>string</code></td>
<td style="text-align: left">yes</td>
</tr>
<tr>
<td style="text-align: left"><code>args</code></td>
<td style="text-align: left">Defines the arguments to the command</td>
<td style="text-align: left"><code>[]string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>environment</code></td>
<td style="text-align: left">Defines evironment variables for the command</td>
<td style="text-align: left"><code>[]string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>type</code></td>
<td style="text-align: left">May be <code>scriptFile</code> or <code>script</code>. Runs script from local machine on remote. Only applicable when <code>host</code> is defined.</td>
<td style="text-align: left"><code>string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>getOutput</code></td>
<td style="text-align: left">Command(s) output is in the notification(s)</td>
<td style="text-align: left"><code>bool</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>host</code></td>
<td style="text-align: left">If not specified, the command will execute locally.</td>
<td style="text-align: left"><code>string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>scriptEnvFile</code></td>
<td style="text-align: left">When type is <code>scriptFile</code>, the script is appended to this file.</td>
<td style="text-align: left"><code>string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>shell</code></td>
<td style="text-align: left">Only applicable when host is not specified</td>
<td style="text-align: left"><code>string</code></td>
<td style="text-align: left">no</td>
</tr>
<tr>
<td style="text-align: left"><code>hooks</code></td>
<td style="text-align: left">Hooks are used at the end of the individual command. Must be another command.</td>
<td style="text-align: left"><code>[]string</code></td>
<td style="text-align: left">no</td>
</tr>
</tbody>
</table>
<h4 id="cmd">cmd</h4>
<p>cmd must be a valid command or script to execute.</p>
@ -148,43 +184,70 @@
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">arg1</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">arg2</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">arg3</span>
</span></span></code></pre></div><h4 id="host">host</h4>
</span></span></code></pre></div><h3 id="getoutput">getOutput</h3>
<p>Get command output when a notification is sent.</p>
<p>Is not required. Can be <code>true</code> or <code>false</code>.</p>
<h4 id="host">host</h4>
<div class="box notices cstyle info">
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
<div class="box-content">
<p>If any <code>host</code> is not defined or left blank, the command will run on the local machine.</p>
</div>
</div>
</div>
<p>Host may or may not be defined in the <code>hosts</code> section.</p>
<div class="box notices cstyle info">
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
<div class="box-content">
<p>If any <code>host</code> from the commands section does not match any object in the <code>hosts</code> section, the <code>Host</code> is assumed to be this value. This value will be used to search in the default SSH config files.</p>
<p>For example, say that I have a host defined in my SSH config with the <code>Host</code> defined as <code>web-prod</code>.
If I assign a value to host as <code>host: web-prod</code> and don&rsquo;t specify this value in the <code>hosts</code> object, web-prod will be used as the <code>Host</code> in searching the SSH config files.</p>
</div>
</div>
</div>
<h3 id="shell">shell</h3>
<p>If shell is defined and host is NOT defined, the command will run in the specified shell.
Make sure to escape any shell input.</p>
<h3 id="scriptenvfile">scriptEnvFile</h3>
<p>Path to a file.</p>
<p>When type is specified, the script is appended to this file.</p>
<p>This is useful for specifying environment variables or other things so they don&rsquo;t have to be included in the script.</p>
<h3 id="type">type</h3>
<p>May be <code>scriptFile</code> or <code>script</code>. Runs script from local machine on remote host passed to the SSH session as standard input.</p>
<p>If <code>type</code> is <code>script</code>, <code>cmd</code> is used as the script.</p>
<p>If <code>type</code> is <code>scriptFile</code>, cmd must be a script file.</p>
<h3 id="environment">environment</h3>
<p>The environment variables support expansion:</p>
<ul>
<li>using escaped values <code>$VAR</code> or <code>${VAR}</code></li>
</ul>
<p>For now the variables have to be defined in an <code>.env</code> file in the same directory as the config file.</p>
<p>For now, the variables have to be defined in an <code>.env</code> file in the same directory as the config file.</p>
<p>If using it with host specified, the SSH server has to be configured to accept those env variables.</p>
<p>If the command is run locally, the OS&rsquo;s environment is added.</p>
<h3 id="hooks">hooks</h3>
<p>Hooks are run after the command is run.</p>
<p>Errors are run if the command errors, success if it returns no error. Final hooks are run regardless of error condition.</p>
<p>Values for hooks are as follows:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">command</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">hook</span>:
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># these commands are defined elsewhere in the file</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">error</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">errcommand</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">success</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">successcommand</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">final</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">donecommand</span>
</span></span></code></pre></div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<aside id="sidebar" class="default-animation" dir="ltr">
<aside id="sidebar" class="default-animation">
<div id="header-wrapper" class="default-animation">
<div id="header" class="default-animation">
<style>
@ -243,27 +306,28 @@ Make sure to escape any shell input.</p>
<script>
var contentLangs=['en'];
</script>
<script src="/js/auto-complete.js?1676866111" defer></script>
<script src="/js/lunr/lunr.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.en.min.js?1676866111" defer></script>
<script src="/js/search.js?1676866111" defer></script>
<script src="/js/auto-complete.js?1732082585" defer></script>
<script src="/js/lunr/lunr.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.en.min.js?1732082585" defer></script>
<script src="/js/search.js?1732082585" defer></script>
</div>
<div id="content-wrapper" class="highlightable">
<ul class="topics collapsible-menu">
<li data-nav-id="/getting-started/index.html" class="dd-item"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle"><label class="a11y-only toggle" for="section-c727fab97b4d77e5b28ce8c448fb9000" >Submenu Getting started</label><a href="/getting-started/index.html">Getting started</a><ul id="subsections-c727fab97b4d77e5b28ce8c448fb9000">
<li data-nav-id="/getting-started/install/index.html" class="dd-item"><a href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class="dd-item"><a href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="dd-item parent"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle" checked><label class="a11y-only toggle" for="section-98a8c13bcd8ebb34cfcbafd00ee6590b" >Submenu Configuring Backy</label><a href="/config/index.html">Configuring Backy</a><ul id="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b">
<li data-nav-id="/config/command-lists/index.html" class="dd-item"><a href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/commands/index.html" class="dd-item active"><a href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/notifications/index.html" class="dd-item"><a href="/config/notifications/index.html">Notifications</a></li></ul></li>
<li data-nav-id="/cli/index.html" class="dd-item"><a href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class="dd-item"><a href="/repositories/index.html">Repositories</a></li>
<ul class="topics enlarge morespace collapsible-menu">
<li data-nav-id="/getting-started/index.html" class=""><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b"><label for="section-ffe9773a38b1e1cbc000aa49823cb86b"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Getting started</span></label><a class="padding" href="/getting-started/index.html">Getting started</a><ul id="subsections-ffe9773a38b1e1cbc000aa49823cb86b" class="morespace collapsible-menu">
<li data-nav-id="/getting-started/install/index.html" class=""><a class="padding" href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class=""><a class="padding" href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="parent "><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019" checked><label for="section-05a1934784c32ed5016a6c9b2dd9e019"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Configuring Backy</span></label><a class="padding" href="/config/index.html">Configuring Backy</a><ul id="subsections-05a1934784c32ed5016a6c9b2dd9e019" class="morespace collapsible-menu">
<li data-nav-id="/config/commands/index.html" class="active"><a class="padding" href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/command-lists/index.html" class=""><a class="padding" href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/notifications/index.html" class=""><a class="padding" href="/config/notifications/index.html">Notifications</a></li>
<li data-nav-id="/config/vault/index.html" class=""><a class="padding" href="/config/vault/index.html">Vault</a></li></ul></li>
<li data-nav-id="/cli/index.html" class=""><a class="padding" href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class=""><a class="padding" href="/repositories/index.html">Repositories</a></li>
</ul>
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div class="padding footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="padding default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
<ul>
<li id="select-language-container" class="footerLangSwitch">
@ -273,6 +337,7 @@ Make sure to escape any shell input.</p>
<div class="select-style">
<label class="a11y-only" for="select-language">Language</label>
<select id="select-language" onchange="location = baseUri + this.value;">
<option lang="en" id="en" value="/config/commands/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -292,7 +357,7 @@ Make sure to escape any shell input.</p>
</div>
<script>window.variants && variants.markSelectedVariant();</script>
</li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i><span>&nbsp;</span>Clear History</button></li>
</ul>
</div>
<div id="footer" class="footerFooter showFooter">
@ -300,8 +365,8 @@ Make sure to escape any shell input.</p>
</div>
</div>
</aside>
<script src="/js/clipboard.min.js?1676866111" defer></script>
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
<script src="/js/clipboard.min.js?1732082585" defer></script>
<script src="/js/perfect-scrollbar.min.js?1732082585" defer></script>
<script>
function useMathJax( config ){
if( !Object.assign ){
@ -331,23 +396,19 @@ Make sure to escape any shell input.</p>
useMathJax( JSON.parse("{}") );
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="/js/d3/d3-color.min.js?1676866111" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1676866111" defer></script>
<script src="/js/d3/d3-drag.min.js?1676866111" defer></script>
<script src="/js/d3/d3-ease.min.js?1676866111" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1676866111" defer></script>
<script src="/js/d3/d3-selection.min.js?1676866111" defer></script>
<script src="/js/d3/d3-timer.min.js?1676866111" defer></script>
<script src="/js/d3/d3-transition.min.js?1676866111" defer></script>
<script src="/js/d3/d3-zoom.min.js?1676866111" defer></script>
<script src="/js/d3/d3-color.min.js?1732082585" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1732082585" defer></script>
<script src="/js/d3/d3-drag.min.js?1732082585" defer></script>
<script src="/js/d3/d3-ease.min.js?1732082585" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1732082585" defer></script>
<script src="/js/d3/d3-selection.min.js?1732082585" defer></script>
<script src="/js/d3/d3-timer.min.js?1732082585" defer></script>
<script src="/js/d3/d3-transition.min.js?1732082585" defer></script>
<script src="/js/d3/d3-zoom.min.js?1732082585" defer></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js" defer></script>
<script>
window.themeUseMermaid = JSON.parse("{ \"theme\": \"default\" }");
</script>
<script src="https://unpkg.com/rapidoc/dist/rapidoc-min.js" defer></script>
<script>
window.themeUseSwagger = JSON.parse("{ \"theme\": \"light\" }");
</script>
<script src="/js/theme.js?1676866111" defer></script>
<script src="/js/theme.js?1732082585" defer></script>
</body>
</html>

113
docs/public/config/index.html
View File

@ -3,25 +3,25 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.110.0">
<meta name="generator" content="Relearn 5.11.2">
<meta name="generator" content="Hugo 0.135.0">
<meta name="generator" content="Relearn 5.16.2">
<meta name="description" content="This page tells you how to configure Backy.
">
<title>Configuring Backy - A tool for commands</title>
<link href="/config/index.xml" rel="alternate" type="application/rss+xml" title="Configuring Backy - A tool for commands">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/auto-complete.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1676866111" rel="stylesheet">
<link href="/css/nucleus.css?1676866111" rel="stylesheet">
<link href="/css/fonts.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/theme.css?1676866111" rel="stylesheet">
<link href="/css/theme-auto.css?1676866111" rel="stylesheet" id="variant-style">
<link href="/css/ie.css?1676866111" rel="stylesheet">
<link href="/css/variant.css?1676866111" rel="stylesheet">
<link href="/css/print.css?1676866111" rel="stylesheet" media="print">
<script src="/js/url.js?1676866111"></script>
<script src="/js/variant.js?1676866111"></script>
<link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/nucleus.css?1732082585" rel="stylesheet">
<link href="/css/auto-complete.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1732082585" rel="stylesheet">
<link href="/css/fonts.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/theme.css?1732082585" rel="stylesheet">
<link href="/css/theme-auto.css?1732082585" rel="stylesheet" id="variant-style">
<link href="/css/variant.css?1732082585" rel="stylesheet">
<link href="/css/print.css?1732082585" rel="stylesheet" media="print">
<link href="/css/ie.css?1732082585" rel="stylesheet">
<script src="/js/url.js?1732082585"></script>
<script src="/js/variant.js?1732082585"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
@ -44,7 +44,7 @@
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<nav id="topbar" class="highlightable">
<div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
@ -58,31 +58,32 @@
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="default">
<header class="headline">
</header>
<h1 id="configuring-backy">Configuring Backy</h1>
<p>This is the section on the config file.</p>
<p>To use a specific file:
<code>backy backup -f /path/to/file</code></p>
<code>backy [command] -f /path/to/file</code></p>
<p>If you leave the config path blank, the following paths will be searched in order:</p>
<ul>
<ol>
<li><code>./backy.yml</code></li>
<li><code>./backy.yaml</code></li>
<li><code>~/.config/backy.yml</code></li>
<li><code>~/.config/backy.yaml</code></li>
</ul>
</ol>
<p>Create a file at <code>~/.config/backy.yml</code>.</p>
<p>See the documentation in this section to configure it.</p>
<p>See the rest of the documentation in this section to configure it.</p>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<aside id="sidebar" class="default-animation" dir="ltr">
<aside id="sidebar" class="default-animation">
<div id="header-wrapper" class="default-animation">
<div id="header" class="default-animation">
<style>
@ -141,27 +142,28 @@
<script>
var contentLangs=['en'];
</script>
<script src="/js/auto-complete.js?1676866111" defer></script>
<script src="/js/lunr/lunr.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.en.min.js?1676866111" defer></script>
<script src="/js/search.js?1676866111" defer></script>
<script src="/js/auto-complete.js?1732082585" defer></script>
<script src="/js/lunr/lunr.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.en.min.js?1732082585" defer></script>
<script src="/js/search.js?1732082585" defer></script>
</div>
<div id="content-wrapper" class="highlightable">
<ul class="topics collapsible-menu">
<li data-nav-id="/getting-started/index.html" class="dd-item"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle"><label class="a11y-only toggle" for="section-c727fab97b4d77e5b28ce8c448fb9000" >Submenu Getting started</label><a href="/getting-started/index.html">Getting started</a><ul id="subsections-c727fab97b4d77e5b28ce8c448fb9000">
<li data-nav-id="/getting-started/install/index.html" class="dd-item"><a href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class="dd-item"><a href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="dd-item active parent"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle" checked><label class="a11y-only toggle" for="section-98a8c13bcd8ebb34cfcbafd00ee6590b" >Submenu Configuring Backy</label><a href="/config/index.html">Configuring Backy</a><ul id="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b">
<li data-nav-id="/config/command-lists/index.html" class="dd-item"><a href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/commands/index.html" class="dd-item"><a href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/notifications/index.html" class="dd-item"><a href="/config/notifications/index.html">Notifications</a></li></ul></li>
<li data-nav-id="/cli/index.html" class="dd-item"><a href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class="dd-item"><a href="/repositories/index.html">Repositories</a></li>
<ul class="topics enlarge morespace collapsible-menu">
<li data-nav-id="/getting-started/index.html" class=""><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b"><label for="section-ffe9773a38b1e1cbc000aa49823cb86b"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Getting started</span></label><a class="padding" href="/getting-started/index.html">Getting started</a><ul id="subsections-ffe9773a38b1e1cbc000aa49823cb86b" class="morespace collapsible-menu">
<li data-nav-id="/getting-started/install/index.html" class=""><a class="padding" href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class=""><a class="padding" href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="active parent "><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019" checked><label for="section-05a1934784c32ed5016a6c9b2dd9e019"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Configuring Backy</span></label><a class="padding" href="/config/index.html">Configuring Backy</a><ul id="subsections-05a1934784c32ed5016a6c9b2dd9e019" class="morespace collapsible-menu">
<li data-nav-id="/config/commands/index.html" class=""><a class="padding" href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/command-lists/index.html" class=""><a class="padding" href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/notifications/index.html" class=""><a class="padding" href="/config/notifications/index.html">Notifications</a></li>
<li data-nav-id="/config/vault/index.html" class=""><a class="padding" href="/config/vault/index.html">Vault</a></li></ul></li>
<li data-nav-id="/cli/index.html" class=""><a class="padding" href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class=""><a class="padding" href="/repositories/index.html">Repositories</a></li>
</ul>
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div class="padding footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="padding default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
<ul>
<li id="select-language-container" class="footerLangSwitch">
@ -171,6 +173,7 @@
<div class="select-style">
<label class="a11y-only" for="select-language">Language</label>
<select id="select-language" onchange="location = baseUri + this.value;">
<option lang="en" id="en" value="/config/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -190,7 +193,7 @@
</div>
<script>window.variants && variants.markSelectedVariant();</script>
</li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i><span>&nbsp;</span>Clear History</button></li>
</ul>
</div>
<div id="footer" class="footerFooter showFooter">
@ -198,8 +201,8 @@
</div>
</div>
</aside>
<script src="/js/clipboard.min.js?1676866111" defer></script>
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
<script src="/js/clipboard.min.js?1732082585" defer></script>
<script src="/js/perfect-scrollbar.min.js?1732082585" defer></script>
<script>
function useMathJax( config ){
if( !Object.assign ){
@ -229,23 +232,19 @@
useMathJax( JSON.parse("{}") );
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="/js/d3/d3-color.min.js?1676866111" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1676866111" defer></script>
<script src="/js/d3/d3-drag.min.js?1676866111" defer></script>
<script src="/js/d3/d3-ease.min.js?1676866111" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1676866111" defer></script>
<script src="/js/d3/d3-selection.min.js?1676866111" defer></script>
<script src="/js/d3/d3-timer.min.js?1676866111" defer></script>
<script src="/js/d3/d3-transition.min.js?1676866111" defer></script>
<script src="/js/d3/d3-zoom.min.js?1676866111" defer></script>
<script src="/js/d3/d3-color.min.js?1732082585" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1732082585" defer></script>
<script src="/js/d3/d3-drag.min.js?1732082585" defer></script>
<script src="/js/d3/d3-ease.min.js?1732082585" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1732082585" defer></script>
<script src="/js/d3/d3-selection.min.js?1732082585" defer></script>
<script src="/js/d3/d3-timer.min.js?1732082585" defer></script>
<script src="/js/d3/d3-transition.min.js?1732082585" defer></script>
<script src="/js/d3/d3-zoom.min.js?1732082585" defer></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js" defer></script>
<script>
window.themeUseMermaid = JSON.parse("{ \"theme\": \"default\" }");
</script>
<script src="https://unpkg.com/rapidoc/dist/rapidoc-min.js" defer></script>
<script>
window.themeUseSwagger = JSON.parse("{ \"theme\": \"light\" }");
</script>
<script src="/js/theme.js?1676866111" defer></script>
<script src="/js/theme.js?1732082585" defer></script>
</body>
</html>

156
docs/public/config/index.xml
View File

@ -6,34 +6,156 @@
<description>Recent content in Configuring Backy on A tool for commands</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language><atom:link href="http://example.org/config/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Command Lists</title>
<link>http://example.org/config/command-lists/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/config/command-lists/index.html</guid>
<description>Command lists are for executing commands in sequence and getting notifications from them.
The top-level object key can be anything you want.
key description type required order Defines the sequence of commands to execute []string yes notifications The notification IDs to use on success and failure []string no name Optional name of the list string no cron Time at which to schedule the list. string no Order The order is an array of commands to execute in order.</description>
</item>
<item>
<title>Commands</title>
<link>http://example.org/config/commands/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/config/commands/index.html</guid>
<description>The yaml top-level map can be any string.
The top-level name must be unique.
commands: stop-docker-container: cmd: docker Args: - compose - -f /some/path/to/docker-compose.yaml - down # if host is not defined, command will be run locally host: some-host backup-docker-container-script: cmd: /path/to/script # The host has to be defined in either the config file or the SSH Config files host: some-host environment: - FOO=BAR - APP=$VAR Values available for this section:</description>
<description>&lt;p&gt;The yaml top-level map can be any string.&lt;/p&gt;
&lt;p&gt;The top-level name must be unique.&lt;/p&gt;
&lt;h3 id=&#34;example-config&#34;&gt;Example Config&lt;/h3&gt;
&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-yaml&#34; data-lang=&#34;yaml&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#f92672&#34;&gt;commands&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;stop-docker-container&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;cmd&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;docker&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;Args&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;compose&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - -&lt;span style=&#34;color:#ae81ff&#34;&gt;f /some/path/to/docker-compose.yaml&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;down&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#75715e&#34;&gt;# if host is not defined, command will be run locally&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#75715e&#34;&gt;# The host has to be defined in either the config file or the SSH Config files&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;host&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;some-host&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#ae81ff&#34;&gt;hooks&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;error&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;some-other-command-when-failing&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;success&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;success-command&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;final&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;final-command&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;backup-docker-container-script&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;cmd&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;/path/to/local/script&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#75715e&#34;&gt;# script file is input as stdin to SSH&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;type&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;scriptFile&lt;/span&gt; &lt;span style=&#34;color:#75715e&#34;&gt;# also can be script&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;environment&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;FOO=BAR&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;APP=$VAR&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Values available for this section:&lt;/p&gt;</description>
</item>
<item>
<title>Command Lists</title>
<link>http://example.org/config/command-lists/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/config/command-lists/index.html</guid>
<description>&lt;p&gt;Command lists are for executing commands in sequence and getting notifications from them.&lt;/p&gt;
&lt;p&gt;The top-level object key can be anything you want but not the same as another.&lt;/p&gt;
&lt;p&gt;Lists can go in a separate file. Command lists should be in a separate file if:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;key &amp;lsquo;cmd-lists.file&amp;rsquo; is found&lt;/li&gt;
&lt;li&gt;hosts.yml or hosts.yaml is found in the same directory as the backy config file&lt;/li&gt;
&lt;/ol&gt;
&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-yaml&#34; data-lang=&#34;yaml&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;test2&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;name&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;test2&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;order&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;test&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;test2&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;notifications&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;mail.prod-email&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;matrix.sysadmin&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;cron&lt;/span&gt;: &lt;span style=&#34;color:#e6db74&#34;&gt;&amp;#34;0 * * * * *&amp;#34;&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;table&gt;
&lt;thead&gt;
&lt;tr&gt;
&lt;th style=&#34;text-align: left&#34;&gt;key&lt;/th&gt;
&lt;th style=&#34;text-align: left&#34;&gt;description&lt;/th&gt;
&lt;th style=&#34;text-align: left&#34;&gt;type&lt;/th&gt;
&lt;th style=&#34;text-align: left&#34;&gt;required&lt;/th&gt;
&lt;/tr&gt;
&lt;/thead&gt;
&lt;tbody&gt;
&lt;tr&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;order&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;Defines the sequence of commands to execute&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;[]string&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;yes&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;getOutput&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;Command(s) output is in the notification(s)&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;bool&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;no&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;notifications&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;The notification service(s) and ID(s) to use on success and failure. Must be &lt;em&gt;&lt;code&gt;service.id&lt;/code&gt;&lt;/em&gt;. See the &lt;a href=&#34;http://example.org/config/notifications/&#34;&gt;notifications documentation page&lt;/a&gt; for more&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;[]string&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;no&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;name&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;Optional name of the list&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;string&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;no&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;cron&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;Time at which to schedule the list. Only has affect when cron subcommand is run.&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;&lt;code&gt;string&lt;/code&gt;&lt;/td&gt;
&lt;td style=&#34;text-align: left&#34;&gt;no&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;h3 id=&#34;order&#34;&gt;Order&lt;/h3&gt;
&lt;p&gt;The order is an array of commands to execute in order. Each command must be defined.&lt;/p&gt;</description>
</item>
<item>
<title>Notifications</title>
<link>http://example.org/config/notifications/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/config/notifications/index.html</guid>
<description>Notifications can be sent on command list completion and failure.
The supported platforms for notifications are email (SMTP) and Matrix.
Notifications are defined by type. The top-level object will be the id, and the type is required.
Info Type in a cmd-configs object must match one of these.
notifications: prod-email: type: mail host: yourhost.tld port: 587 senderaddress: email@domain.tld to: - admin@domain.tld username: smtp-username@domain.tld password: your-password-here matrix: type: matrix home-server: your-home-server.tld room-id: room-id access-token: your-access-token user-id: your-user-id Types recognized are type: mail and type: matrix</description>
<description>&lt;p&gt;Notifications can be sent on command list completion and failure.&lt;/p&gt;
&lt;p&gt;The supported platforms for notifications are email (SMTP) and &lt;a href=&#34;https://matrix.org/&#34; target=&#34;_blank&#34;&gt;Matrix&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;Notifications are defined by service, with the current form following below. Ids must come after the service.&lt;/p&gt;
&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-yaml&#34; data-lang=&#34;yaml&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#f92672&#34;&gt;notifications&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;mail&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;prod-email&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;host&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;yourhost.tld&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;port&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;587&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;senderaddress&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;email@domain.tld&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;to&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#ae81ff&#34;&gt;admin@domain.tld&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;username&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;smtp-username@domain.tld&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;password&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;your-password-here&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;matrix&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;matrix&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;home-server&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;your-home-server.tld&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;room-id&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;room-id&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;access-token&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;your-access-token&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;user-id&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;your-user-id&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Sections recognized are &lt;code&gt;mail&lt;/code&gt; and &lt;code&gt;matrix&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;There must be a section with an id (eg. &lt;code&gt;mail.test-svr&lt;/code&gt;) following one of these sections.&lt;/p&gt;</description>
</item>
<item>
<title>Vault</title>
<link>http://example.org/config/vault/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/config/vault/index.html</guid>
<description>&lt;p&gt;&lt;a href=&#34;https://www.vaultproject.io/&#34; target=&#34;_blank&#34;&gt;Vault&lt;/a&gt; is a tool for storing secrets and other data securely.&lt;/p&gt;
&lt;p&gt;Vault config can be used by prefixing &lt;code&gt;vault:&lt;/code&gt; in front of a password or ENV var.&lt;/p&gt;
&lt;p&gt;This is the object in the config file:&lt;/p&gt;
&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;&#34;&gt;&lt;code class=&#34;language-yaml&#34; data-lang=&#34;yaml&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#f92672&#34;&gt;vault&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;token&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;hvs.tXqcASvTP8wg92f7riyvGyuf&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;address&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;http://127.0.0.1:8200&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;enabled&lt;/span&gt;: &lt;span style=&#34;color:#66d9ef&#34;&gt;false&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;keys&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#f92672&#34;&gt;name&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;mongourl&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;mountpath&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;secret&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;path&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;mongo/url&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;type&lt;/span&gt;: &lt;span style=&#34;color:#75715e&#34;&gt;# KVv1 or KVv2&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; - &lt;span style=&#34;color:#f92672&#34;&gt;name&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;path&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;type&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt; &lt;span style=&#34;color:#f92672&#34;&gt;mountpath&lt;/span&gt;:
&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;</description>
</item>
</channel>
</rss>

296
docs/public/config/notifications/index.html
View File

@ -3,24 +3,24 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.110.0">
<meta name="generator" content="Relearn 5.11.2">
<meta name="generator" content="Hugo 0.135.0">
<meta name="generator" content="Relearn 5.16.2">
<meta name="description" content="This page tells you how to get set up Backy notifications.
">
<title>Notifications - A tool for commands</title>
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/auto-complete.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1676866111" rel="stylesheet">
<link href="/css/nucleus.css?1676866111" rel="stylesheet">
<link href="/css/fonts.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1676866111" rel="stylesheet"></noscript>
<link href="/css/theme.css?1676866111" rel="stylesheet">
<link href="/css/theme-auto.css?1676866111" rel="stylesheet" id="variant-style">
<link href="/css/ie.css?1676866111" rel="stylesheet">
<link href="/css/variant.css?1676866111" rel="stylesheet">
<link href="/css/print.css?1676866111" rel="stylesheet" media="print">
<script src="/js/url.js?1676866111"></script>
<script src="/js/variant.js?1676866111"></script>
<link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/nucleus.css?1732082585" rel="stylesheet">
<link href="/css/auto-complete.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/perfect-scrollbar.min.css?1732082585" rel="stylesheet">
<link href="/css/fonts.css?1732082585" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1732082585" rel="stylesheet"></noscript>
<link href="/css/theme.css?1732082585" rel="stylesheet">
<link href="/css/theme-auto.css?1732082585" rel="stylesheet" id="variant-style">
<link href="/css/variant.css?1732082585" rel="stylesheet">
<link href="/css/print.css?1732082585" rel="stylesheet" media="print">
<link href="/css/ie.css?1732082585" rel="stylesheet">
<script src="/js/url.js?1732082585"></script>
<script src="/js/variant.js?1732082585"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
@ -43,7 +43,7 @@
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<nav id="topbar" class="highlightable">
<div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
@ -55,13 +55,12 @@
</span>
</div>
<div class="default-animation progress">
<div class="toc-wrapper" dir="ltr">
<nav id="TableOfContents">
<div class="toc-wrapper"><nav id="TableOfContents">
<ul>
<li>
<ul>
<li><a href="#type-mail">type: mail</a></li>
<li><a href="#type-matrix">type: matrix</a></li>
<li><a href="#mail">mail</a></li>
<li><a href="#matrix">matrix</a></li>
</ul>
</li>
</ul>
@ -72,113 +71,106 @@
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="default">
<header class="headline">
</header>
<h1 id="notifications">Notifications</h1>
<p>Notifications can be sent on command list completion and failure.</p>
<p>The supported platforms for notifications are email (SMTP) and <a href="https://matrix.org/" target="_blank">Matrix</a>.</p>
<p>Notifications are defined by type. The top-level object will be the id, and the <code>type</code> is required.</p>
<div class="box notices cstyle info">
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
<div class="box-content">
<p>Type in a cmd-configs object must match one of these.</p>
</div>
</div>
<p>Notifications are defined by service, with the current form following below. Ids must come after the service.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">notifications</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">prod-email</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">type</span>: <span style="color:#ae81ff">mail</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">host</span>: <span style="color:#ae81ff">yourhost.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">port</span>: <span style="color:#ae81ff">587</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">senderaddress</span>: <span style="color:#ae81ff">email@domain.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">to</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">admin@domain.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">username</span>: <span style="color:#ae81ff">smtp-username@domain.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">password</span>: <span style="color:#ae81ff">your-password-here</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">mail</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">prod-email</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">host</span>: <span style="color:#ae81ff">yourhost.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">port</span>: <span style="color:#ae81ff">587</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">senderaddress</span>: <span style="color:#ae81ff">email@domain.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">to</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">admin@domain.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">username</span>: <span style="color:#ae81ff">smtp-username@domain.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">password</span>: <span style="color:#ae81ff">your-password-here</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">matrix</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">type</span>: <span style="color:#ae81ff">matrix</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">home-server</span>: <span style="color:#ae81ff">your-home-server.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">room-id</span>: <span style="color:#ae81ff">room-id</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">access-token</span>: <span style="color:#ae81ff">your-access-token</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">user-id</span>: <span style="color:#ae81ff">your-user-id</span>
</span></span></code></pre></div><p>Types recognized are <code>type: mail</code> and <code>type: matrix</code></p>
<p>The type&rsquo;s object and its keys are listed below.</p>
<h3 id="type-mail">type: mail</h3>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">matrix</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">home-server</span>: <span style="color:#ae81ff">your-home-server.tld</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">room-id</span>: <span style="color:#ae81ff">room-id</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">access-token</span>: <span style="color:#ae81ff">your-access-token</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">user-id</span>: <span style="color:#ae81ff">your-user-id</span>
</span></span></code></pre></div><p>Sections recognized are <code>mail</code> and <code>matrix</code></p>
<p>There must be a section with an id (eg. <code>mail.test-svr</code>) following one of these sections.</p>
<h3 id="mail">mail</h3>
<table>
<thead>
<tr>
<th>key</th>
<th>description</th>
<th>type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>host</code></td>
<td>Specifies the SMTP host to connect to</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>port</code></td>
<td>Specifies the SMTP port</td>
<td><code>uint16</code></td>
</tr>
<tr>
<td><code>senderaddress</code></td>
<td>Address from which to send mail</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>to</code></td>
<td>Recipients to send emails to</td>
<td><code>[]string</code></td>
</tr>
<tr>
<td><code>username</code></td>
<td>SMTP username</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>password</code></td>
<td>SMTP password</td>
<td><code>string</code></td>
</tr>
</tbody>
<thead>
<tr>
<th style="text-align: left">key</th>
<th style="text-align: left">description</th>
<th style="text-align: left">type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left"><code>host</code></td>
<td style="text-align: left">Specifies the SMTP host to connect to</td>
<td style="text-align: left"><code>string</code></td>
</tr>
<tr>
<td style="text-align: left"><code>port</code></td>
<td style="text-align: left">Specifies the SMTP port</td>
<td style="text-align: left"><code>uint16</code></td>
</tr>
<tr>
<td style="text-align: left"><code>senderaddress</code></td>
<td style="text-align: left">Address from which to send mail</td>
<td style="text-align: left"><code>string</code></td>
</tr>
<tr>
<td style="text-align: left"><code>to</code></td>
<td style="text-align: left">Recipients to send emails to</td>
<td style="text-align: left"><code>[]string</code></td>
</tr>
<tr>
<td style="text-align: left"><code>username</code></td>
<td style="text-align: left">SMTP username</td>
<td style="text-align: left"><code>string</code></td>
</tr>
<tr>
<td style="text-align: left"><code>password</code></td>
<td style="text-align: left">SMTP password</td>
<td style="text-align: left"><code>string</code></td>
</tr>
</tbody>
</table>
<h3 id="type-matrix">type: matrix</h3>
<h3 id="matrix">matrix</h3>
<table>
<thead>
<tr>
<th>key</th>
<th>description</th>
<th>type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>home-server</code></td>
<td>Specifies the Matrix server connect to</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>room-id</code></td>
<td>Specifies the room ID of the room to send messages to</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>access-token</code></td>
<td>Matrix access token</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>user-id</code></td>
<td>Matrix user ID</td>
<td><code>string</code></td>
</tr>
</tbody>
<thead>
<tr>
<th style="text-align: left">key</th>
<th style="text-align: left">description</th>
<th style="text-align: left">type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left"><code>home-server</code></td>
<td style="text-align: left">Specifies the Matrix server connect to</td>
<td style="text-align: left"><code>string</code></td>
</tr>
<tr>
<td style="text-align: left"><code>room-id</code></td>
<td style="text-align: left">Specifies the room ID of the room to send messages to</td>
<td style="text-align: left"><code>string</code></td>
</tr>
<tr>
<td style="text-align: left"><code>access-token</code></td>
<td style="text-align: left">Matrix access token</td>
<td style="text-align: left"><code>string</code></td>
</tr>
<tr>
<td style="text-align: left"><code>user-id</code></td>
<td style="text-align: left">Matrix user ID</td>
<td style="text-align: left"><code>string</code></td>
</tr>
</tbody>
</table>
<p>To get your access token (assumes you are using <a href="https://element.io/" target="_blank">Element</a>) :</p>
<ol>
@ -197,17 +189,19 @@
<div class="box notices cstyle info">
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
<div class="box-content">
<p>Make sure to quote the room ID, as <a href="https://yaml.org/spec/1.2.2/#3212-tags" target="_blank">YAML spec defines tags using <code>!</code></a>.</p>
</div>
</div>
</div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<aside id="sidebar" class="default-animation" dir="ltr">
<aside id="sidebar" class="default-animation">
<div id="header-wrapper" class="default-animation">
<div id="header" class="default-animation">
<style>
@ -266,27 +260,28 @@
<script>
var contentLangs=['en'];
</script>
<script src="/js/auto-complete.js?1676866111" defer></script>
<script src="/js/lunr/lunr.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1676866111" defer></script>
<script src="/js/lunr/lunr.en.min.js?1676866111" defer></script>
<script src="/js/search.js?1676866111" defer></script>
<script src="/js/auto-complete.js?1732082585" defer></script>
<script src="/js/lunr/lunr.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.stemmer.support.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.multi.min.js?1732082585" defer></script>
<script src="/js/lunr/lunr.en.min.js?1732082585" defer></script>
<script src="/js/search.js?1732082585" defer></script>
</div>
<div id="content-wrapper" class="highlightable">
<ul class="topics collapsible-menu">
<li data-nav-id="/getting-started/index.html" class="dd-item"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle"><label class="a11y-only toggle" for="section-c727fab97b4d77e5b28ce8c448fb9000" >Submenu Getting started</label><a href="/getting-started/index.html">Getting started</a><ul id="subsections-c727fab97b4d77e5b28ce8c448fb9000">
<li data-nav-id="/getting-started/install/index.html" class="dd-item"><a href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class="dd-item"><a href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="dd-item parent"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle" checked><label class="a11y-only toggle" for="section-98a8c13bcd8ebb34cfcbafd00ee6590b" >Submenu Configuring Backy</label><a href="/config/index.html">Configuring Backy</a><ul id="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b">
<li data-nav-id="/config/command-lists/index.html" class="dd-item"><a href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/commands/index.html" class="dd-item"><a href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/notifications/index.html" class="dd-item active"><a href="/config/notifications/index.html">Notifications</a></li></ul></li>
<li data-nav-id="/cli/index.html" class="dd-item"><a href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class="dd-item"><a href="/repositories/index.html">Repositories</a></li>
<ul class="topics enlarge morespace collapsible-menu">
<li data-nav-id="/getting-started/index.html" class=""><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b"><label for="section-ffe9773a38b1e1cbc000aa49823cb86b"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Getting started</span></label><a class="padding" href="/getting-started/index.html">Getting started</a><ul id="subsections-ffe9773a38b1e1cbc000aa49823cb86b" class="morespace collapsible-menu">
<li data-nav-id="/getting-started/install/index.html" class=""><a class="padding" href="/getting-started/install/index.html">Install Backy</a></li>
<li data-nav-id="/getting-started/config/index.html" class=""><a class="padding" href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="parent "><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019" checked><label for="section-05a1934784c32ed5016a6c9b2dd9e019"><i class="fas fa-chevron-down"></i><i class="fas fa-chevron-right"></i><span class="a11y-only">Submenu Configuring Backy</span></label><a class="padding" href="/config/index.html">Configuring Backy</a><ul id="subsections-05a1934784c32ed5016a6c9b2dd9e019" class="morespace collapsible-menu">
<li data-nav-id="/config/commands/index.html" class=""><a class="padding" href="/config/commands/index.html">Commands</a></li>
<li data-nav-id="/config/command-lists/index.html" class=""><a class="padding" href="/config/command-lists/index.html">Command Lists</a></li>
<li data-nav-id="/config/notifications/index.html" class="active"><a class="padding" href="/config/notifications/index.html">Notifications</a></li>
<li data-nav-id="/config/vault/index.html" class=""><a class="padding" href="/config/vault/index.html">Vault</a></li></ul></li>
<li data-nav-id="/cli/index.html" class=""><a class="padding" href="/cli/index.html">CLI</a></li>
<li data-nav-id="/repositories/index.html" class=""><a class="padding" href="/repositories/index.html">Repositories</a></li>
</ul>
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div class="padding footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
<hr class="padding default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
<ul>
<li id="select-language-container" class="footerLangSwitch">
@ -296,6 +291,7 @@
<div class="select-style">
<label class="a11y-only" for="select-language">Language</label>
<select id="select-language" onchange="location = baseUri + this.value;">
<option lang="en" id="en" value="/config/notifications/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -315,7 +311,7 @@
</div>
<script>window.variants && variants.markSelectedVariant();</script>
</li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
<li class="footerVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i><span>&nbsp;</span>Clear History</button></li>
</ul>
</div>
<div id="footer" class="footerFooter showFooter">
@ -323,8 +319,8 @@
</div>
</div>
</aside>
<script src="/js/clipboard.min.js?1676866111" defer></script>
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
<script src="/js/clipboard.min.js?1732082585" defer></script>
<script src="/js/perfect-scrollbar.min.js?1732082585" defer></script>
<script>
function useMathJax( config ){
if( !Object.assign ){
@ -354,23 +350,19 @@
useMathJax( JSON.parse("{}") );
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="/js/d3/d3-color.min.js?1676866111" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1676866111" defer></script>
<script src="/js/d3/d3-drag.min.js?1676866111" defer></script>
<script src="/js/d3/d3-ease.min.js?1676866111" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1676866111" defer></script>
<script src="/js/d3/d3-selection.min.js?1676866111" defer></script>
<script src="/js/d3/d3-timer.min.js?1676866111" defer></script>
<script src="/js/d3/d3-transition.min.js?1676866111" defer></script>
<script src="/js/d3/d3-zoom.min.js?1676866111" defer></script>
<script src="/js/d3/d3-color.min.js?1732082585" defer></script>
<script src="/js/d3/d3-dispatch.min.js?1732082585" defer></script>
<script src="/js/d3/d3-drag.min.js?1732082585" defer></script>
<script src="/js/d3/d3-ease.min.js?1732082585" defer></script>
<script src="/js/d3/d3-interpolate.min.js?1732082585" defer></script>
<script src="/js/d3/d3-selection.min.js?1732082585" defer></script>
<script src="/js/d3/d3-timer.min.js?1732082585" defer></script>
<script src="/js/d3/d3-transition.min.js?1732082585" defer></script>
<script src="/js/d3/d3-zoom.min.js?1732082585" defer></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js" defer></script>
<script>
window.themeUseMermaid = JSON.parse("{ \"theme\": \"default\" }");
</script>
<script src="https://unpkg.com/rapidoc/dist/rapidoc-min.js" defer></script>
<script>
window.themeUseSwagger = JSON.parse("{ \"theme\": \"light\" }");
</script>
<script src="/js/theme.js?1676866111" defer></script>
<script src="/js/theme.js?1732082585" defer></script>
</body>
</html>