v0.3.0
* Getting environment variables and passwords from Vault (not tested yet) * Vault configuration to config (not tested yet) * Ability to run scripts from file on local machine on the remote host * Ability to get ouput in the notification of a list for individual commands or all commands * Make SSH connections close after all commands have been run; reuse previous connections if needed
This commit is contained in:
1 parent
5e7c52997c
commit
4b382bddd9
831 files changed
+83782
-107
No files matched your search
@@ -0,0 +1,327 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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="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>
|
||||
<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
|
||||
window.index_js_url="/index.search.js";
|
||||
var root_url="/";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='http:\/\/example.org/';
|
||||
window.variants && variants.init( [ 'auto' ] );
|
||||
</script>
|
||||
</head>
|
||||
<body class="mobile-support html" data-url="/config/command-lists/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<span id="toc-menu" title='Table of Contents (CTRL+ALT+t)'><i class="fas fa-list-alt fa-fw"></i></span>
|
||||
<span class="links">
|
||||
Command Lists
|
||||
</span>
|
||||
</div>
|
||||
<div class="default-animation progress">
|
||||
<div class="toc-wrapper" dir="ltr">
|
||||
<nav id="TableOfContents">
|
||||
<ul>
|
||||
<li>
|
||||
<ul>
|
||||
<li><a href="#order">Order</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>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<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>
|
||||
</table>
|
||||
<h3 id="order">Order</h3>
|
||||
<p>The order is an array of commands to execute in order. Each command must be defined.</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’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>
|
||||
|
||||
<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">"0 0 1 * * *"</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>
|
||||
</span></span></code></pre></div>
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<aside id="sidebar" class="default-animation" dir="ltr">
|
||||
<div id="header-wrapper" class="default-animation">
|
||||
<div id="header" class="default-animation">
|
||||
<style>
|
||||
a#logo {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
|
||||
font-size: 30px;
|
||||
font-weight: 300;
|
||||
margin-top: -13px;
|
||||
|
||||
text-transform: uppercase;
|
||||
width: 256px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
a#logo:hover {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -20px;
|
||||
margin-left: -23.5px;
|
||||
width: 40.5%;
|
||||
}
|
||||
@media only all and (max-width: 59.938em) {
|
||||
a#logo {
|
||||
font-size: 25px;
|
||||
margin-top: -3px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -12px;
|
||||
margin-left: -23px;
|
||||
}
|
||||
}
|
||||
@media all and (-ms-high-contrast:none) {
|
||||
/* IE11s understanding of positioning is weird at best */
|
||||
a#logo {
|
||||
margin-top: -58px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -62px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
<a id="logo" href="/index.html">
|
||||
<svg version="1.1" id="_x36_" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="-51.2 -51.2 614.40 614.40" xml:space="preserve" width="128px" height="128px" fill="#ffffff" stroke="#ffffff" stroke-width="0.00512" transform="rotate(0)"><g id="SVGRepo_bgCarrier" stroke-width="0"><rect x="-51.2" y="-51.2" width="614.40" height="614.40" rx="0" fill="#000000" strokewidth="0"></rect></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <g> <polygon style="fill:none;" points="275.211,140.527 360.241,140.527 380.083,120.685 275.211,120.685 "></polygon> <polygon style="fill:none;" points="232.234,268.534 219.714,281.054 232.234,281.054 "></polygon> <g> <g> <rect x="232.254" y="69.157" style="fill:#718176;" width="42.982" height="377.465"></rect> <polygon style="fill:#718176;" points="56.146,446.588 76.861,489.564 232.234,489.564 232.234,446.588 "></polygon> <polygon style="fill:#718176;" points="275.21,446.588 275.21,489.564 435.111,489.564 455.826,446.588 "></polygon> <rect x="232.234" y="446.588" style="fill:#979696;" width="42.977" height="42.977"></rect> <path style="fill:#718176;" d="M511.972,7.837v105.05c0,4.315-3.485,7.8-7.8,7.8H7.8c-4.315,0-7.8-3.485-7.8-7.8V7.837 c0-4.315,3.485-7.799,7.8-7.799h496.372C508.487,0.037,511.972,3.522,511.972,7.837z"></path> <path style="fill:#718176;" d="M511.972,148.318v105.05c0,4.315-3.485,7.883-7.8,7.883H7.8c-4.315,0-7.8-3.568-7.8-7.883v-105.05 c0-4.315,3.485-7.8,7.8-7.8h496.372C508.487,140.518,511.972,144.003,511.972,148.318z"></path> <path style="fill:#718176;" d="M511.972,288.882v105.05c0,4.315-3.485,7.799-7.8,7.799H7.8c-4.315,0-7.8-3.484-7.8-7.799v-105.05 c0-4.314,3.485-7.799,7.8-7.799h496.372C508.487,281.082,511.972,284.568,511.972,288.882z"></path> <path style="fill:#FFFFFF;" d="M492.427,6.264H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.309,13.31,13.309h472.882c7.351,0,13.31-5.959,13.31-13.309V19.573 C505.737,12.222,499.778,6.264,492.427,6.264z"></path> <path style="fill:#FFFFFF;" d="M492.427,146.79H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539c0,7.351,5.959,13.31,13.31,13.31 h472.882c7.351,0,13.31-5.959,13.31-13.31V160.1C505.737,152.749,499.778,146.79,492.427,146.79z"></path> <path style="fill:#FFFFFF;" d="M492.427,287.318H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.31,13.31,13.31h472.882c7.351,0,13.31-5.959,13.31-13.31v-81.539 C505.737,293.276,499.778,287.318,492.427,287.318z"></path> <g> <g> <path style="fill:#718176;" d="M57.355,26.558H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C59.471,27.505,58.524,26.558,57.355,26.558z"></path> <path style="fill:#718176;" d="M57.355,52.308H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C59.471,53.256,58.524,52.308,57.355,52.308z"></path> <path style="fill:#718176;" d="M57.355,78.059H43.829c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C59.471,79.006,58.524,78.059,57.355,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M89.021,26.558H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C91.137,27.505,90.19,26.558,89.021,26.558z"></path> <path style="fill:#718176;" d="M89.021,52.308H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C91.137,53.256,90.19,52.308,89.021,52.308z"></path> <path style="fill:#718176;" d="M89.021,78.059H75.495c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C91.137,79.006,90.19,78.059,89.021,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M120.687,26.558h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V28.674 C122.804,27.505,121.856,26.558,120.687,26.558z"></path> <path style="fill:#718176;" d="M120.687,52.308h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V54.424 C122.804,53.256,121.856,52.308,120.687,52.308z"></path> <path style="fill:#718176;" d="M120.687,78.059h-13.525c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V80.175 C122.804,79.006,121.856,78.059,120.687,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M152.354,26.558h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C154.47,27.505,153.522,26.558,152.354,26.558 z"></path> <path style="fill:#718176;" d="M152.354,52.308h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C154.47,53.256Line truncated
|
||||
Backy
|
||||
</a>
|
||||
</div>
|
||||
<div class="searchbox default-animation">
|
||||
<i class="fas fa-search" title="Search (CTRL+ALT+f)"></i>
|
||||
<label class="a11y-only" for="search-by">Search</label>
|
||||
<input data-search-input id="search-by" name="search-by" class="search-by" type="search" placeholder="Search...">
|
||||
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
||||
</div>
|
||||
<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>
|
||||
</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>
|
||||
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
|
||||
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
|
||||
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
|
||||
<ul>
|
||||
<li id="select-language-container" class="footerLangSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-language fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-language">Language</label>
|
||||
<select id="select-language" onchange="location = baseUri + this.value;">
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
</li>
|
||||
<li id="select-variant-container" class="footerVariantSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-paint-brush fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-variant">Theme</label>
|
||||
<select id="select-variant" onchange="window.variants && variants.changeVariant( this.value );">
|
||||
<option id="auto" value="auto" selected>Auto</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</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>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="footer" class="footerFooter showFooter">
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="/js/clipboard.min.js?1676866111" defer></script>
|
||||
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
|
||||
<script>
|
||||
function useMathJax( config ){
|
||||
if( !Object.assign ){
|
||||
|
||||
return;
|
||||
}
|
||||
window.MathJax = Object.assign( window.MathJax || {}, {
|
||||
loader: {
|
||||
load: ['[tex]/mhchem']
|
||||
},
|
||||
startup: {
|
||||
elements: [
|
||||
'.math'
|
||||
]
|
||||
},
|
||||
tex: {
|
||||
inlineMath: [
|
||||
['$', '$'],
|
||||
['\\(', '\\)']
|
||||
]
|
||||
},
|
||||
options: {
|
||||
enableMenu: false
|
||||
}
|
||||
}, config );
|
||||
}
|
||||
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="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>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,353 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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="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>
|
||||
<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
|
||||
window.index_js_url="/index.search.js";
|
||||
var root_url="/";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='http:\/\/example.org/';
|
||||
window.variants && variants.init( [ 'auto' ] );
|
||||
</script>
|
||||
</head>
|
||||
<body class="mobile-support html" data-url="/config/commands/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<span id="toc-menu" title='Table of Contents (CTRL+ALT+t)'><i class="fas fa-list-alt fa-fw"></i></span>
|
||||
<span class="links">
|
||||
Commands
|
||||
</span>
|
||||
</div>
|
||||
<div class="default-animation progress">
|
||||
<div class="toc-wrapper" dir="ltr">
|
||||
<nav id="TableOfContents">
|
||||
<ul>
|
||||
<li>
|
||||
<ul>
|
||||
<li></li>
|
||||
<li><a href="#shell">shell</a></li>
|
||||
<li><a href="#environment">environment</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<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>
|
||||
<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>
|
||||
</span></span><span style="display:flex;"><span> <span style="color:#f92672">Args</span>:
|
||||
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">compose</span>
|
||||
</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:#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>
|
||||
</table>
|
||||
<h4 id="cmd">cmd</h4>
|
||||
<p>cmd must be a valid command or script to execute.</p>
|
||||
<h4 id="args">args</h4>
|
||||
<p>args must be arguments to cmd as they would be on the command-line:</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-sh" data-lang="sh"><span style="display:flex;"><span>cmd <span style="color:#f92672">[</span>arg1 arg2 ...<span style="color:#f92672">]</span>
|
||||
</span></span></code></pre></div><p>Define them in an array:</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">args</span>:
|
||||
</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>
|
||||
|
||||
<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>
|
||||
<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’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>
|
||||
<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="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>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’s environment is added.</p>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<aside id="sidebar" class="default-animation" dir="ltr">
|
||||
<div id="header-wrapper" class="default-animation">
|
||||
<div id="header" class="default-animation">
|
||||
<style>
|
||||
a#logo {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
|
||||
font-size: 30px;
|
||||
font-weight: 300;
|
||||
margin-top: -13px;
|
||||
|
||||
text-transform: uppercase;
|
||||
width: 256px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
a#logo:hover {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -20px;
|
||||
margin-left: -23.5px;
|
||||
width: 40.5%;
|
||||
}
|
||||
@media only all and (max-width: 59.938em) {
|
||||
a#logo {
|
||||
font-size: 25px;
|
||||
margin-top: -3px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -12px;
|
||||
margin-left: -23px;
|
||||
}
|
||||
}
|
||||
@media all and (-ms-high-contrast:none) {
|
||||
/* IE11s understanding of positioning is weird at best */
|
||||
a#logo {
|
||||
margin-top: -58px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -62px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
<a id="logo" href="/index.html">
|
||||
<svg version="1.1" id="_x36_" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="-51.2 -51.2 614.40 614.40" xml:space="preserve" width="128px" height="128px" fill="#ffffff" stroke="#ffffff" stroke-width="0.00512" transform="rotate(0)"><g id="SVGRepo_bgCarrier" stroke-width="0"><rect x="-51.2" y="-51.2" width="614.40" height="614.40" rx="0" fill="#000000" strokewidth="0"></rect></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <g> <polygon style="fill:none;" points="275.211,140.527 360.241,140.527 380.083,120.685 275.211,120.685 "></polygon> <polygon style="fill:none;" points="232.234,268.534 219.714,281.054 232.234,281.054 "></polygon> <g> <g> <rect x="232.254" y="69.157" style="fill:#718176;" width="42.982" height="377.465"></rect> <polygon style="fill:#718176;" points="56.146,446.588 76.861,489.564 232.234,489.564 232.234,446.588 "></polygon> <polygon style="fill:#718176;" points="275.21,446.588 275.21,489.564 435.111,489.564 455.826,446.588 "></polygon> <rect x="232.234" y="446.588" style="fill:#979696;" width="42.977" height="42.977"></rect> <path style="fill:#718176;" d="M511.972,7.837v105.05c0,4.315-3.485,7.8-7.8,7.8H7.8c-4.315,0-7.8-3.485-7.8-7.8V7.837 c0-4.315,3.485-7.799,7.8-7.799h496.372C508.487,0.037,511.972,3.522,511.972,7.837z"></path> <path style="fill:#718176;" d="M511.972,148.318v105.05c0,4.315-3.485,7.883-7.8,7.883H7.8c-4.315,0-7.8-3.568-7.8-7.883v-105.05 c0-4.315,3.485-7.8,7.8-7.8h496.372C508.487,140.518,511.972,144.003,511.972,148.318z"></path> <path style="fill:#718176;" d="M511.972,288.882v105.05c0,4.315-3.485,7.799-7.8,7.799H7.8c-4.315,0-7.8-3.484-7.8-7.799v-105.05 c0-4.314,3.485-7.799,7.8-7.799h496.372C508.487,281.082,511.972,284.568,511.972,288.882z"></path> <path style="fill:#FFFFFF;" d="M492.427,6.264H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.309,13.31,13.309h472.882c7.351,0,13.31-5.959,13.31-13.309V19.573 C505.737,12.222,499.778,6.264,492.427,6.264z"></path> <path style="fill:#FFFFFF;" d="M492.427,146.79H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539c0,7.351,5.959,13.31,13.31,13.31 h472.882c7.351,0,13.31-5.959,13.31-13.31V160.1C505.737,152.749,499.778,146.79,492.427,146.79z"></path> <path style="fill:#FFFFFF;" d="M492.427,287.318H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.31,13.31,13.31h472.882c7.351,0,13.31-5.959,13.31-13.31v-81.539 C505.737,293.276,499.778,287.318,492.427,287.318z"></path> <g> <g> <path style="fill:#718176;" d="M57.355,26.558H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C59.471,27.505,58.524,26.558,57.355,26.558z"></path> <path style="fill:#718176;" d="M57.355,52.308H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C59.471,53.256,58.524,52.308,57.355,52.308z"></path> <path style="fill:#718176;" d="M57.355,78.059H43.829c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C59.471,79.006,58.524,78.059,57.355,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M89.021,26.558H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C91.137,27.505,90.19,26.558,89.021,26.558z"></path> <path style="fill:#718176;" d="M89.021,52.308H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C91.137,53.256,90.19,52.308,89.021,52.308z"></path> <path style="fill:#718176;" d="M89.021,78.059H75.495c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C91.137,79.006,90.19,78.059,89.021,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M120.687,26.558h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V28.674 C122.804,27.505,121.856,26.558,120.687,26.558z"></path> <path style="fill:#718176;" d="M120.687,52.308h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V54.424 C122.804,53.256,121.856,52.308,120.687,52.308z"></path> <path style="fill:#718176;" d="M120.687,78.059h-13.525c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V80.175 C122.804,79.006,121.856,78.059,120.687,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M152.354,26.558h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C154.47,27.505,153.522,26.558,152.354,26.558 z"></path> <path style="fill:#718176;" d="M152.354,52.308h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C154.47,53.256Line truncated
|
||||
Backy
|
||||
</a>
|
||||
</div>
|
||||
<div class="searchbox default-animation">
|
||||
<i class="fas fa-search" title="Search (CTRL+ALT+f)"></i>
|
||||
<label class="a11y-only" for="search-by">Search</label>
|
||||
<input data-search-input id="search-by" name="search-by" class="search-by" type="search" placeholder="Search...">
|
||||
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
||||
</div>
|
||||
<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>
|
||||
</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>
|
||||
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
|
||||
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
|
||||
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
|
||||
<ul>
|
||||
<li id="select-language-container" class="footerLangSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-language fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-language">Language</label>
|
||||
<select id="select-language" onchange="location = baseUri + this.value;">
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
</li>
|
||||
<li id="select-variant-container" class="footerVariantSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-paint-brush fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-variant">Theme</label>
|
||||
<select id="select-variant" onchange="window.variants && variants.changeVariant( this.value );">
|
||||
<option id="auto" value="auto" selected>Auto</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</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>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="footer" class="footerFooter showFooter">
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="/js/clipboard.min.js?1676866111" defer></script>
|
||||
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
|
||||
<script>
|
||||
function useMathJax( config ){
|
||||
if( !Object.assign ){
|
||||
|
||||
return;
|
||||
}
|
||||
window.MathJax = Object.assign( window.MathJax || {}, {
|
||||
loader: {
|
||||
load: ['[tex]/mhchem']
|
||||
},
|
||||
startup: {
|
||||
elements: [
|
||||
'.math'
|
||||
]
|
||||
},
|
||||
tex: {
|
||||
inlineMath: [
|
||||
['$', '$'],
|
||||
['\\(', '\\)']
|
||||
]
|
||||
},
|
||||
options: {
|
||||
enableMenu: false
|
||||
}
|
||||
}, config );
|
||||
}
|
||||
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="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>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,251 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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="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>
|
||||
<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
|
||||
window.index_js_url="/index.search.js";
|
||||
var root_url="/";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='http:\/\/example.org/';
|
||||
window.variants && variants.init( [ 'auto' ] );
|
||||
</script>
|
||||
</head>
|
||||
<body class="mobile-support html" data-url="/config/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<span class="links">
|
||||
Configuring Backy
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<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>
|
||||
<p>If you leave the config path blank, the following paths will be searched in order:</p>
|
||||
<ul>
|
||||
<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>
|
||||
<p>Create a file at <code>~/.config/backy.yml</code>.</p>
|
||||
<p>See 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">
|
||||
<div id="header-wrapper" class="default-animation">
|
||||
<div id="header" class="default-animation">
|
||||
<style>
|
||||
a#logo {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
|
||||
font-size: 30px;
|
||||
font-weight: 300;
|
||||
margin-top: -13px;
|
||||
|
||||
text-transform: uppercase;
|
||||
width: 256px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
a#logo:hover {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -20px;
|
||||
margin-left: -23.5px;
|
||||
width: 40.5%;
|
||||
}
|
||||
@media only all and (max-width: 59.938em) {
|
||||
a#logo {
|
||||
font-size: 25px;
|
||||
margin-top: -3px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -12px;
|
||||
margin-left: -23px;
|
||||
}
|
||||
}
|
||||
@media all and (-ms-high-contrast:none) {
|
||||
/* IE11s understanding of positioning is weird at best */
|
||||
a#logo {
|
||||
margin-top: -58px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -62px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
<a id="logo" href="/index.html">
|
||||
<svg version="1.1" id="_x36_" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="-51.2 -51.2 614.40 614.40" xml:space="preserve" width="128px" height="128px" fill="#ffffff" stroke="#ffffff" stroke-width="0.00512" transform="rotate(0)"><g id="SVGRepo_bgCarrier" stroke-width="0"><rect x="-51.2" y="-51.2" width="614.40" height="614.40" rx="0" fill="#000000" strokewidth="0"></rect></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <g> <polygon style="fill:none;" points="275.211,140.527 360.241,140.527 380.083,120.685 275.211,120.685 "></polygon> <polygon style="fill:none;" points="232.234,268.534 219.714,281.054 232.234,281.054 "></polygon> <g> <g> <rect x="232.254" y="69.157" style="fill:#718176;" width="42.982" height="377.465"></rect> <polygon style="fill:#718176;" points="56.146,446.588 76.861,489.564 232.234,489.564 232.234,446.588 "></polygon> <polygon style="fill:#718176;" points="275.21,446.588 275.21,489.564 435.111,489.564 455.826,446.588 "></polygon> <rect x="232.234" y="446.588" style="fill:#979696;" width="42.977" height="42.977"></rect> <path style="fill:#718176;" d="M511.972,7.837v105.05c0,4.315-3.485,7.8-7.8,7.8H7.8c-4.315,0-7.8-3.485-7.8-7.8V7.837 c0-4.315,3.485-7.799,7.8-7.799h496.372C508.487,0.037,511.972,3.522,511.972,7.837z"></path> <path style="fill:#718176;" d="M511.972,148.318v105.05c0,4.315-3.485,7.883-7.8,7.883H7.8c-4.315,0-7.8-3.568-7.8-7.883v-105.05 c0-4.315,3.485-7.8,7.8-7.8h496.372C508.487,140.518,511.972,144.003,511.972,148.318z"></path> <path style="fill:#718176;" d="M511.972,288.882v105.05c0,4.315-3.485,7.799-7.8,7.799H7.8c-4.315,0-7.8-3.484-7.8-7.799v-105.05 c0-4.314,3.485-7.799,7.8-7.799h496.372C508.487,281.082,511.972,284.568,511.972,288.882z"></path> <path style="fill:#FFFFFF;" d="M492.427,6.264H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.309,13.31,13.309h472.882c7.351,0,13.31-5.959,13.31-13.309V19.573 C505.737,12.222,499.778,6.264,492.427,6.264z"></path> <path style="fill:#FFFFFF;" d="M492.427,146.79H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539c0,7.351,5.959,13.31,13.31,13.31 h472.882c7.351,0,13.31-5.959,13.31-13.31V160.1C505.737,152.749,499.778,146.79,492.427,146.79z"></path> <path style="fill:#FFFFFF;" d="M492.427,287.318H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.31,13.31,13.31h472.882c7.351,0,13.31-5.959,13.31-13.31v-81.539 C505.737,293.276,499.778,287.318,492.427,287.318z"></path> <g> <g> <path style="fill:#718176;" d="M57.355,26.558H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C59.471,27.505,58.524,26.558,57.355,26.558z"></path> <path style="fill:#718176;" d="M57.355,52.308H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C59.471,53.256,58.524,52.308,57.355,52.308z"></path> <path style="fill:#718176;" d="M57.355,78.059H43.829c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C59.471,79.006,58.524,78.059,57.355,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M89.021,26.558H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C91.137,27.505,90.19,26.558,89.021,26.558z"></path> <path style="fill:#718176;" d="M89.021,52.308H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C91.137,53.256,90.19,52.308,89.021,52.308z"></path> <path style="fill:#718176;" d="M89.021,78.059H75.495c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C91.137,79.006,90.19,78.059,89.021,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M120.687,26.558h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V28.674 C122.804,27.505,121.856,26.558,120.687,26.558z"></path> <path style="fill:#718176;" d="M120.687,52.308h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V54.424 C122.804,53.256,121.856,52.308,120.687,52.308z"></path> <path style="fill:#718176;" d="M120.687,78.059h-13.525c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V80.175 C122.804,79.006,121.856,78.059,120.687,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M152.354,26.558h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C154.47,27.505,153.522,26.558,152.354,26.558 z"></path> <path style="fill:#718176;" d="M152.354,52.308h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C154.47,53.256Line truncated
|
||||
Backy
|
||||
</a>
|
||||
</div>
|
||||
<div class="searchbox default-animation">
|
||||
<i class="fas fa-search" title="Search (CTRL+ALT+f)"></i>
|
||||
<label class="a11y-only" for="search-by">Search</label>
|
||||
<input data-search-input id="search-by" name="search-by" class="search-by" type="search" placeholder="Search...">
|
||||
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
||||
</div>
|
||||
<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>
|
||||
</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>
|
||||
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
|
||||
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
|
||||
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
|
||||
<ul>
|
||||
<li id="select-language-container" class="footerLangSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-language fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-language">Language</label>
|
||||
<select id="select-language" onchange="location = baseUri + this.value;">
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
</li>
|
||||
<li id="select-variant-container" class="footerVariantSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-paint-brush fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-variant">Theme</label>
|
||||
<select id="select-variant" onchange="window.variants && variants.changeVariant( this.value );">
|
||||
<option id="auto" value="auto" selected>Auto</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</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>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="footer" class="footerFooter showFooter">
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="/js/clipboard.min.js?1676866111" defer></script>
|
||||
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
|
||||
<script>
|
||||
function useMathJax( config ){
|
||||
if( !Object.assign ){
|
||||
|
||||
return;
|
||||
}
|
||||
window.MathJax = Object.assign( window.MathJax || {}, {
|
||||
loader: {
|
||||
load: ['[tex]/mhchem']
|
||||
},
|
||||
startup: {
|
||||
elements: [
|
||||
'.math'
|
||||
]
|
||||
},
|
||||
tex: {
|
||||
inlineMath: [
|
||||
['$', '$'],
|
||||
['\\(', '\\)']
|
||||
]
|
||||
},
|
||||
options: {
|
||||
enableMenu: false
|
||||
}
|
||||
}, config );
|
||||
}
|
||||
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="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>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,39 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Configuring Backy on A tool for commands</title>
|
||||
<link>http://example.org/config/index.html</link>
|
||||
<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>
|
||||
</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>
|
||||
</item>
|
||||
</channel>
|
||||
</rss>
|
||||
@@ -0,0 +1,376 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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="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>
|
||||
<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
|
||||
window.index_js_url="/index.search.js";
|
||||
var root_url="/";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='http:\/\/example.org/';
|
||||
window.variants && variants.init( [ 'auto' ] );
|
||||
</script>
|
||||
</head>
|
||||
<body class="mobile-support html" data-url="/config/notifications/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<span id="toc-menu" title='Table of Contents (CTRL+ALT+t)'><i class="fas fa-list-alt fa-fw"></i></span>
|
||||
<span class="links">
|
||||
Notifications
|
||||
</span>
|
||||
</div>
|
||||
<div class="default-animation progress">
|
||||
<div class="toc-wrapper" dir="ltr">
|
||||
<nav id="TableOfContents">
|
||||
<ul>
|
||||
<li>
|
||||
<ul>
|
||||
<li><a href="#type-mail">type: mail</a></li>
|
||||
<li><a href="#type-matrix">type: matrix</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<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>
|
||||
<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></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’s object and its keys are listed below.</p>
|
||||
<h3 id="type-mail">type: 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>
|
||||
</table>
|
||||
<h3 id="type-matrix">type: 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>
|
||||
</table>
|
||||
<p>To get your access token (assumes you are using <a href="https://element.io/" target="_blank">Element</a>) :</p>
|
||||
<ol>
|
||||
<li>Log in to the account you want to get the access token for. Click on the name in the top left corner, then “Settings”.</li>
|
||||
<li>Click the “Help & About” tab (left side of the dialog).</li>
|
||||
<li>Scroll to the bottom and click on <code><click to reveal></code> part of Access Token.</li>
|
||||
<li>Copy your access token to a safe place.</li>
|
||||
</ol>
|
||||
<p>To get the room ID:</p>
|
||||
<ol>
|
||||
<li>On Element or a similar client, navigate to the room.</li>
|
||||
<li>Navigate to the settings from the top menu.</li>
|
||||
<li>Click on Advanced, the room ID is there.</li>
|
||||
</ol>
|
||||
|
||||
<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>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<aside id="sidebar" class="default-animation" dir="ltr">
|
||||
<div id="header-wrapper" class="default-animation">
|
||||
<div id="header" class="default-animation">
|
||||
<style>
|
||||
a#logo {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
|
||||
font-size: 30px;
|
||||
font-weight: 300;
|
||||
margin-top: -13px;
|
||||
|
||||
text-transform: uppercase;
|
||||
width: 256px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
a#logo:hover {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -20px;
|
||||
margin-left: -23.5px;
|
||||
width: 40.5%;
|
||||
}
|
||||
@media only all and (max-width: 59.938em) {
|
||||
a#logo {
|
||||
font-size: 25px;
|
||||
margin-top: -3px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -12px;
|
||||
margin-left: -23px;
|
||||
}
|
||||
}
|
||||
@media all and (-ms-high-contrast:none) {
|
||||
/* IE11s understanding of positioning is weird at best */
|
||||
a#logo {
|
||||
margin-top: -58px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -62px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
<a id="logo" href="/index.html">
|
||||
<svg version="1.1" id="_x36_" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="-51.2 -51.2 614.40 614.40" xml:space="preserve" width="128px" height="128px" fill="#ffffff" stroke="#ffffff" stroke-width="0.00512" transform="rotate(0)"><g id="SVGRepo_bgCarrier" stroke-width="0"><rect x="-51.2" y="-51.2" width="614.40" height="614.40" rx="0" fill="#000000" strokewidth="0"></rect></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <g> <polygon style="fill:none;" points="275.211,140.527 360.241,140.527 380.083,120.685 275.211,120.685 "></polygon> <polygon style="fill:none;" points="232.234,268.534 219.714,281.054 232.234,281.054 "></polygon> <g> <g> <rect x="232.254" y="69.157" style="fill:#718176;" width="42.982" height="377.465"></rect> <polygon style="fill:#718176;" points="56.146,446.588 76.861,489.564 232.234,489.564 232.234,446.588 "></polygon> <polygon style="fill:#718176;" points="275.21,446.588 275.21,489.564 435.111,489.564 455.826,446.588 "></polygon> <rect x="232.234" y="446.588" style="fill:#979696;" width="42.977" height="42.977"></rect> <path style="fill:#718176;" d="M511.972,7.837v105.05c0,4.315-3.485,7.8-7.8,7.8H7.8c-4.315,0-7.8-3.485-7.8-7.8V7.837 c0-4.315,3.485-7.799,7.8-7.799h496.372C508.487,0.037,511.972,3.522,511.972,7.837z"></path> <path style="fill:#718176;" d="M511.972,148.318v105.05c0,4.315-3.485,7.883-7.8,7.883H7.8c-4.315,0-7.8-3.568-7.8-7.883v-105.05 c0-4.315,3.485-7.8,7.8-7.8h496.372C508.487,140.518,511.972,144.003,511.972,148.318z"></path> <path style="fill:#718176;" d="M511.972,288.882v105.05c0,4.315-3.485,7.799-7.8,7.799H7.8c-4.315,0-7.8-3.484-7.8-7.799v-105.05 c0-4.314,3.485-7.799,7.8-7.799h496.372C508.487,281.082,511.972,284.568,511.972,288.882z"></path> <path style="fill:#FFFFFF;" d="M492.427,6.264H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.309,13.31,13.309h472.882c7.351,0,13.31-5.959,13.31-13.309V19.573 C505.737,12.222,499.778,6.264,492.427,6.264z"></path> <path style="fill:#FFFFFF;" d="M492.427,146.79H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539c0,7.351,5.959,13.31,13.31,13.31 h472.882c7.351,0,13.31-5.959,13.31-13.31V160.1C505.737,152.749,499.778,146.79,492.427,146.79z"></path> <path style="fill:#FFFFFF;" d="M492.427,287.318H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.31,13.31,13.31h472.882c7.351,0,13.31-5.959,13.31-13.31v-81.539 C505.737,293.276,499.778,287.318,492.427,287.318z"></path> <g> <g> <path style="fill:#718176;" d="M57.355,26.558H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C59.471,27.505,58.524,26.558,57.355,26.558z"></path> <path style="fill:#718176;" d="M57.355,52.308H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C59.471,53.256,58.524,52.308,57.355,52.308z"></path> <path style="fill:#718176;" d="M57.355,78.059H43.829c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C59.471,79.006,58.524,78.059,57.355,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M89.021,26.558H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C91.137,27.505,90.19,26.558,89.021,26.558z"></path> <path style="fill:#718176;" d="M89.021,52.308H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C91.137,53.256,90.19,52.308,89.021,52.308z"></path> <path style="fill:#718176;" d="M89.021,78.059H75.495c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C91.137,79.006,90.19,78.059,89.021,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M120.687,26.558h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V28.674 C122.804,27.505,121.856,26.558,120.687,26.558z"></path> <path style="fill:#718176;" d="M120.687,52.308h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V54.424 C122.804,53.256,121.856,52.308,120.687,52.308z"></path> <path style="fill:#718176;" d="M120.687,78.059h-13.525c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.525c1.169,0,2.116-0.948,2.116-2.116V80.175 C122.804,79.006,121.856,78.059,120.687,78.059z"></path> </g> <g> <path style="fill:#718176;" d="M152.354,26.558h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C154.47,27.505,153.522,26.558,152.354,26.558 z"></path> <path style="fill:#718176;" d="M152.354,52.308h-13.526c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.947,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C154.47,53.256Line truncated
|
||||
Backy
|
||||
</a>
|
||||
</div>
|
||||
<div class="searchbox default-animation">
|
||||
<i class="fas fa-search" title="Search (CTRL+ALT+f)"></i>
|
||||
<label class="a11y-only" for="search-by">Search</label>
|
||||
<input data-search-input id="search-by" name="search-by" class="search-by" type="search" placeholder="Search...">
|
||||
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
||||
</div>
|
||||
<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>
|
||||
</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>
|
||||
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter"></div>
|
||||
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter">
|
||||
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks">
|
||||
<ul>
|
||||
<li id="select-language-container" class="footerLangSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-language fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-language">Language</label>
|
||||
<select id="select-language" onchange="location = baseUri + this.value;">
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
</li>
|
||||
<li id="select-variant-container" class="footerVariantSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-paint-brush fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-variant">Theme</label>
|
||||
<select id="select-variant" onchange="window.variants && variants.changeVariant( this.value );">
|
||||
<option id="auto" value="auto" selected>Auto</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</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>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="footer" class="footerFooter showFooter">
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="/js/clipboard.min.js?1676866111" defer></script>
|
||||
<script src="/js/perfect-scrollbar.min.js?1676866111" defer></script>
|
||||
<script>
|
||||
function useMathJax( config ){
|
||||
if( !Object.assign ){
|
||||
|
||||
return;
|
||||
}
|
||||
window.MathJax = Object.assign( window.MathJax || {}, {
|
||||
loader: {
|
||||
load: ['[tex]/mhchem']
|
||||
},
|
||||
startup: {
|
||||
elements: [
|
||||
'.math'
|
||||
]
|
||||
},
|
||||
tex: {
|
||||
inlineMath: [
|
||||
['$', '$'],
|
||||
['\\(', '\\)']
|
||||
]
|
||||
},
|
||||
options: {
|
||||
enableMenu: false
|
||||
}
|
||||
}, config );
|
||||
}
|
||||
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="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>
|
||||
</body>
|
||||
</html>
|
||||
Reference in new issue
Block a user