CyberShell/backy
1
1
Fork 0
Code Issues 7 Pull Requests Packages Projects 1 Releases 9 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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.woodpecker/publish-docs.yml
View File

@ -1,6 +1,7 @@
steps:
build:
image: klakegg/hugo:ext-debian-ci
pull: true
commands:
- git submodule foreach 'git fetch origin; git checkout $(git describe --tags `git rev-list --tags --max-count=1`);'
- cd docs

2
docs/content/config/_index.md
View File

@ -7,7 +7,7 @@ description: >
This is the section on the config file.
To use a specific file:
To use a specific file use the `-f` CLI flag:
```backy [command] -f /path/to/file```
If you leave the config path blank, the following paths will be searched in order:

143
docs/public/404.html
View File

@ -3,23 +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="">
<title>404 Page not found - A tool for commands</title>
<base href="http://example.org/">
<!-- 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
@ -38,26 +39,124 @@
window.variants && variants.init( [ 'auto' ] );
</script>
<style>
p, li, ul {
p {
text-align: center
}
ul {
list-style-type: none;
.notfound #body {
max-width: 100%;
min-width: 100%;
width: 100%;
}
.notfound h1 {
color: var(--MAIN-TEXT-color);
line-height: 1;
font-size: 5rem;
overflow: hidden;
}
.notfound h1 span {
font-size: 6.5rem;
font-weight: 500;
}
.notfound h1 i {
font-size: 5rem;
vertical-align: text-top;
}
.notfound h2 {
color: var(--MAIN-TEXT-color);
font-size: 2.5rem;
font-weight: 500;
padding: 0;
text-align: center;
}
#shrug svg,
#shrug svg * {
color: #000000;
color: var(--MAIN-TEXT-color);
fill: #000000 !important;
fill: var(--MAIN-TEXT-color) !important;
}
#shrug svg{
transform: scaleX(-1);
width: 15rem;
}
</style>
</head>
<body class="mobile-support" data-url="/404.html">
<div id="body" class="default-animation" style="margin-left:0px;">
<body class="mobile-support html notfound" data-url="/404.html">
<div id="body" class="default-animation" style="margin-left: 0;">
<div id="sidebar-overlay"></div>
<main id="body-inner" class="chapter" tabindex="-1">
<div class="flex-block-wrapper">
<article class="default">
<h1 id="error">Error</h1>
<article>
<h1 id="404"><span>4</span><i class="far fa-frown"></i><span>4</span></h1>
<h2 id="not-found">Not found</h2>
<p></p>
<p>Woops. Looks like this page doesn&#39;t exist ¯\_(ツ)_/¯.</p>
<p></p>
<p><a href="/index.html">Go to homepage</a></p>
<p><img src="/images/gopher-404.jpg" style="width:50%" alt="Page not found!"></p>
<p id="shrug">
<svg xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 512.000000 512.000000"
preserveAspectRatio="xMidYMid meet">
<g transform="translate(0.000000,512.000000) scale(0.100000,-0.100000)"
style="fill:#000000;stroke:none;">
<path d="M2359 4821 c-330 -72 -613 -312 -803 -681 -53 -102 -74 -133 -105
-154 -46 -32 -103 -113 -121 -170 -7 -23 -11 -72 -8 -120 3 -65 10 -91 33
-134 36 -66 91 -117 161 -149 30 -13 54 -30 54 -38 0 -33 56 -199 94 -281 54
-115 110 -196 192 -283 35 -38 64 -71 64 -74 0 -3 -17 -11 -37 -18 -57 -18
-170 -77 -238 -122 -75 -52 -213 -184 -270 -259 -51 -68 -46 -74 -75 101 -12
68 -32 150 -45 182 -65 160 -179 253 -342 279 -125 20 -234 85 -376 224 -103
101 -149 127 -233 134 -115 9 -217 -48 -272 -152 -38 -73 -38 -177 0 -259 68
-146 246 -382 417 -554 l101 -102 96 -533 c52 -293 104 -556 113 -583 67 -191
246 -315 455 -315 138 0 251 46 347 142 l49 49 0 -256 c0 -208 3 -263 15 -293
20 -47 50 -79 97 -103 36 -18 71 -19 838 -19 780 0 802 1 840 20 44 22 82 68
99 119 7 22 11 122 11 278 l0 244 49 -49 c96 -96 209 -142 347 -142 209 0 388
124 455 315 9 27 61 290 113 583 l96 533 101 102 c171 172 349 408 417 554 38
82 38 186 0 259 -55 104 -157 161 -272 152 -84 -7 -130 -33 -233 -134 -142
-139 -251 -204 -376 -224 -163 -26 -277 -119 -342 -279 -13 -32 -33 -114 -45
-182 -29 -175 -24 -169 -75 -101 -101 134 -259 264 -423 346 l-72 36 92 93
c51 50 109 116 128 144 l35 52 57 1 c164 0 310 134 325 298 7 74 -10 147 -48
207 -26 40 -30 60 -40 168 -24 283 -91 497 -213 682 -155 232 -387 382 -706
456 -128 30 -405 35 -521 10z m426 -197 c120 -20 265 -71 362 -125 106 -60
242 -196 302 -302 70 -125 126 -307 146 -479 9 -70 13 -69 -153 -32 -360 81
-724 280 -888 486 -63 79 -100 105 -160 114 -61 9 -107 -10 -204 -83 -144
-109 -279 -163 -403 -163 l-59 0 37 68 c50 92 164 240 233 303 118 108 259
183 402 214 88 18 275 18 385 -1z m-295 -674 c108 -107 232 -191 421 -284 207
-103 534 -206 656 -206 60 0 123 -64 123 -125 0 -43 -27 -93 -62 -115 -26 -17
-43 -20 -83 -15 -134 16 -135 15 -203 -90 -69 -106 -230 -260 -332 -318 -255
-143 -537 -153 -781 -26 -242 126 -419 382 -469 679 -15 90 -43 124 -111 135
-89 15 -129 56 -129 132 0 49 18 82 58 109 30 20 40 22 154 17 103 -4 138 -2
210 16 136 32 283 108 388 199 l35 31 19 -27 c10 -15 58 -65 106 -112z m-2091
-974 c186 -176 301 -240 493 -276 119 -23 182 -109 213 -290 8 -52 42 -230 75
-395 78 -394 103 -549 95 -588 -29 -136 -171 -202 -287 -134 -25 15 -55 42
-67 60 -21 34 -54 197 -131 642 -23 132 -46 256 -52 275 -7 23 -43 65 -109
128 -220 210 -444 522 -425 595 9 37 44 67 78 67 22 0 49 -19 117 -84z m4489
54 c38 -36 39 -67 2 -138 -75 -145 -239 -351 -399 -504 -66 -63 -102 -105
-109 -128 -6 -19 -29 -143 -52 -275 -77 -445 -110 -608 -131 -642 -12 -18 -42
-45 -67 -60 -116 -68 -258 -2 -287 134 -8 39 17 194 95 588 33 165 67 343 75
395 31 181 94 267 213 290 192 36 307 100 493 276 96 91 125 103 167 64z
m-2850 -536 c56 -270 324 -461 595 -424 205 28 393 204 439 411 6 30 14 58 18
62 8 10 128 -34 190 -70 166 -96 311 -245 387 -398 57 -113 57 -117 28 -287
-56 -322 -58 -411 -13 -510 74 -161 263 -254 420 -205 45 14 47 14 38 -2 -17
-33 -87 -88 -133 -106 -68 -26 -179 -17 -240 18 -25 15 -92 78 -150 142 l-105
114 -4 97 c-3 91 -5 97 -31 120 -38 33 -96 33 -134 0 l-28 -24 -3 -476 -3
-476 -749 0 -749 0 -3 481 -3 481 -28 24 c-38 33 -96 33 -134 0 -26 -23 -28
-29 -31 -120 l-4 -97 -105 -114 c-58 -64 -125 -127 -150 -142 -61 -35 -172
-44 -240 -18 -46 18 -116 73 -133 106 -9 16 -7 16 38 2 157 -49 346 44 420
205 45 99 43 188 -13 510 -29 170 -29 174 28 287 97 197 295 373 507 451 60
22 65 19 78 -42z m421 -4 c96 -15 253 -8 346 14 33 8 62 13 64 10 11 -10 -35
-99 -74 -141 -175 -195 -480 -111 -559 154 l-7 21 73 -23 c40 -13 111 -29 157
-35z"/>
<path d="M2236 3664 c-20 -20 -26 -37 -26 -68 0 -52 20 -81 65 -96 70 -23 141
42 127 116 -13 71 -113 100 -166 48z"/>
<path d="M2865 3548 c-94 -51 -61 -188 45 -188 103 0 141 138 50 185 -34 18
-67 19 -95 3z"/>
<path d="M2308 3093 c-29 -18 -48 -52 -48 -86 0 -33 36 -86 62 -92 134 -31
266 -55 303 -55 63 0 95 32 95 92 0 82 -11 88 -230 133 -144 29 -147 29 -182
8z"/>
</g>
</svg>
</p>
</article>
</div>
</main>

106
docs/public/categories/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="">
<title>Categories - A tool for commands</title>
<link href="/categories/index.xml" rel="alternate" type="application/rss+xml" title="Categories - 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
@ -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">
@ -57,19 +57,17 @@
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article>
<header class="headline">
</header>
<h1 id="categories">Categories</h1>
<ul>
</ul>
<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>
@ -128,27 +126,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"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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">
@ -158,6 +157,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="/categories/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -177,7 +177,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">
@ -185,8 +185,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 ){
@ -216,23 +216,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>

205
docs/public/cli/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="">
<title>CLI - A tool for commands</title>
<link href="/cli/index.xml" rel="alternate" type="application/rss+xml" title="CLI - 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
@ -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,17 +55,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><a href="#subcommands">Subcommands</a>
<ul>
<li><a href="#backy-backup">backy backup</a></li>
<li><a href="#backy-exec">backy exec</a></li>
<li><a href="#backy-cron">backy cron</a></li>
<li><a href="#backy-version">backy version</a></li>
<li><a href="#backy">Backy</a></li>
</ul>
</li>
<ul>
<li><a href="#backup">backup</a></li>
<li><a href="#cron">cron</a></li>
<li><a href="#exec">exec</a></li>
<li><a href="#version">version</a></li>
<li><a href="#list">list</a></li>
</ul>
</nav>
</div>
@ -74,19 +74,40 @@
</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="cli">CLI</h1>
<p>This page lists documentation for the CLI.</p>
<h2 id="subcommands">Subcommands</h2>
<h3 id="backy-backup">backy backup</h3>
<pre tabindex="0"><code>Backup executes commands defined in config file.
Use the --lists flag to execute the specified commands. If not specified, all lists will be executed.
<h2 id="backy">Backy</h2>
<pre tabindex="0"><code>Backy is a command-line application useful for configuring backups, or any commands run in sequence.
Usage:
backy backup [--lists=list1,list2] [flags]
backy [command]
Available Commands:
backup Runs commands defined in config file.
completion Generate the autocompletion script for the specified shell
cron Starts a scheduler that runs lists defined in config file.
exec Runs commands defined in config file in order given.
help Help about any command
list Lists commands, lists, or hosts defined in config file.
version Prints the version and exits
Flags:
-f, --config string config file to read from
-h, --help help for backy
-v, --verbose Sets verbose level
Use &#34;backy [command] --help&#34; for more information about a command.
</code></pre><h1 id="subcommands">Subcommands</h1>
<h2 id="backup">backup</h2>
<pre tabindex="0"><code>Backup executes commands defined in config file.
Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.
Usage:
backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags]
Flags:
-h, --help help for backup
@ -95,19 +116,7 @@ Flags:
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h3 id="backy-exec">backy exec</h3>
<pre tabindex="0"><code>Exec executes commands defined in config file.
Usage:
backy exec command ... [flags]
Flags:
-h, --help help for exec
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h3 id="backy-cron">backy cron</h3>
</code></pre><h2 id="cron">cron</h2>
<pre tabindex="0"><code>Cron starts a scheduler that executes command lists at the time defined in config file.
Usage:
@ -119,22 +128,56 @@ Flags:
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h3 id="backy-version">backy version</h3>
<pre tabindex="0"><code>Prints the version and exits.
</code></pre><h2 id="exec">exec</h2>
<pre tabindex="0"><code>Exec executes commands defined in config file in order given.
Usage:
backy exec command ... [flags]
Flags:
-h, --help help for exec
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h2 id="version">version</h2>
<pre tabindex="0"><code>Prints the version and exits. No arguments just prints the version number only.
Usage:
backy version [flags]
Flags:
-h, --help help for version
-n, --num Output the version number only.
-V, --vpre Output the version with v prefixed.
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre><h2 id="list">list</h2>
<pre tabindex="0"><code>Backup lists commands or groups defined in config file.
Use the --lists or -l flag to list the specified lists. If not flag is not given, all lists will be executed.
Usage:
backy list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...] [flags]
Flags:
-c, --cmds strings Accepts comma-separated names of commands to list.
-h, --help help for list
-l, --lists strings Accepts comma-separated names of command lists to list.
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
</code></pre>
<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>
@ -193,27 +236,28 @@ Flags:
<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"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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 active"><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=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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="active"><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">
@ -223,6 +267,7 @@ Flags:
<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="/cli/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -242,7 +287,7 @@ Flags:
</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">
@ -250,8 +295,8 @@ Flags:
</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 ){
@ -281,23 +326,19 @@ Flags:
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>

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>

272
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,24 +71,17 @@
</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">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">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>
@ -99,86 +91,86 @@
</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">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></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>

31
docs/public/css/auto-complete.css
View File

@ -1,17 +1,18 @@
.autocomplete-suggestions {
text-align: left;
text-align: start;
color-scheme: only light; /* set browser scrollbar color */
cursor: default;
border: 1px solid #ccc;
border: 1px solid rgba( 204, 204, 204, 1 );
border-top: 0;
background: #fff;
box-shadow: -1px 1px 3px rgba(0,0,0,.1);
background: rgba( 255, 255, 255, 1 );
box-shadow: -1px 1px 3px rgba( 0, 0, 0, .1 );
/* core styles should not be changed */
position: absolute;
display: none;
z-index: 9999;
max-height: 150px;
max-height: calc( 100vh - 150px );
max-height: 10em;
max-height: calc( 100vh - 10em );
overflow: hidden;
overflow-y: auto;
box-sizing: border-box;
@ -19,22 +20,22 @@
.autocomplete-suggestion {
position: relative;
cursor: pointer;
padding: 7px;
line-height: 23px;
padding: .46em;
line-height: 1.5em;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
color: #282828;
color: rgba( 40, 40, 40, 1 );
}
.autocomplete-suggestion b {
font-weight: normal;
color: #1f8dd6;
color: rgba( 31, 141, 214, 1 );
}
.autocomplete-suggestion.selected {
background: #282828;
color: #fff;
background: rgba( 40, 40, 40, 1 );
color: rgba( 255, 255, 255, 1 );
}
.autocomplete-suggestion:hover,
@ -46,12 +47,12 @@
#searchresults .autocomplete-suggestion:hover > .context,
#searchresults .autocomplete-suggestion:focus > .context,
#searchresults .autocomplete-suggestion:active > .context {
background: #383838;
color: #fff;
background: rgba( 56, 56, 56, 1 );
color: rgba( 255, 255, 255, 1 );
}
.autocomplete-suggestion > .context {
font-size: 12px;
font-size: .7869em;
margin-inline-start: 1em;
overflow: hidden;
text-overflow: ellipsis;

113
docs/public/css/format-print.css
View File

@ -5,6 +5,7 @@
}
#body {
margin-left: 0 !important;
margin-right: 0 !important;
min-width: 100% !important;
max-width: 100% !important;
width: 100% !important;
@ -16,27 +17,23 @@ html{
font-size: 8.763pt;
}
body {
background-color: white;
background-color: rgba( 255, 255, 255, 1 );
}
code.copy-to-clipboard-code {
border-bottom-right-radius: 2px;
border-top-right-radius: 2px;
border-right-width: 1px;
}
span > code.copy-to-clipboard-code {
border-end-end-radius: 2px;
border-start-end-radius: 2px;
border-end-end-radius: 2px;
border-inline-end-width: 1px;
}
pre {
border: 1px solid #ccc;
border: 1px solid rgba( 204, 204, 204, 1 );
}
#body #topbar{
background-color: #fff; /* avoid background bleeding*/
border-bottom: 1px solid #ddd;
background-color: rgba( 255, 255, 255, 1 ); /* avoid background bleeding*/
border-bottom: 1px solid rgba( 221, 221, 221, 1 );
border-radius: 0;
color: rgba( 119, 119, 119, 1 );
padding-left: 0; /* for print, we want to align with the footer to ease the layout */
color: #777;
padding-right: 0;
}
.navigation,
#top-print-link,
@ -57,7 +54,7 @@ pre {
#body h1, #body h2, #body h3, #body .article-subheading, #body h4, #body h5, #body h6 {
/* better contrast for colored elements */
color: black;
color: rgba( 0, 0, 0, 1 );
}
#body th, #body td,
#body code, #body strong, #body b,
@ -65,19 +62,19 @@ pre {
#body p,
#body a, #body button, #body .badge .badge-content {
/* better contrast for colored elements */
color: black;
color: rgba( 0, 0, 0, 1 );
}
#body .anchor{
display: none;
}
#body pre,
#body code {
background-color: white;
border-color: #ddd;
background-color: rgba( 255, 255, 255, 1 );
border-color: rgba( 221, 221, 221, 1 );
}
hr{
border-bottom: 1px solid #ddd;
border-bottom: 1px solid rgba( 221, 221, 221, 1 );
}
body,
#body,
@ -90,7 +87,7 @@ body,
}
#body #body-inner h1 {
border-bottom: 1px solid #ddd;
border-bottom: 1px solid rgba( 221, 221, 221, 1 );
margin-bottom: 2rem;
padding-bottom: .75rem;
}
@ -108,11 +105,12 @@ body,
.footline {
/* in print mode show footer line to signal reader the end of document */
border-top: 1px solid #ddd;
color: #777;
border-top: 1px solid rgba( 221, 221, 221, 1 );
color: rgba( 119, 119, 119, 1 );
margin-top: 1.5rem;
padding-top: .75rem;
}
#body #body-inner .headline a,
#body #body-inner .footline a,
#body #body-inner .btn a {
text-decoration: none;
@ -140,12 +138,9 @@ body,
position: inherit; /* IE11 doesn't know "initial" here */
}
#topbar > div {
background-color: #ffffff; /* IE11 doesn't know "initial" here */
background-color: rgba( 255, 255, 255, 1 ); /* IE11 doesn't know "initial" here */
}
#body .tab-nav-button:not(.active) {
opacity: .5;
}
#head-tags {
.tags {
display: none;
}
mark {
@ -155,74 +150,24 @@ mark {
.mermaid > svg:hover {
border-color: transparent;
}
div.box {
border: 1px solid #ddd;
}
div.box > .box-content {
background-color: white;
}
rapi-doc{
/* adjust rapi-doc internals to fill out available space with render-style=read */
margin-left: calc( -80px );
width: calc( 100% + 80px + 80px );
}
@media (max-width: 1023px) {
rapi-doc {
margin-left: calc( -8px );
width: calc( 100% + 8px + 8px );
}
}
rapi-doc::part(section-tag) {
/* adjust rapi-doc internals to fill out available space with render-style=read */
margin-left: 80px;
margin-right: 80px;
padding-left: 0;
padding-right: 0;
}
@media (max-width: 1023px) {
rapi-doc::part(section-tag) {
margin-left: 8px;
margin-right: 8px;
padding-left: 0;
padding-right: 0;
}
}
rapi-doc::part(section-main-content) {
/* override variables for adapting rapidoc design to print theme */
--fg: black;
--fg2: black;
--fg3: black;
}
rapi-doc::part(section-overview-title) {
/* set print color for titles */
color: black !important;
}
rapi-doc::part(operation-divider) {
/* remove whitespace */
margin-bottom: 1rem;
margin-top: 1rem;
}
rapi-doc::part(section-navbar) {
/* removes the nav bar for render-style=read */
display: none;
background-color: rgba( 255, 255, 255, 1 );
}
.btn,
#body .tab-nav-button {
color: black !important;
color: rgba( 0, 0, 0, 1 );
}
#body .tab-nav-button.active {
background-color: white !important;
border-bottom-color: white !important;
color: black;
border-bottom-color: rgba( 255, 255, 255, 1 );
color: rgba( 0, 0, 0, 1 );
}
#body .tab-nav-button:not(.active) {
opacity: 1;
#body .tab-nav-button.active > * {
background-color: rgba( 255, 255, 255, 1 );
}
#body .tab-content-text {
background-color: rgba( 255, 255, 255, 1 ) ;
color: rgba( 0, 0, 0, 1 );
}
article {

454
docs/public/css/ie.css
View File

@ -1,81 +1,215 @@
@media all and (-ms-high-contrast:none) {
/* ----------------------------------------------- */
/* turn off LTR support as it is dependend on CSS properties that aren't supported by IE11 */
article,
.toc-wrapper,
.tags {
direction: ltr;
html {
direction: ltr !important;
}
/* nucleus */
th {
text-align: left;
}
input[type="checkbox"], input[type="radio"] {
margin-right: 0.425rem;
}
blockquote {
padding-left: 0.85rem;
}
/* theme */
#sidebar {
left: 0;
}
.searchbox > :first-child {
left: .5rem;
}
.searchbox span {
right: .5rem;
}
.searchbox input {
padding-left: 1.8rem;
padding-right: 1.6rem;
}
#sidebar ul li.visited + span {
margin-right: 1rem;
}
#sidebar ul li .read-icon {
right: 1rem;
}
#sidebar .nav-title {
padding-left: 1rem;
}
#body {
margin-left: 18.75rem;
}
h2, h3, h4, h5, h6 {
padding-right: 2rem;
}
blockquote {
border-left: 10px solid rgba( 134, 134, 134, .4 );
padding-left: 0.85rem;
border-left: .6rem solid rgba( 134, 134, 134, .4 );
}
blockquote cite {
text-align: right;
}
th {
text-align: left;
}
.disableInlineCopyToClipboard span > code.copy-to-clipboard-code {
border-bottom-right-radius: 2px;
border-top-right-radius: 2px;
border-right-width: 1px;
}
.anchor {
margin-left: .66em;
}
div.attachments .box-content {
padding-left: 1.75rem;
}
#body-inner ul.children-h2,
#body-inner ul.children-h3,
#body-inner ul.children-h4,
#body-inner ul.children-h5,
#body-inner ul.children-h6 {
/* if we display children with style=h2 but without a containerstyle
a ul will be used for structuring; we remove default indention for uls
in this case */
padding-left: 0;
}
code.copy-to-clipboard-code {
border-bottom-right-radius: 0;
border-top-right-radius: 0;
border-right-width: 0;
}
html[dir="rtl"] .navigation,
html[dir="rtl"] #top-print-link,
html[dir="rtl"] #top-github-link {
float: right;
}
.nav,
.print-link,
.github-link {
border-left: thin solid rgba( 134, 134, 134, .333 );
}
html[dir="rtl"] .nav i {
transform: scaleX(1);
}
#toc-menu,
#sidebar-toggle-span {
border-right: thin solid rgba( 134, 134, 134, .333 );
}
html[dir="rtl"] #body #breadcrumbs {
float: left;
}
.progress {
left: 1rem;
}
@media screen and (max-width: 48rem) {
.progress {
left: 4.25rem;
}
}
@media screen and (max-width: 60rem) {
#body {
margin-left: 14.375rem;
}
}
@media screen and (max-width: 48rem) {
.mobile-support #sidebar {
left: -14.375rem;
}
.mobile-support #body {
margin-left: 0;
}
.mobile-support.sidebar-flyout #sidebar {
left: 0;
}
.mobile-support.sidebar-flyout #body {
margin-left: 14.375rem;
}
}
.copy-to-clipboard-button {
border-top-left-radius: 0;
border-top-right-radius: 2px;
border-bottom-right-radius: 2px;
border-bottom-left-radius: 0;
}
span > .copy-to-clipboard-button {
border-top-left-radius: 0;
border-top-right-radius: 2px;
border-bottom-right-radius: 2px;
border-bottom-left-radius: 0;
}
pre > .copy-to-clipboard-button {
right: 4px;
}
.disableInlineCopyToClipboard span > code.copy-to-clipboard-code {
border-top-right-radius: 2px;
border-bottom-right-radius: 2px;
border-right-width: 1px;
}
.expand > label {
left: 0;
}
.expand > input + label > .fa-chevron-left {
display: none !important;
.expand > .expand-content {
margin-left: 1rem;
}
.expand > input + label > .fa-chevron-right {
display: inline-block !important;
html[dir="rtl"] .expand > .expand-label > i.fa-chevron-right {
transform: scaleX(1);
}
.expand > input:checked + label > .fa-chevron-right {
display: none !important;
.headline i,
.footline i{
margin-left: .5rem;
}
#body .tab-nav-button {
margin-left: 4px;
.headline i:first-child,
.footline i:first-child{
margin-left: 0;
}
#body .tab-nav-button.direction-rtl {
.anchor {
margin-left: .66em;
}
html[dir="rtl"] .select-container i,
html[dir="rtl"] .select-container span {
float: left;
}
#body .tab-nav-button:first-child {
margin-left: 9px;
.footerVisitedLinks > * {
text-align: left;
}
.searchform input {
margin-right: .5rem;
}
.autocomplete-suggestion > .context {
margin-left: 1em;
}
.badge > .badge-title {
border-right: 0;
border-top-right-radius: 0;
border-bottom-right-radius: 0;
}
.badge.badge-with-title > .badge-content {
border-top-left-radius: 0;
border-bottom-left-radius: 0;
}
article ul li:has(input[type="checkbox"]) {
article ul > li:has(> input[type="checkbox"]) {
margin-left: -1rem;
}
/* tabs */
#body .tab-nav-button {
margin-left: .6rem;
}
#body .tab-content{
margin-top: -1px;
}
/* auto-complete */
.autocomplete-suggestions {
text-align: left;
}
.autocomplete-suggestion > .context {
margin-left: 1em;
}
/* menu */
#sidebar ul ul {
padding-left: 1rem;
}
#sidebar ul.collapsible-menu > li > label {
left: 0;
padding-left: .125rem;
}
html[dir="rtl"] #sidebar ul.collapsible-menu > li > label > i.fa-chevron-right {
transform: scaleX(1);
}
/* ----------------------------------------------- */
/* set default colors as in variant.css for IE11 */
html {
color-scheme: only light;
}
body {
background-color: #ffffff; /* var(--MAIN-BG-color) */
color: #101010; /* var(--MAIN-TEXT-color) */
background-color: rgba( 255, 255, 255, 1 ); /* var(--MAIN-BG-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--MAIN-TEXT-color) */
font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; /* var(--MAIN-font) */
}
@ -85,18 +219,18 @@
#toc-menu,
#body a.highlight:after,
#searchresults .autocomplete-suggestion {
color: #486ac9; /* var(--MAIN-LINK-color) */
color: rgba( 72, 106, 201, 1 ); /* var(--MAIN-LINK-color) */
}
a:hover,
.anchor:hover,
#toc-menu:hover,
#body a.highlight:hover:after {
color: #202891; /* var(--MAIN-LINK-HOVER-color) */
color: rgba( 32, 40, 145, 1 ); /* var(--MAIN-LINK-HOVER-color) */
}
#sidebar {
background: #282828; /* var(--MENU-SECTIONS-BG-color) */
background: rgba( 40, 40, 40, 1 ); /* var(--MENU-SECTIONS-BG-color) */
}
#header-wrapper {
@ -104,103 +238,104 @@
non default variant is active */
background-color: rgba( 0, 0, 0, 0 ); /* var(--MENU-SECTIONS-BG-color) */
border-bottom-color: rgba( 0, 0, 0, 0 ); /* var(--MENU-SECTIONS-BG-color) */
color: #e0e0e0; /* var(--MENU-SEARCH-color) */
color: rgba( 224, 224, 224, 1 ); /* var(--MENU-SEARCH-color) */
}
.searchbox {
border-color: #e0e0e0; /* var(--MENU-SEARCH-BORDER-color) */
background-color: #323232; /* var(--MENU-SEARCH-BG-color) */
border-color: rgba( 224, 224, 224, 1 ); /* var(--MENU-SEARCH-BORDER-color) */
background-color: rgba( 50, 50, 50, 1 ); /* var(--MENU-SEARCH-BG-color) */
}
.searchbox input:-ms-input-placeholder {
color: #e0e0e0; /* var(--INTERNAL-MENU-SEARCH-color) */
color: rgba( 224, 224, 224, 1 ); /* var(--INTERNAL-MENU-SEARCH-color) */
opacity: .45;
}
#sidebar .searchbox > :first-child,
#sidebar .searchbox button,
.searchbox span {
color: #e0e0e0; /* var(--INTERNAL-MENU-SEARCH-color) */
color: rgba( 224, 224, 224, 1 ); /* var(--INTERNAL-MENU-SEARCH-color) */
}
.searchform input:-ms-input-placeholder {
color: rgba( 134, 134, 134 );
color: rgba( 134, 134, 134, 1 );
opacity: .666;
}
#sidebar .collapsible-menu .toggle,
#sidebar .collapsible-menu label,
#sidebar .select-container,
#sidebar a,
#sidebar button {
color: #bababa; /* var(--MENU-SECTIONS-LINK-color) */
color: rgba( 186, 186, 186, 1 ); /* var(--MENU-SECTIONS-LINK-color) */
}
#sidebar select:hover,
#sidebar .collapsible-menu .toggle:hover,
#sidebar .collapsible-menu li:not(.active) > label:hover,
#sidebar .select-container:hover,
#sidebar a:hover,
#sidebar button:hover {
color: #ffffff; /* var(--MENU-SECTIONS-LINK-HOVER-color) */
color: rgba( 255, 255, 255, 1 ); /* var(--MENU-SECTIONS-LINK-HOVER-color) */
}
#sidebar ul.topics > li.parent,
#sidebar ul.topics > li.active {
#sidebar ul.enlarge > li.parent,
#sidebar ul.enlarge > li.active {
background-color: rgba( 0, 0, 0, .166 ); /* var(--MENU-SECTIONS-ACTIVE-BG-color) */
}
#sidebar ul.collapsible-menu li.active > .toggle,
#sidebar ul.topics li.active > a {
color: #444444; /* var(--MENU-SECTION-ACTIVE-CATEGORY-color) */
#sidebar li.active > label,
#sidebar li.active > a {
color: rgba( 68, 68, 68, 1 ); /* var(--MENU-SECTION-ACTIVE-CATEGORY-color) */
}
#sidebar ul.topics li.active > a {
background-color: #ffffff; /* var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color) */
#sidebar li.active > a {
background-color: rgba( 255, 255, 255, 1 ); /* var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color) */
}
#sidebar ul li.visited > a .read-icon {
color: #486ac9; /* var(--MENU-VISITED-color) */
#sidebar ul li > a .read-icon {
color: rgba( 72, 106, 201, 1 ); /* var(--MENU-VISITED-color) */
}
#sidebar .nav-title {
color: #ffffff; /* var(--MENU-SECTIONS-LINK-HOVER-color) */
color: rgba( 255, 255, 255, 1 ); /* var(--MENU-SECTIONS-LINK-HOVER-color) */
}
#sidebar hr {
border-color: #606060; /* var(--MENU-SECTION-HR-color) */
border-color: rgba( 96, 96, 96, 1 ); /* var(--MENU-SECTION-HR-color) */
}
#footer {
color: #bababa; /* var(--MENU-SECTIONS-LINK-color) */
color: rgba( 186, 186, 186, 1 ); /* var(--MENU-SECTIONS-LINK-color) */
}
mark {
background-color: #ffff00;
background-color: rgba( 255, 255, 0, 1 );
}
h1 {
color: #101010; /* var(--MAIN-TEXT-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--MAIN-TEXT-color) */
font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; /* var(--MAIN-font) */
}
h2, h3, .article-subheading, h4, h5, h6 {
color: #4a4a4a; /* var(--MAIN-TITLES-TEXT-color) */
color: rgba( 74, 74, 74, 1 ); /* var(--MAIN-TITLES-TEXT-color) */
font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif; /* var(--MAIN-TITLES-TEXT-font) */
}
.expand > label {
color: #486ac9; /* var(--MAIN-LINK-color) */
color: rgba( 72, 106, 201, 1 ); /* var(--MAIN-LINK-color) */
}
.expand > label:hover {
color: #202891; /* var(--MAIN-LINK-HOVER-color) */
color: rgba( 32, 40, 145, 1 ); /* var(--MAIN-LINK-HOVER-color) */
}
.expand > label:after {
color: #202891; /* var(--MAIN-LINK-HOVER-color) */
color: rgba( 32, 40, 145, 1 ); /* var(--MAIN-LINK-HOVER-color) */
}
div.box {
background-color: rgba( 128, 128, 128, 1 ); /* var(--INTERNAL-BOX-NEUTRAL-color) */
border-color: rgba( 128, 128, 128, 1 ); /* var(--INTERNAL-BOX-NEUTRAL-color) */
}
div.box > .box-label {
@ -214,6 +349,7 @@
div.box.info {
background-color: rgba( 48, 117, 229, 1 ); /* var(--INTERNAL-BOX-INFO-color) */
border-color: rgba( 48, 117, 229, 1 ); /* var(--INTERNAL-BOX-INFO-color) */
}
div.box.info > .box-content {
@ -222,6 +358,7 @@
div.box.warning {
background-color: rgba( 224, 62, 62, 1 ); /* var(--INTERNAL-BOX-WARNING-color) */
border-color: rgba( 224, 62, 62, 1 ); /* var(--INTERNAL-BOX-WARNING-color) */
}
div.box.warning > .box-content {
@ -230,6 +367,7 @@
div.box.note {
background-color: rgba( 237, 153, 9, 1 ); /* var(--INTERNAL-BOX-NOTE-color) */
border-color: rgba( 237, 153, 9, 1 ); /* var(--INTERNAL-BOX-NOTE-color) */
}
div.box.note > .box-content {
@ -238,6 +376,7 @@
div.box.tip {
background-color: rgba( 42, 178, 24, 1 ); /* var(--INTERNAL-BOX-TIP-color) */
border-color: rgba( 42, 178, 24, 1 ); /* var(--INTERNAL-BOX-TIP-color) */
}
div.box.tip > .box-content {
@ -245,31 +384,35 @@
}
div.box.primary {
background-color: #7dc903; /* var(--INTERNAL-PRIMARY-color) */
background-color: rgba( 125, 201, 3, 1 ); /* var(--INTERNAL-PRIMARY-color) */
border-color: rgba( 125, 201, 3, 1 ); /* var(--INTERNAL-PRIMARY-color) */
}
div.box.primary > .box-content {
color: #101010; /* var(--INTERNAL-MAIN-TEXT-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--INTERNAL-MAIN-TEXT-color) */
}
div.box.secondary {
background-color: #486ac9; /* var(--INTERNAL-SECONDARY-color) */
background-color: rgba( 72, 106, 201, 1 ); /* var(--INTERNAL-SECONDARY-color) */
border-color: rgba( 72, 106, 201, 1 ); /* var(--INTERNAL-SECONDARY-color) */
}
div.box.secondary > .box-content {
color: #101010; /* var(--INTERNAL-MAIN-TEXT-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--INTERNAL-MAIN-TEXT-color) */
}
div.box.accent {
background-color: #ff88ff; /* var(--INTERNAL-ACCENT-color) */
background-color: rgba( 255, 136, 255, 1 ); /* var(--INTERNAL-ACCENT-color) */
border-color: rgba( 255, 136, 255, 1 ); /* var(--INTERNAL-ACCENT-color) */
}
div.box.accent > .box-content {
color: #101010; /* var(--INTERNAL-MAIN-TEXT-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--INTERNAL-MAIN-TEXT-color) */
}
div.box.blue {
background-color: rgba( 48, 117, 229, 1 ); /* var(--INTERNAL-BOX-BLUE-color) */
border-color: rgba( 48, 117, 229, 1 ); /* var(--INTERNAL-BOX-BLUE-color) */
}
div.box.blue > .box-content {
@ -278,6 +421,7 @@
div.box.green {
background-color: rgba( 42, 178, 24, 1 ); /* var(--INTERNAL-BOX-GREEN-color) */
border-color: rgba( 42, 178, 24, 1 ); /* var(--INTERNAL-BOX-GREEN-color) */
}
div.box.green > .box-content {
@ -285,7 +429,8 @@
}
div.box.grey {
background-color: rgba( 128, 128, 128, 1 ); /* var(--INTERNAL-BOX-GREY-color) */
background-color: rgba( 160, 160, 160, 1 ); /* var(--INTERNAL-BOX-GREY-color) */
border-color: rgba( 160, 160, 160, 1 ); /* var(--INTERNAL-BOX-GREY-color) */
}
div.box.grey > .box-content {
@ -294,6 +439,7 @@
div.box.orange {
background-color: rgba( 237, 153, 9, 1 ); /* var(--INTERNAL-BOX-ORANGE-color) */
border-color: rgba( 237, 153, 9, 1 ); /* var(--INTERNAL-BOX-ORANGE-color) */
}
div.box.orange > .box-content {
@ -302,6 +448,7 @@
div.box.red {
background-color: rgba( 224, 62, 62, 1 ); /* var(--INTERNAL-BOX-RED-color) */
border-color: rgba( 224, 62, 62, 1 ); /* var(--INTERNAL-BOX-RED-color) */
}
div.box.red > .box-content {
@ -310,15 +457,16 @@
div.box.transparent {
background-color: transparent;
border-color: transparent;
}
div.box.transparent > .box-label {
color: #4a4a4a; /* var(--MAIN-TITLES-TEXT-color) */
color: rgba( 74, 74, 74, 1 ); /* var(--MAIN-TITLES-TEXT-color) */
}
div.box.transparent > .box-content {
background-color: transparent;
color: #101010; /* var(--MAIN-TEXT-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--MAIN-TEXT-color) */
}
code,
@ -329,80 +477,80 @@
}
code {
background-color: #fffae9; /* var(--CODE-INLINE-BG-color) */
border-color: #f8e8c8; /* var(--CODE-INLINE-BORDER-color) */
color: #5e5e5e; /* var(--CODE-INLINE-color) */
background-color: rgba( 255, 250, 233, 1 ); /* var(--CODE-INLINE-BG-color) */
border-color: rgba( 248, 232, 200, 1 ); /* var(--CODE-INLINE-BORDER-color) */
color: rgba( 94, 94, 94, 1 ); /* var(--CODE-INLINE-color) */
}
pre {
background-color: #f8f8f8; /* var(--CODE-BLOCK-BG-color) */
border-color: #d8d8d8; /* var(--CODE-BLOCK-BORDER-color) */
color: #000000; /* var(--CODE-BLOCK-color) */
background-color: rgba( 248, 248, 248, 1 ); /* var(--CODE-BLOCK-BG-color) */
border-color: rgba( 216, 216, 216, 1 ); /* var(--CODE-BLOCK-BORDER-color) */
color: rgba( 0, 0, 0, 1 ); /* var(--CODE-BLOCK-color) */
}
table {
background-color: #ffffff; /* var(--INTERNAL-MAIN-BG-color) */
background-color: rgba( 255, 255, 255, 1 ); /* var(--INTERNAL-MAIN-BG-color) */
}
.lightbox img{
background-color: #ffffff /* var(--INTERNAL-MAIN-BG-color); */
background-color: rgba( 255, 255, 255, 1 ) /* var(--INTERNAL-MAIN-BG-color); */
}
#topbar {
background-color: #ffffff; /* var(--MAIN-BG-color) */
background-color: rgba( 255, 255, 255, 1 ); /* var(--MAIN-BG-color) */
}
#body a[aria-disabled="true"],
#searchresults .autocomplete-suggestion > .context {
color: #101010; /* var(--MAIN-TEXT-color) - inherit is not processed correctly in Chrome */
color: rgba( 16, 16, 16, 1 ); /* var(--MAIN-TEXT-color) - inherit is not processed correctly in Chrome */
}
.copy-to-clipboard-button {
background-color: #fffae9; /* var(--CODE-INLINE-BG-color) */
border-color: #f8e8c8; /* var(--CODE-INLINE-BORDER-color) */
color: #5e5e5e; /* var(--CODE-INLINE-color) */
background-color: rgba( 255, 250, 233, 1 ); /* var(--CODE-INLINE-BG-color) */
border-color: rgba( 248, 232, 200, 1 ); /* var(--CODE-INLINE-BORDER-color) */
color: rgba( 94, 94, 94, 1 ); /* var(--CODE-INLINE-color) */
font-family: "Consolas", menlo, monospace; /* var(--CODE-font) */
}
.copy-to-clipboard-button:hover {
background-color: #5e5e5e; /* var(--CODE-INLINE-color) */
color: #fffae9; /* var(--CODE-INLINE-BG-color) */
background-color: rgba( 94, 94, 94, 1 ); /* var(--CODE-INLINE-color) */
color: rgba( 255, 250, 233, 1 ); /* var(--CODE-INLINE-BG-color) */
}
pre .copy-to-clipboard-button {
border-color: #d8d8d8; /* var(--CODE-BLOCK-BORDER-color) */
color: #486ac9; /* var(--MAIN-LINK-color) */
border-color: rgba( 216, 216, 216, 1 ); /* var(--CODE-BLOCK-BORDER-color) */
color: rgba( 72, 106, 201, 1 ); /* var(--MAIN-LINK-color) */
}
pre .copy-to-clipboard-button:hover {
background-color: #486ac9; /* var(--MAIN-LINK-color) */
border-color: #486ac9; /* var(--MAIN-LINK-color) */
color: #f8f8f8; /* var(--CODE-BLOCK-BG-color) */
background-color: rgba( 72, 106, 201, 1 ); /* var(--MAIN-LINK-color) */
border-color: rgba( 72, 106, 201, 1 ); /* var(--MAIN-LINK-color) */
color: rgba( 248, 248, 248, 1 ); /* var(--CODE-BLOCK-BG-color) */
}
#homelinks {
background-color: #7dc903; /* var(--MENU-HEADER-BORDER-color) */
border-color: #7dc903; /* var(--MENU-HEADER-BORDER-color) */
background-color: rgba( 125, 201, 3, 1 ); /* var(--MENU-HEADER-BORDER-color) */
border-color: rgba( 125, 201, 3, 1 ); /* var(--MENU-HEADER-BORDER-color) */
}
#homelinks a {
color: #404040 /* var(--MENU-HOME-LINK-color) */
color: rgba( 64, 64, 64, 1 ) /* var(--MENU-HOME-LINK-color) */
}
#homelinks a:hover {
color: #808080 /* var(--MENU-HOME-LINK-HOVER-color) */;
color: rgba( 128, 128, 128, 1 ) /* var(--MENU-HOME-LINK-HOVER-color) */;
}
#body a.highlight:after {
background-color: #486ac9; /* var(--MAIN-LINK-color) */
background-color: rgba( 72, 106, 201, 1 ); /* var(--MAIN-LINK-color) */
}
#body a.highlight:hover:after {
background-color: #202891; /* var(--MAIN-LINK-HOVER-color) */
background-color: rgba( 32, 40, 145, 1 ); /* var(--MAIN-LINK-HOVER-color) */
}
.progress {
background-color: #ffffff; /* var(--MAIN-BG-color) */
background-color: rgba( 255, 255, 255, 1 ); /* var(--MAIN-BG-color) */
}
.btn {
@ -454,27 +602,27 @@
}
.btn.cstyle.primary {
background-color: #7dc903; /* var(--PRIMARY-color) */
background-color: rgba( 125, 201, 3, 1 ); /* var(--PRIMARY-color) */
}
.btn.cstyle.primary > * {
border-color: #7dc903; /* var(--PRIMARY-color) */
border-color: rgba( 125, 201, 3, 1 ); /* var(--PRIMARY-color) */
}
.btn.cstyle.secondary {
background-color: #486ac9; /* var(--SECONDARY-color) */
background-color: rgba( 72, 106, 201, 1 ); /* var(--SECONDARY-color) */
}
.btn.cstyle.secondary > * {
border-color: #486ac9; /* var(--SECONDARY-color) */
border-color: rgba( 72, 106, 201, 1 ); /* var(--SECONDARY-color) */
}
.btn.cstyle.accent {
background-color: #ff88ff; /* var(--ACCENT-color) */
background-color: rgba( 255, 136, 255, 1 ); /* var(--ACCENT-color) */
}
.btn.cstyle.accent > * {
border-color: #ff88ff; /* var(--ACCENT-color) */
border-color: rgba( 255, 136, 255, 1 ); /* var(--ACCENT-color) */
}
.btn.cstyle.blue {
@ -494,11 +642,11 @@
}
.btn.cstyle.grey {
background-color: rgba( 128, 128, 128, 1 ); /* var(--BOX-GREY-color) */
background-color: rgba( 160, 160, 160, 1 ); /* var(--BOX-GREY-color) */
}
.btn.cstyle.grey > * {
border-color: rgba( 128, 128, 128, 1 ); /* var(--BOX-GREY-color) */
border-color: rgba( 160, 160, 160, 1 ); /* var(--BOX-GREY-color) */
}
.btn.cstyle.orange {
@ -519,7 +667,7 @@
.btn.cstyle.transparent {
background-color: transparent;
color: #101010; /* var(--MAIN-TEXT-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--MAIN-TEXT-color) */
}
.btn.cstyle.transparent:hover,
@ -529,26 +677,21 @@
}
.btn.cstyle.transparent > * {
color: #4a4a4a; /* var(--MAIN-TITLES-TEXT-color) */
color: rgba( 74, 74, 74, 1 ); /* var(--MAIN-TITLES-TEXT-color) */
}
#body .tags a.tag-link {
background-color: #7dc903; /* var(--TAG-BG-color) */
color: #ffffff; /* var(--MAIN-BG-color) */
background-color: rgba( 125, 201, 3, 1 ); /* var(--TAG-BG-color) */
color: rgba( 255, 255, 255, 1 ); /* var(--MAIN-BG-color) */
margin-right: 16px;
}
#body .tags a.tag-link:before {
border-right-color: #7dc903; /* var(--TAG-BG-color) */
border-right-color: rgba( 125, 201, 3, 1 ); /* var(--TAG-BG-color) */
}
#body .tags a.tag-link:after {
background: #ffffff; /* var(--MAIN-BG-color) */
}
#body .tab-nav-button.active {
background-color: #ffffff !important; /* var(--MAIN-BG-color) */
border-bottom-color: #ffffff !important; /* var(--MAIN-BG-color) */
background: rgba( 255, 255, 255, 1 ); /* var(--MAIN-BG-color) */
}
.badge > * {
@ -577,15 +720,15 @@
}
.badge.primary > .badge-content {
background-color: #7dc903; /* var(--INTERNAL-PRIMARY-color) */
background-color: rgba( 125, 201, 3, 1 ); /* var(--INTERNAL-PRIMARY-color) */
}
.badge.secondary > .badge-content {
background-color: #486ac9; /* var(--INTERNAL-SECONDARY-color) */
background-color: rgba( 72, 106, 201, 1 ); /* var(--INTERNAL-SECONDARY-color) */
}
.badge.accent > .badge-content {
background-color: #ff88ff; /* var(--INTERNAL-ACCENT-color) */
background-color: rgba( 255, 136, 255, 1 ); /* var(--INTERNAL-ACCENT-color) */
}
.badge.blue > .badge-content {
@ -597,7 +740,7 @@
}
.badge.grey > .badge-content {
background-color: rgba( 128, 128, 128, 1 ); /* var(--INTERNAL-BOX-GREY-color) */
background-color: rgba( 160, 160, 160, 1 ); /* var(--INTERNAL-BOX-GREY-color) */
}
.badge.orange > .badge-content {
@ -610,18 +753,51 @@
.badge.transparent > .badge-content {
background-color: transparent;
color: #4a4a4a; /* var(--MAIN-TITLES-TEXT-color) */
color: rgba( 74, 74, 74, 1 ); /* var(--MAIN-TITLES-TEXT-color) */
}
article ul li input[type="checkbox"] {
background-color: #ffffff; /* var(--INTERNAL-MAIN-BG-color); */
color: #101010; /* var(--INTERNAL-MAIN-TEXT-color) */
article ul > li > input[type="checkbox"] {
background-color: rgba( 255, 255, 255, 1 ); /* var(--INTERNAL-MAIN-BG-color); */
color: rgba( 16, 16, 16, 1 ); /* var(--INTERNAL-MAIN-TEXT-color) */
}
article ul li input[type="checkbox"]::before {
box-shadow: inset 1em 1em #7dc903; /* var(--INTERNAL-PRIMARY-color) */
article ul > li > input[type="checkbox"]::before {
box-shadow: inset 1em 1em rgba( 125, 201, 3, 1 ); /* var(--INTERNAL-PRIMARY-color) */
}
/* no style support for tabs in IE11; all styled as default */
#body .tab-nav-button {
color: rgba( 16, 16, 16, 1 ); /* var(--INTERNAL-MAIN-TEXT-color) */
}
#body .tab-nav-button.active {
background-color: rgba( 255, 255, 255, 1 ); /* var(--VARIABLE-BOX-BG-color) */
border-bottom-color: rgba( 255, 255, 255, 1 ); /* var(--VARIABLE-BOX-BG-color) */
border-left-color: rgba( 134, 134, 134, .4 ); /* var(--VARIABLE-BOX-color) */
border-right-color: rgba( 134, 134, 134, .4 ); /* var(--VARIABLE-BOX-color) */
border-top-color: rgba( 134, 134, 134, .4 ); /* var(--VARIABLE-BOX-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--VARIABLE-BOX-TEXT-color) */
}
#body .tab-nav-button.active > *{
background-color: rgba( 255, 255, 255, 1 ); /* var(--VARIABLE-BOX-BG-color) */
}
#body .tab-nav-button > * > *{
border-color: rgba( 134, 134, 134, .4 ); /* var(--VARIABLE-BOX-color) */
}
#body .tab-content{
background-color: rgba( 255, 255, 255, 1 ); /* var(--VARIABLE-BOX-BG-color) */
border-color: rgba( 134, 134, 134, .4 ); /* var(--VARIABLE-BOX-color) */
}
#body .tab-content-text{
background-color: rgba( 255, 255, 255, 1 ); /* var(--VARIABLE-BOX-BG-color) */
color: rgba( 16, 16, 16, 1 ); /* var(--VARIABLE-BOX-TEXT-color) */
}
/* ----------------------------------------------- */
/* set further styles to fix broken stuff in IE11 */
/* turn off animiation in IE because this causes the menu
@ -632,8 +808,8 @@
/* our silly dinosaur browser wants to have the real colors */
#header-wrapper {
background-color: #7dc903; /* var(--MENU-HEADER-BG-color) */
border-bottom-color: #7dc903; /* var(--MENU-HEADER-BORDER-color) */
background-color: rgba( 125, 201, 3, 1 ); /* var(--MENU-HEADER-BG-color) */
border-bottom-color: rgba( 125, 201, 3, 1 ); /* var(--MENU-HEADER-BORDER-color) */
}
/* clears the 'X' from Internet Explorer's search input */
@ -657,3 +833,11 @@
display: none;
}
}
@media print and (-ms-high-contrast:none) {
code.copy-to-clipboard-code {
border-top-right-radius: 2px;
border-bottom-right-radius: 2px;
border-right-width: 1px;
}
}

10
docs/public/css/nucleus.css
View File

@ -82,6 +82,9 @@ sup {
sub {
bottom: -0.25em; }
iframe {
border: 0; }
img {
border: 0;
max-width: 100%; }
@ -90,7 +93,7 @@ svg:not(:root) {
overflow: hidden; }
figure {
margin: 1em 40px; }
margin: 1rem 2.5rem; }
hr {
height: 0; }
@ -108,7 +111,8 @@ textarea {
margin: 0; }
button {
overflow: visible; }
overflow: visible;
padding: 0; }
button,
select {
@ -242,7 +246,7 @@ textarea {
input[type="checkbox"], input[type="radio"] {
display: inline;
margin-right: 0.425rem; }
margin-inline-end: 0.425rem; }
input[type="file"] {
width: 100%; }

2
docs/public/css/perfect-scrollbar.min.css vendored
View File

@ -1 +1 @@
.ps{overflow:hidden!important;overflow-anchor:none;-ms-overflow-style:none;touch-action:auto;-ms-touch-action:auto}.ps__rail-x{display:none;opacity:0;transition:background-color .2s linear,opacity .2s linear;-webkit-transition:background-color .2s linear,opacity .2s linear;height:15px;bottom:0;position:absolute}.ps__rail-y{display:none;opacity:0;transition:background-color .2s linear,opacity .2s linear;-webkit-transition:background-color .2s linear,opacity .2s linear;width:15px;right:0;position:absolute}.ps--active-x>.ps__rail-x,.ps--active-y>.ps__rail-y{display:block;background-color:transparent}.ps--focus>.ps__rail-x,.ps--focus>.ps__rail-y,.ps--scrolling-x>.ps__rail-x,.ps--scrolling-y>.ps__rail-y,.ps:hover>.ps__rail-x,.ps:hover>.ps__rail-y{opacity:.6}.ps .ps__rail-x.ps--clicking,.ps .ps__rail-x:focus,.ps .ps__rail-x:hover,.ps .ps__rail-y.ps--clicking,.ps .ps__rail-y:focus,.ps .ps__rail-y:hover{background-color:#eee;opacity:.9}.ps__thumb-x{background-color:#aaa;border-radius:6px;transition:background-color .2s linear,height .2s ease-in-out;-webkit-transition:background-color .2s linear,height .2s ease-in-out;height:6px;bottom:2px;position:absolute}.ps__thumb-y{background-color:#aaa;border-radius:6px;transition:background-color .2s linear,width .2s ease-in-out;-webkit-transition:background-color .2s linear,width .2s ease-in-out;width:6px;right:2px;position:absolute}.ps__rail-x.ps--clicking .ps__thumb-x,.ps__rail-x:focus>.ps__thumb-x,.ps__rail-x:hover>.ps__thumb-x{background-color:#999;height:11px}.ps__rail-y.ps--clicking .ps__thumb-y,.ps__rail-y:focus>.ps__thumb-y,.ps__rail-y:hover>.ps__thumb-y{background-color:#999;width:11px}@supports (-ms-overflow-style:none){.ps{overflow:auto!important}}@media screen and (-ms-high-contrast:active),(-ms-high-contrast:none){.ps{overflow:auto!important}}
:root{--ps-thumb-color:#aaa;--ps-thumb-hover-color:#999;--ps-rail-hover-color:#eee}.ps{overflow:hidden !important;overflow-anchor:none;-ms-overflow-style:none;touch-action:auto;-ms-touch-action:auto}.ps__rail-x{display:none;opacity:0;transition:background-color 0.2s linear, opacity 0.2s linear;-webkit-transition:background-color 0.2s linear, opacity 0.2s linear;height:15px;bottom:0;position:absolute}.ps__rail-y{display:none;opacity:0;transition:background-color 0.2s linear, opacity 0.2s linear;-webkit-transition:background-color 0.2s linear, opacity 0.2s linear;width:15px;right:0;position:absolute}.ps--active-x > .ps__rail-x,.ps--active-y > .ps__rail-y{display:block;background-color:transparent}.ps--focus > .ps__rail-x,.ps--focus > .ps__rail-y,.ps--scrolling-x > .ps__rail-x,.ps--scrolling-y > .ps__rail-y,.ps:hover > .ps__rail-x,.ps:hover > .ps__rail-y{opacity:0.6}.ps .ps__rail-x.ps--clicking,.ps .ps__rail-x:focus,.ps .ps__rail-x:hover,.ps .ps__rail-y.ps--clicking,.ps .ps__rail-y:focus,.ps .ps__rail-y:hover{background-color:#eee;background-color:var(--ps-rail-hover-color);opacity:0.9}.ps__thumb-x{background-color:#aaa;background-color:var(--ps-thumb-color);border-radius:6px;transition:background-color 0.2s linear, height 0.2s ease-in-out;-webkit-transition:background-color 0.2s linear, height 0.2s ease-in-out;height:6px;bottom:2px;position:absolute}.ps__thumb-y{background-color:#aaa;background-color:var(--ps-thumb-color);border-radius:6px;transition:background-color 0.2s linear, width 0.2s ease-in-out;-webkit-transition:background-color 0.2s linear, width 0.2s ease-in-out;width:6px;right:2px;position:absolute}.ps__rail-x.ps--clicking .ps__thumb-x,.ps__rail-x:focus > .ps__thumb-x,.ps__rail-x:hover > .ps__thumb-x{background-color:#999;background-color:var(--ps-thumb-hover-color);height:11px}.ps__rail-y.ps--clicking .ps__thumb-y,.ps__rail-y:focus > .ps__thumb-y,.ps__rail-y:hover > .ps__thumb-y{background-color:#999;background-color:var(--ps-thumb-hover-color);width:11px}@supports (-ms-overflow-style: none){.ps{overflow:auto !important}}@media screen and (-ms-high-contrast: active), (-ms-high-contrast: none){.ps{overflow:auto !important}}

4
docs/public/css/tags.css
View File

@ -1,6 +1,6 @@
/* Tags */
#head-tags{
.tags{
margin-left:1rem;
margin-top:1rem;
}
@ -8,7 +8,7 @@
#body .tags a.tag-link {
border-bottom-right-radius: 3px;
border-top-right-radius: 3px;
box-shadow: 0 1px 2px rgba(0,0,0,0.2);
box-shadow: 0 1px 2px rgba( 0, 0, 0, .2 );
display: inline-block;
font-size: 0.8em;
font-weight: 400;

2
docs/public/css/theme-auto.css
View File

@ -1,2 +1,2 @@
@import "theme-relearn-light.css" screen;
@import "theme-relearn-light.css" screen and (prefers-color-scheme: light);
@import "theme-relearn-dark.css" screen and (prefers-color-scheme: dark);

54
docs/public/css/theme-blue.css
View File

@ -6,41 +6,41 @@
@import "chroma-learn.css";
:root {
--MAIN-TEXT-color: #323232; /* Color of text by default */
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: #222222; /* text color of h1 titles */
--MAIN-LINK-color: #1c90f3; /* Color of links */
--MAIN-LINK-HOVER-color: #167ad0; /* Color of hovered links */
--MAIN-BG-color: #ffffff; /* color of text by default */
--MAIN-TEXT-color: rgba( 50, 50, 50, 1 ); /* Color of text by default */
--MAIN-TITLES-TEXT-color: rgba( 94, 94, 94, 1 ); /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: rgba( 34, 34, 34, 1 ); /* text color of h1 titles */
--MAIN-LINK-color: rgba( 28, 144, 243, 1 ); /* Color of links */
--MAIN-LINK-HOVER-color: rgba( 22, 122, 208, 1 ); /* Color of hovered links */
--MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* color of text by default */
/* adjusted to base16-snazzy chroma style */
--CODE-BLOCK-color: #e2e4e5; /* fallback color for code text */
--CODE-BLOCK-BG-color: #282a36; /* fallback color for code background */
--CODE-BLOCK-BORDER-color: #282a36; /* color of block code border */
--CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */
--CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */
--CODE-BLOCK-BORDER-color: rgba( 40, 42, 54, 1 ); /* color of block code border */
--CODE-INLINE-color: #5e5e5e; /* color for inline code text */
--CODE-INLINE-BG-color: #fffae9; /* color for inline code background */
--CODE-INLINE-BORDER-color: #f8e8c8; /* color of inline code border */
--CODE-INLINE-color: rgba( 94, 94, 94, 1 ); /* color for inline code text */
--CODE-INLINE-BG-color: rgba( 255, 250, 233, 1 ); /* color for inline code background */
--CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* color of inline code border */
--MENU-HOME-LINK-color: #2d363f; /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: #000000; /* Color of the hovered home button text */
--MENU-HOME-LINK-color: rgba( 45, 54, 63, 1 ); /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* Color of the hovered home button text */
--MENU-HEADER-BG-color: #1c90f3; /* Background color of menu header */
--MENU-HEADER-BORDER-color: #33a1ff; /*Color of menu header border */
--MENU-HEADER-BG-color: rgba( 28, 144, 243, 1 ); /* Background color of menu header */
--MENU-HEADER-BORDER-color: rgba( 51, 161, 255, 1 ); /*Color of menu header border */
--MENU-SEARCH-color: #ffffff; /* Color of search field text */
--MENU-SEARCH-BG-color: #167ad0; /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: #33a1ff; /* Override search field border color */
--MENU-SEARCH-color: rgba( 255, 255, 255, 1 ); /* Color of search field text */
--MENU-SEARCH-BG-color: rgba( 22, 122, 208, 1 ); /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: rgba( 51, 161, 255, 1 ); /* Override search field border color */
--MENU-SECTIONS-ACTIVE-BG-color: #20272b; /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: #252c31; /* Background color of other sections */
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
--MENU-SECTIONS-ACTIVE-BG-color: rgba( 32, 39, 43, 1 ); /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: rgba( 37, 44, 49, 1 ); /* Background color of other sections */
--MENU-SECTIONS-LINK-color: rgba( 204, 204, 204, 1 ); /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: rgba( 230, 230, 230, 1 ); /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 119, 119, 119, 1 ); /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba( 255, 255, 255, 1 ); /* Color of background for the active category (only) */
--MENU-VISITED-color: #1c90f3; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #20272b; /* Color of <hr> separator in menu */
--MENU-VISITED-color: rgba( 28, 144, 243, 1 ); /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: rgba( 32, 39, 43, 1 ); /* Color of <hr> separator in menu */
/* base styling for boxes */
--BOX-CAPTION-color: rgba( 255, 255, 255, 1 ); /* color of the title text */

54
docs/public/css/theme-green.css
View File

@ -6,41 +6,41 @@
@import "chroma-learn.css";
:root {
--MAIN-TEXT-color: #323232; /* Color of text by default */
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: #222222; /* text color of h1 titles */
--MAIN-LINK-color: #599a3e; /* Color of links */
--MAIN-LINK-HOVER-color: #3f6d2c; /* Color of hovered links */
--MAIN-BG-color: #ffffff; /* color of text by default */
--MAIN-TEXT-color: rgba( 50, 50, 50, 1 ); /* Color of text by default */
--MAIN-TITLES-TEXT-color: rgba( 94, 94, 94, 1 ); /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: rgba( 34, 34, 34, 1 ); /* text color of h1 titles */
--MAIN-LINK-color: rgba( 89, 154, 62, 1 ); /* Color of links */
--MAIN-LINK-HOVER-color: rgba( 63, 109, 44, 1 ); /* Color of hovered links */
--MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* color of text by default */
/* adjusted to base16-snazzy chroma style */
--CODE-BLOCK-color: #e2e4e5; /* fallback color for code text */
--CODE-BLOCK-BG-color: #282a36; /* fallback color for code background */
--CODE-BLOCK-BORDER-color: #282a36; /* color of block code border */
--CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */
--CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */
--CODE-BLOCK-BORDER-color: rgba( 40, 42, 54, 1 ); /* color of block code border */
--CODE-INLINE-color: #5e5e5e; /* color for inline code text */
--CODE-INLINE-BG-color: #fffae9; /* color for inline code background */
--CODE-INLINE-BORDER-color: #f8e8c8; /* color of inline code border */
--CODE-INLINE-color: rgba( 94, 94, 94, 1 ); /* color for inline code text */
--CODE-INLINE-BG-color: rgba( 255, 250, 233, 1 ); /* color for inline code background */
--CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* color of inline code border */
--MENU-HOME-LINK-color: #2e3b2e; /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: #000000; /* Color of the hovered home button text */
--MENU-HOME-LINK-color: rgba( 46, 59, 46, 1 ); /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* Color of the hovered home button text */
--MENU-HEADER-BG-color: #74b559; /* Background color of menu header */
--MENU-HEADER-BORDER-color: #9cd484; /*Color of menu header border */
--MENU-HEADER-BG-color: rgba( 116, 181, 89, 1 ); /* Background color of menu header */
--MENU-HEADER-BORDER-color: rgba( 156, 212, 132, 1 ); /*Color of menu header border */
--MENU-SEARCH-color: #ffffff; /* Color of search field text */
--MENU-SEARCH-BG-color: #599a3e; /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: #84c767; /* Override search field border color */
--MENU-SEARCH-color: rgba( 255, 255, 255, 1 ); /* Color of search field text */
--MENU-SEARCH-BG-color: rgba( 89, 154, 62, 1 ); /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: rgba( 132, 199, 103, 1 ); /* Override search field border color */
--MENU-SECTIONS-ACTIVE-BG-color: #1b211c; /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: #222723; /* Background color of other sections */
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
--MENU-SECTIONS-ACTIVE-BG-color: rgba( 27, 33, 28, 1 ); /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: rgba( 34, 39, 35, 1 ); /* Background color of other sections */
--MENU-SECTIONS-LINK-color: rgba( 204, 204, 204, 1 ); /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: rgba( 230, 230, 230, 1 ); /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 119, 119, 119, 1 ); /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba( 255, 255, 255, 1 ); /* Color of background for the active category (only) */
--MENU-VISITED-color: #599a3e; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #18211c; /* Color of <hr> separator in menu */
--MENU-VISITED-color: rgba( 89, 154, 62, 1 ); /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: rgba( 24, 33, 28, 1 ); /* Color of <hr> separator in menu */
/* base styling for boxes */
--BOX-CAPTION-color: rgba( 255, 255, 255, 1 ); /* color of the title text */

59
docs/public/css/theme-learn.css
View File

@ -6,41 +6,41 @@
@import "chroma-learn.css";
:root {
--MAIN-TEXT-color: #323232; /* Color of text by default */
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: #222222; /* text color of h1 titles */
--MAIN-LINK-color: #00bdf3; /* Color of links */
--MAIN-LINK-HOVER-color: #0082a7; /* Color of hovered links */
--MAIN-BG-color: #ffffff; /* color of text by default */
--MAIN-TEXT-color: rgba( 50, 50, 50, 1 ); /* Color of text by default */
--MAIN-TITLES-TEXT-color: rgba( 94, 94, 94, 1 ); /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: rgba( 34, 34, 34, 1 ); /* text color of h1 titles */
--MAIN-LINK-color: rgba( 0, 189, 243, 1 ); /* Color of links */
--MAIN-LINK-HOVER-color: rgba( 0, 130, 167, 1 ); /* Color of hovered links */
--MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* color of text by default */
/* adjusted to base16-snazzy chroma style */
--CODE-BLOCK-color: #e2e4e5; /* fallback color for code text */
--CODE-BLOCK-BG-color: #282a36; /* fallback color for code background */
--CODE-BLOCK-BORDER-color: #282a36; /* color of block code border */
--CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */
--CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */
--CODE-BLOCK-BORDER-color: rgba( 40, 42, 54, 1 ); /* color of block code border */
--CODE-INLINE-color: #5e5e5e; /* color for inline code text */
--CODE-INLINE-BG-color: #fff7dd; /* color for inline code background */
--CODE-INLINE-BORDER-color: #fbf0cb; /* color of inline code border */
--CODE-INLINE-color: rgba( 94, 94, 94, 1 ); /* color for inline code text */
--CODE-INLINE-BG-color: rgba( 255, 247, 221, 1 ); /* color for inline code background */
--CODE-INLINE-BORDER-color: rgba( 251, 240, 203, 1 ); /* color of inline code border */
--MENU-HOME-LINK-color: #e0e0e0; /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: #f0f0f0; /* Color of the hovered home button text */
--MENU-HOME-LINK-color: rgba( 224, 224, 224, 1 ); /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: rgba( 240, 240, 240, 1 ); /* Color of the hovered home button text */
--MENU-HEADER-BG-color: #8451a1; /* Background color of menu header */
--MENU-HEADER-BORDER-color: #9c6fb6; /*Color of menu header border */
--MENU-HEADER-BG-color: rgba( 132, 81, 161, 1 ); /* Background color of menu header */
--MENU-HEADER-BORDER-color: rgba( 156, 111, 182, 1 ); /*Color of menu header border */
--MENU-SEARCH-color: #ffffff; /* Color of search field text */
--MENU-SEARCH-BG-color: #764890; /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: #915eae; /* Override search field border color */
--MENU-SEARCH-color: rgba( 255, 255, 255, 1 ); /* Color of search field text */
--MENU-SEARCH-BG-color: rgba( 118, 72, 144, 1 ); /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: rgba( 145, 94, 174, 1 ); /* Override search field border color */
--MENU-SECTIONS-ACTIVE-BG-color: #251f29; /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: #322a38; /* Background color of other sections */
--MENU-SECTIONS-LINK-color: #cccccc; /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: #777777; /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #ffffff; /* Color of background for the active category (only) */
--MENU-SECTIONS-ACTIVE-BG-color: rgba( 37, 31, 41, 1 ); /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: rgba( 50, 42, 56, 1 ); /* Background color of other sections */
--MENU-SECTIONS-LINK-color: rgba( 204, 204, 204, 1 ); /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: rgba( 230, 230, 230, 1 ); /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 119, 119, 119, 1 ); /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba( 255, 255, 255, 1 ); /* Color of background for the active category (only) */
--MENU-VISITED-color: #00bdf3; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #2a232f; /* Color of <hr> separator in menu */
--MENU-VISITED-color: rgba( 0, 189, 243, 1 ); /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: rgba( 42, 35, 47, 1 ); /* Color of <hr> separator in menu */
/* base styling for boxes */
--BOX-CAPTION-color: rgba( 255, 255, 255, 1 ); /* color of the title text */
@ -49,12 +49,9 @@
}
body a#logo,
body a#logo:hover,
body #logo svg,
body #logo svg * {
color: var(--INTERNAL-MENU-SEARCH-color);
fill: var(--INTERNAL-MENU-SEARCH-color) !important;
}
body a#logo:hover {
color: var(--INTERNAL-MENU-SEARCH-color);
}

211
docs/public/css/theme-neon.css
View File

@ -10,47 +10,49 @@
@supports not (-ms-high-contrast:none) {
:root {
--PRIMARY-color: #f300b2; /* brand primary color */
--SECONDARY-color: #1c90f3; /* brand secondary color */
--ACCENT-color: #ffff00; /* brand accent color, used for search highlights */
--PRIMARY-color: rgba( 243, 0, 178, 1 ); /* brand primary color */
--SECONDARY-color: rgba( 28, 144, 243, 1 ); /* brand secondary color */
--ACCENT-color: rgba( 255, 255, 0, 1 ); /* brand accent color, used for search highlights */
--MAIN-TEXT-color: #e0e0e0; /* text color of content and h1 titles */
--MAIN-LINK-HOVER-color: #4cabff; /* hovered link color of content */
--MAIN-BG-color: #202020; /* background color of content */
--MAIN-TEXT-color: rgba( 224, 224, 224, 1 ); /* text color of content and h1 titles */
--MAIN-LINK-HOVER-color: rgba( 76, 171, 255, 1 ); /* hovered link color of content */
--MAIN-BG-color: rgba( 32, 32, 32, 1 ); /* background color of content */
/* optional overwrites for specific headers */
--MAIN-TITLES-TEXT-color: #f300b2; /* text color of h2-h6 titles and transparent box titles */
--MAIN-TITLES-H3-color: #00f3d3; /* text color of h3-h6 titles */
--MAIN-TITLES-H4-color: #ffff00; /* text color of h4-h6 titles */
--MAIN-TITLES-TEXT-color: rgba( 243, 0, 178, 1 ); /* text color of h2-h6 titles and transparent box titles */
--MAIN-TITLES-H3-color: rgba( 0, 243, 211, 1 ); /* text color of h3-h6 titles */
--MAIN-TITLES-H4-color: rgba( 255, 255, 0, 1 ); /* text color of h4-h6 titles */
/* adjusted to neon chroma style */
--CODE-BLOCK-color: #f8f8f2; /* fallback text color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BG-color: #000000; /* fallback background color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-color: rgba( 248, 248, 242, 1 ); /* fallback text color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BG-color: rgba( 0, 0, 0, 1 ); /* fallback background color of block code; should be adjusted to your selected chroma style */
--CODE-INLINE-color: #82e550; /* text color of inline code */
--CODE-INLINE-BG-color: #282a36; /* background color of inline code */
--CODE-INLINE-BORDER-color: #464646; /* border color of inline code */
--CODE-INLINE-color: rgba( 130, 229, 80, 1 ); /* text color of inline code */
--CODE-INLINE-BG-color: rgba( 40, 42, 54, 1 ); /* background color of inline code */
--CODE-INLINE-BORDER-color: rgba( 70, 70, 70, 1 ); /* border color of inline code */
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
--SWAGGER-theme: dark; /* name of the default Swagger theme for this variant, can be overridden in config.toml */
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
--OPENAPI-CODE-theme: tomorrow-night; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
--MENU-HEADER-BG-color: rgba( 0, 0, 0, 0 ); /* background color of menu header */
--MENU-HOME-LINK-color: #ffffff; /* home button color if configured */
--MENU-HOME-LINK-HOVER-color: #d0d0d0; /* hovered home button color if configured */
--MENU-HOME-LINK-color: rgba( 255, 255, 255, 1 ); /* home button color if configured */
--MENU-HOME-LINK-HOVER-color: rgba( 208, 208, 208, 1 ); /* hovered home button color if configured */
--MENU-SEARCH-color: #f8f8f8; /* text and icon color of search box */
--MENU-SEARCH-color: rgba( 248, 248, 248, 1 ); /* text and icon color of search box */
--MENU-SEARCH-BG-color: rgba( 16, 16, 16, .6 ); /* background color of search box */
--MENU-SEARCH-BORDER-color: #e8e8e8; /* border color of search box */
--MENU-SEARCH-BORDER-color: rgba( 232, 232, 232, 1 ); /* border color of search box */
--MENU-SECTIONS-BG-color: linear-gradient( 165deg, #f300b2d3 0%, #1c90f3b3 65%, #00e3d3b3 100% ); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
--MENU-SECTIONS-BG-color: linear-gradient( 165deg, rgba( 243, 0, 178, .825 ) 0%, rgba( 28, 144, 243, .7 ) 65%, rgba( 0, 227, 211, .7 ) 100% ); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
--MENU-SECTIONS-ACTIVE-BG-color: rgba( 0, 0, 0, .166 ); /* background color of the active menu section */
--MENU-SECTIONS-LINK-color: #ffffff; /* link color of menu topics */
--MENU-SECTIONS-LINK-HOVER-color: #d0d0d0; /* hovered link color of menu topics */
--MENU-SECTION-ACTIVE-CATEGORY-color: #56ffe8; /* text color of the displayed menu topic */
--MENU-SECTION-HR-color: #bababa; /* separator color of menu footer */
--MENU-SECTIONS-LINK-color: rgba( 255, 255, 255, 1 ); /* link color of menu topics */
--MENU-SECTIONS-LINK-HOVER-color: rgba( 208, 208, 208, 1 ); /* hovered link color of menu topics */
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 86, 255, 232, 1 ); /* text color of the displayed menu topic */
--MENU-SECTION-HR-color: rgba( 186, 186, 186, 1 ); /* separator color of menu footer */
--MENU-VISITED-color: #33a1ff; /* icon color of visited menu topics if configured */
--MENU-VISITED-color: rgba( 51, 161, 255, 1 ); /* icon color of visited menu topics if configured */
/* base styling for boxes */
--BOX-CAPTION-color: rgba( 240, 240, 240, 1 ); /* text color of colored box titles */
@ -62,7 +64,7 @@
--BOX-BLUE-TEXT-color: var( --BOX-BLUE-color ); /* text color of blue boxes */
--BOX-GREEN-color: rgba( 42, 178, 24, 1 ); /* background color of green boxes */
--BOX-GREEN-TEXT-color: var( --BOX-GREEN-color ); /* text color of green boxes */
--BOX-GREY-color: rgba( 128, 128, 128, 1 ); /* background color of grey boxes */
--BOX-GREY-color: rgba( 160, 160, 160, 1 ); /* background color of grey boxes */
--BOX-GREY-TEXT-color: var( --BOX-GREY-color ); /* text color of grey boxes */
--BOX-ORANGE-color: rgba( 237, 153, 9, 1 ); /* background color of orange boxes */
--BOX-ORANGE-TEXT-color: var( --BOX-ORANGE-color ); /* text color of orange boxes */
@ -71,6 +73,7 @@
}
body a#logo,
body a#logo:hover,
body #logo svg,
body #logo svg * {
color: var(--INTERNAL-MENU-SEARCH-BORDER-color);
@ -78,138 +81,128 @@ body #logo svg * {
}
body a#logo{
color: var(--INTERNAL-MENU-SEARCH-BORDER-color);
text-shadow:
0 0 1px var(--INTERNAL-MENU-SEARCH-BORDER-color),
0 0 2px var(--INTERNAL-MENU-SEARCH-BORDER-color),
0 0 4px var(--INTERNAL-MENU-SEARCH-BORDER-color),
0 0 8px #808080,
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color),
0 0 8px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color);
}
body h1 {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 4px #fff,
0 0 8px #fff,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 4px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 255, 255, 255, 1 ),
0 0 3px var(--INTERNAL-MAIN-TITLES-H1-color),
0 0 6px var(--INTERNAL-MAIN-TITLES-H1-color),
0 0 8px var(--INTERNAL-MAIN-TITLES-H1-color);
}
body h2 {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MAIN-TITLES-H2-color),
0 0 8px var(--INTERNAL-MAIN-TITLES-H2-color),
0 0 10px var(--INTERNAL-MAIN-TITLES-H2-color);
}
@media screen {
body:not(.print) rapi-doc::part(section-overview-title) {
color: #fff;
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 4px var(--INTERNAL-MAIN-TITLES-H2-color),
0 0 8px var(--INTERNAL-MAIN-TITLES-H2-color),
0 0 10px var(--INTERNAL-MAIN-TITLES-H2-color);
}
}
body h3, body .article-subheading {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MAIN-TITLES-H3-color),
0 0 8px var(--INTERNAL-MAIN-TITLES-H3-color),
0 0 10px var(--INTERNAL-MAIN-TITLES-H3-color);
}
body h4 {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MAIN-TITLES-H4-color),
0 0 8px var(--INTERNAL-MAIN-TITLES-H4-color),
0 0 10px var(--INTERNAL-MAIN-TITLES-H4-color);
}
body h5 {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 3px rgba( 255, 255, 255, 1 ),
0 0 6px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MAIN-TITLES-H5-color),
0 0 8px var(--INTERNAL-MAIN-TITLES-H5-color),
0 0 10px var(--INTERNAL-MAIN-TITLES-H5-color);
0 0 8px var(--INTERNAL-MAIN-TITLES-H5-color);
}
body h6 {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 4px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MAIN-TITLES-H6-color),
0 0 8px var(--INTERNAL-MAIN-TITLES-H6-color),
0 0 10px var(--INTERNAL-MAIN-TITLES-H5-color);
0 0 8px var(--INTERNAL-MAIN-TITLES-H6-color);
}
body #sidebar ul.collapsible-menu li.active > .toggle,
body #sidebar ul.topics li.active > a {
color: #fff;
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 4px var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color),
0 0 8px var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color);
.swagger-ui h4,
.swagger-ui h5,
.swagger-ui h6{
color: rgba( 255, 255, 255, 1 ) !important;
}
body #sidebar .searchbox button:hover,
body .searchbox span:hover {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MENU-SEARCH-color),
0 0 8px var(--INTERNAL-MENU-SEARCH-color);
}
body #sidebar select:hover,
body #sidebar .collapsible-menu .toggle:hover,
body #sidebar .collapsible-menu li:not(.active) > label:hover,
body #sidebar .select-container:hover,
body #sidebar a:hover,
body #sidebar button:hover {
color: #fff;
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color),
0 0 8px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color);
}
body #homelinks a:hover {
color: #fff;
body #sidebar li.active > label,
body #sidebar li.active > a {
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 8px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color),
0 0 8px var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color);
}
body #homelinks a:hover {
color: rgba( 255, 255, 255, 1 );
text-shadow:
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 8px rgba( 128, 128, 128, 1 ),
0 0 4px var(--INTERNAL-MENU-HOME-LINK-HOVER-color),
0 0 8px var(--INTERNAL-MENU-HOME-LINK-HOVER-color);
}
@ -228,9 +221,9 @@ body .badge,
body .btn,
body div.box {
box-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 4px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 4px rgba( 128, 128, 128, 1 ),
0 0 4px var(--VARIABLE-BOX-color);
}
@ -239,12 +232,13 @@ body .btn,
body .btn > *,
body div.box > .box-label {
text-shadow:
0 0 1px #fff,
0 0 2px #fff,
0 0 4px #808080,
0 0 1px rgba( 255, 255, 255, 1 ),
0 0 2px rgba( 255, 255, 255, 1 ),
0 0 4px rgba( 128, 128, 128, 1 ),
0 0 4px var(--VARIABLE-BOX-CAPTION-color);
}
body .tab-panel-cstyle:not(.transparent),
body .badge.cstyle:not(.transparent),
body .btn.cstyle {
--VARIABLE-BOX-TEXT-color: var(--VARIABLE-BOX-CAPTION-color);
@ -280,12 +274,19 @@ body .box.cstyle.transparent {
#body h6 {
text-shadow: none;
}
#body .badge,
#body .badge > .badge-content,
#body .btn,
#body .btn > *,
#body div.box,
#body div.box > .box-label {
box-shadow: none;
text-shadow: none;
}
#body .badge.cstyle:not(.transparent),
#body .btn.cstyle {
--VARIABLE-BOX-TEXT-color: var(--INTERNAL-BOX-NEUTRAL-TEXT-color);
}
}
/* if we are in print chapter preview our @media statement from
@ -298,11 +299,23 @@ above will not apply, so we have to repeat it here */
.print #body h6 {
text-shadow: none;
}
.print #body .badge,
.print #body .badge > .badge-content,
.print #body .btn,
.print #body .btn > *,
.print #body div.box,
.print #body div.box > .box-label {
box-shadow: none;
text-shadow: none;
}
.print #body .badge.cstyle:not(.transparent),
.print #body .btn.cstyle {
--VARIABLE-BOX-TEXT-color: var(--INTERNAL-BOX-NEUTRAL-TEXT-color);
}
#content-wrapper {
--ps-thumb-color: rgba( 208, 208, 208, 1 );
--ps-thumb-hover-color: rgba( 204, 204, 204, 1 );
}
}

54
docs/public/css/theme-red.css
View File

@ -6,41 +6,41 @@
@import "chroma-learn.css";
:root {
--MAIN-TEXT-color: #323232; /* Color of text by default */
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: #222222; /* text color of h1 titles */
--MAIN-LINK-color: #f31c1c; /* Color of links */
--MAIN-LINK-HOVER-color: #d01616; /* Color of hovered links */
--MAIN-BG-color: #ffffff; /* color of text by default */
--MAIN-TEXT-color: rgba( 50, 50, 50, 1 ); /* Color of text by default */
--MAIN-TITLES-TEXT-color: rgba( 94, 94, 94, 1 ); /* Color of titles h2-h3-h4-h5-h6 */
--MAIN-TITLES-H1-color: rgba( 34, 34, 34, 1 ); /* text color of h1 titles */
--MAIN-LINK-color: rgba( 243, 28, 28, 1 ); /* Color of links */
--MAIN-LINK-HOVER-color: rgba( 208, 22, 22, 1 ); /* Color of hovered links */
--MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* color of text by default */
/* adjusted to base16-snazzy chroma style */
--CODE-BLOCK-color: #e2e4e5; /* fallback color for code text */
--CODE-BLOCK-BG-color: #282a36; /* fallback color for code background */
--CODE-BLOCK-BORDER-color: #282a36; /* color of block code border */
--CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */
--CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */
--CODE-BLOCK-BORDER-color: rgba( 40, 42, 54, 1 ); /* color of block code border */
--CODE-INLINE-color: #5e5e5e; /* color for inline code text */
--CODE-INLINE-BG-color: #fffae9; /* color for inline code background */
--CODE-INLINE-BORDER-color: #f8e8c8; /* color of inline code border */
--CODE-INLINE-color: rgba( 94, 94, 94, 1 ); /* color for inline code text */
--CODE-INLINE-BG-color: rgba( 255, 250, 233, 1 ); /* color for inline code background */
--CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* color of inline code border */
--MENU-HOME-LINK-color: #382b2b; /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: #000000; /* Color of the hovered home button text */
--MENU-HOME-LINK-color: rgba( 56, 43, 43, 1 ); /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* Color of the hovered home button text */
--MENU-HEADER-BG-color: #dc1010; /* Background color of menu header */
--MENU-HEADER-BORDER-color: #e23131; /*Color of menu header border */
--MENU-HEADER-BG-color: rgba( 220, 16, 16, 1 ); /* Background color of menu header */
--MENU-HEADER-BORDER-color: rgba( 226, 49, 49, 1 ); /*Color of menu header border */
--MENU-SEARCH-color: #ffffff; /* Color of search field text */
--MENU-SEARCH-BG-color: #b90000; /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: #ef2020; /* Override search field border color */
--MENU-SEARCH-color: rgba( 255, 255, 255, 1 ); /* Color of search field text */
--MENU-SEARCH-BG-color: rgba( 185, 0, 0, 1 ); /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BORDER-color: rgba( 239, 32, 32, 1 ); /* Override search field border color */
--MENU-SECTIONS-ACTIVE-BG-color: #2b2020; /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: #312525; /* Background color of other sections */
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
--MENU-SECTIONS-ACTIVE-BG-color: rgba( 43, 32, 32, 1 ); /* Background color of the active section and its children */
--MENU-SECTIONS-BG-color: rgba( 49, 37, 37, 1 ); /* Background color of other sections */
--MENU-SECTIONS-LINK-color: rgba( 204, 204, 204, 1 ); /* Color of links in menu */
--MENU-SECTIONS-LINK-HOVER-color: rgba( 230, 230, 230, 1 ); /* Color of links in menu, when hovered */
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 119, 119, 119, 1 ); /* Color of active category text */
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba( 255, 255, 255, 1 ); /* Color of background for the active category (only) */
--MENU-VISITED-color: #f31c1c; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #2b2020; /* Color of <hr> separator in menu */
--MENU-VISITED-color: rgba( 243, 28, 28, 1 ); /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: rgba( 43, 32, 32, 1 ); /* Color of <hr> separator in menu */
/* base styling for boxes */
--BOX-CAPTION-color: rgba( 255, 255, 255, 1 ); /* color of the title text */

54
docs/public/css/theme-relearn-dark.css
View File

@ -6,43 +6,45 @@
@import "chroma-relearn-dark.css";
:root {
--PRIMARY-color: #7dc903; /* brand primary color */
--SECONDARY-color: #6c8ce3; /* brand secondary color */
--ACCENT-color: #ff44ff; /* brand accent color, used for search highlights */
--PRIMARY-color: rgba( 125, 201, 3, 1 ); /* brand primary color */
--SECONDARY-color: rgba( 108, 140, 227, 1 ); /* brand secondary color */
--ACCENT-color: rgba( 255, 68, 255, 1 ); /* brand accent color, used for search highlights */
--MAIN-TEXT-color: #e0e0e0; /* text color of content and h1 titles */
--MAIN-LINK-HOVER-color: #93b0ff; /* hovered link color of content */
--MAIN-BG-color: #202020; /* background color of content */
--MAIN-TITLES-TEXT-color: #ffffff; /* text color of h2-h6 titles and transparent box titles */
--MAIN-TEXT-color: rgba( 224, 224, 224, 1 ); /* text color of content and h1 titles */
--MAIN-LINK-HOVER-color: rgba( 147, 176, 255, 1 ); /* hovered link color of content */
--MAIN-BG-color: rgba( 32, 32, 32, 1 ); /* background color of content */
--MAIN-TITLES-TEXT-color: rgba( 255, 255, 255, 1 ); /* text color of h2-h6 titles and transparent box titles */
/* adjusted to relearn-dark chroma style */
--CODE-BLOCK-color: #f8f8f8; /* fallback text color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BG-color: #2b2b2b; /* fallback background color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-color: rgba( 248, 248, 248, 1 ); /* fallback text color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BG-color: rgba( 43, 43, 43, 1 ); /* fallback background color of block code; should be adjusted to your selected chroma style */
--CODE-INLINE-color: #82e550; /* text color of inline code */
--CODE-INLINE-BG-color: #2d2d2d; /* background color of inline code */
--CODE-INLINE-BORDER-color: #464646; /* border color of inline code */
--CODE-INLINE-color: rgba( 130, 229, 80, 1 ); /* text color of inline code */
--CODE-INLINE-BG-color: rgba( 45, 45, 45, 1 ); /* background color of inline code */
--CODE-INLINE-BORDER-color: rgba( 70, 70, 70, 1 ); /* border color of inline code */
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
--SWAGGER-theme: dark; /* name of the default Swagger theme for this variant, can be overridden in config.toml */
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
--MENU-HOME-LINK-color: #404040; /* home button color if configured */
--MENU-HOME-LINK-HOVER-color: #000000; /* hovered home button color if configured */
--MENU-HOME-LINK-color: rgba( 64, 64, 64, 1 ); /* home button color if configured */
--MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* hovered home button color if configured */
--MENU-SEARCH-color: #e0e0e0; /* text and icon color of search box */
--MENU-SEARCH-BG-color: #323232; /* background color of search box */
--MENU-SEARCH-BORDER-color: #e0e0e0; /* border color of search box */
--MENU-SEARCH-color: rgba( 224, 224, 224, 1 ); /* text and icon color of search box */
--MENU-SEARCH-BG-color: rgba( 50, 50, 50, 1 ); /* background color of search box */
--MENU-SEARCH-BORDER-color: rgba( 224, 224, 224, 1 ); /* border color of search box */
--MENU-SECTIONS-BG-color: #2b2b2b; /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
--MENU-SECTIONS-LINK-color: #bababa; /* link color of menu topics */
--MENU-SECTIONS-LINK-HOVER-color: #ffffff; /* hovered link color of menu topics */
--MENU-SECTIONS-ACTIVE-BG-color: #323232; /* background color of the active menu section */
--MENU-SECTION-ACTIVE-CATEGORY-color: #82e550; /* text color of the displayed menu topic */
--MENU-SECTION-HR-color: #606060; /* separator color of menu footer */
--MENU-SECTIONS-BG-color: rgba( 43, 43, 43, 1 ); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
--MENU-SECTIONS-LINK-color: rgba( 186, 186, 186, 1 ); /* link color of menu topics */
--MENU-SECTIONS-LINK-HOVER-color: rgba( 255, 255, 255, 1 ); /* hovered link color of menu topics */
--MENU-SECTIONS-ACTIVE-BG-color: rgba( 50, 50, 50, 1 ); /* background color of the active menu section */
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 130, 229, 80, 1 ); /* text color of the displayed menu topic */
--MENU-SECTION-HR-color: rgba( 96, 96, 96, 1 ); /* separator color of menu footer */
--MENU-VISITED-color: #486ac9; /* icon color of visited menu topics if configured */
--MENU-VISITED-color: rgba( 72, 106, 201, 1 ); /* icon color of visited menu topics if configured */
--BOX-CAPTION-color: rgba( 240, 240, 240, 1 ); /* text color of colored box titles */
--BOX-BG-color: rgba( 20, 20, 20, 1 ); /* background color of colored boxes */
--BOX-TEXT-color: #e0e0e0; /* text color of colored box content */
--BOX-TEXT-color: rgba( 224, 224, 224, 1 ); /* text color of colored box content */
}

50
docs/public/css/theme-relearn-light.css
View File

@ -6,40 +6,42 @@
@import "chroma-relearn-light.css";
:root {
--PRIMARY-color: #7dc903; /* brand primary color */
--SECONDARY-color: #486ac9; /* brand secondary color */
--ACCENT-color: #ff88ff; /* brand accent color, used for search highlights */
--PRIMARY-color: rgba( 125, 201, 3, 1 ); /* brand primary color */
--SECONDARY-color: rgba( 72, 106, 201, 1 ); /* brand secondary color */
--ACCENT-color: rgba( 255, 136, 255, 1 ); /* brand accent color, used for search highlights */
--MAIN-TEXT-color: #101010; /* text color of content and h1 titles */
--MAIN-LINK-HOVER-color: #202891; /* hovered link color of content */
--MAIN-BG-color: #ffffff; /* background color of content */
--MAIN-TITLES-TEXT-color: #4a4a4a; /* text color of h2-h6 titles and transparent box titles */
--MAIN-TEXT-color: rgba( 16, 16, 16, 1 ); /* text color of content and h1 titles */
--MAIN-LINK-HOVER-color: rgba( 32, 40, 145, 1 ); /* hovered link color of content */
--MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* background color of content */
--MAIN-TITLES-TEXT-color: rgba( 74, 74, 74, 1 ); /* text color of h2-h6 titles and transparent box titles */
/* adjusted to relearn-light chroma style */
--CODE-BLOCK-color: #000000; /* fallback text color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BG-color: #f8f8f8; /* fallback background color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BORDER-color: #d8d8d8; /* border color of block code */
--CODE-BLOCK-color: rgba( 0, 0, 0, 1 ); /* fallback text color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BG-color: rgba( 248, 248, 248, 1 ); /* fallback background color of block code; should be adjusted to your selected chroma style */
--CODE-BLOCK-BORDER-color: rgba( 216, 216, 216, 1 ); /* border color of block code */
--CODE-INLINE-color: #5e5e5e; /* text color of inline code */
--CODE-INLINE-BG-color: #fffae9; /* background color of inline code */
--CODE-INLINE-BORDER-color: #f8e8c8; /* border color of inline code */
--CODE-INLINE-color: rgba( 94, 94, 94, 1 ); /* text color of inline code */
--CODE-INLINE-BG-color: rgba( 255, 250, 233, 1 ); /* background color of inline code */
--CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */
--BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in config.toml */
--SWAGGER-theme: light; /* name of the default Swagger theme for this variant, can be overridden in config.toml */
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in config.toml */
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in config.toml */
--MENU-HOME-LINK-color: #404040; /* home button color if configured */
--MENU-HOME-LINK-HOVER-color: #000000; /* hovered home button color if configured */
--MENU-HOME-LINK-color: rgba( 64, 64, 64, 1 ); /* home button color if configured */
--MENU-HOME-LINK-HOVER-color: rgba( 0, 0, 0, 1 ); /* hovered home button color if configured */
--MENU-SEARCH-color: #e0e0e0; /* text and icon color of search box */
--MENU-SEARCH-BG-color: #323232; /* background color of search box */
--MENU-SEARCH-BORDER-color: #e0e0e0; /* border color of search box */
--MENU-SEARCH-color: rgba( 224, 224, 224, 1 ); /* text and icon color of search box */
--MENU-SEARCH-BG-color: rgba( 50, 50, 50, 1 ); /* background color of search box */
--MENU-SEARCH-BORDER-color: rgba( 224, 224, 224, 1 ); /* border color of search box */
--MENU-SECTIONS-BG-color: #282828; /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
--MENU-SECTIONS-BG-color: rgba( 40, 40, 40, 1 ); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
--MENU-SECTIONS-ACTIVE-BG-color: rgba( 0, 0, 0, .166 ); /* background color of the active menu section */
--MENU-SECTIONS-LINK-color: #bababa; /* link color of menu topics */
--MENU-SECTIONS-LINK-HOVER-color: #ffffff; /* hovered link color of menu topics */
--MENU-SECTION-ACTIVE-CATEGORY-color: #444444; /* text color of the displayed menu topic */
--MENU-SECTION-HR-color: #606060; /* separator color of menu footer */
--MENU-SECTIONS-LINK-color: rgba( 186, 186, 186, 1 ); /* link color of menu topics */
--MENU-SECTIONS-LINK-HOVER-color: rgba( 255, 255, 255, 1 ); /* hovered link color of menu topics */
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 68, 68, 68, 1 ); /* text color of the displayed menu topic */
--MENU-SECTION-HR-color: rgba( 96, 96, 96, 1 ); /* separator color of menu footer */
--BOX-CAPTION-color: rgba( 255, 255, 255, 1 ); /* text color of colored box titles */
--BOX-BG-color: rgba( 255, 255, 255, .833 ); /* background color of colored boxes */

808
docs/public/css/theme.css
View File

File diff suppressed because it is too large Load Diff

195
docs/public/css/variant.css
View File

@ -1,105 +1,7 @@
:root {
/* initially use section background to avoid flickering on load when a non default variant is active;
this is only possible because every color variant defines this variable, otherwise we would have been lost */
--INTERNAL-PRIMARY-color: var(--PRIMARY-color, var(--MENU-HEADER-BG-color, rgba( 0, 0, 0, 0 ))); /* not --INTERNAL-MENU-HEADER-BG-color */
--INTERNAL-SECONDARY-color: var(--SECONDARY-color, var(--MAIN-LINK-color, #486ac9)); /* not --INTERNAL-MAIN-LINK-color */
--INTERNAL-ACCENT-color: var(--ACCENT-color, #ffff00);
@import "variant-internal.css";
--INTERNAL-MAIN-LINK-color: var(--MAIN-LINK-color, var(--SECONDARY-color, #486ac9)); /* not --INTERNAL-SECONDARY-color */
--INTERNAL-MAIN-LINK-HOVER-color: var(--MAIN-LINK-HOVER-color, var(--INTERNAL-MAIN-LINK-color));
--INTERNAL-MAIN-BG-color: var(--MAIN-BG-color, #ffffff);
--INTERNAL-MAIN-TEXT-color: var(--MAIN-TEXT-color, #101010);
--INTERNAL-MAIN-TITLES-TEXT-color: var(--MAIN-TITLES-TEXT-color, var(--INTERNAL-MAIN-TEXT-color));
--INTERNAL-MAIN-TITLES-H1-color: var(--MAIN-TITLES-H1-color, var(--INTERNAL-MAIN-TEXT-color));
--INTERNAL-MAIN-TITLES-H2-color: var(--MAIN-TITLES-H2-color, var(--INTERNAL-MAIN-TITLES-TEXT-color));
--INTERNAL-MAIN-TITLES-H3-color: var(--MAIN-TITLES-H3-color, var(--INTERNAL-MAIN-TITLES-H2-color));
--INTERNAL-MAIN-TITLES-H4-color: var(--MAIN-TITLES-H4-color, var(--INTERNAL-MAIN-TITLES-H3-color));
--INTERNAL-MAIN-TITLES-H5-color: var(--MAIN-TITLES-H5-color, var(--INTERNAL-MAIN-TITLES-H4-color));
--INTERNAL-MAIN-TITLES-H6-color: var(--MAIN-TITLES-H6-color, var(--INTERNAL-MAIN-TITLES-H5-color));
--INTERNAL-MAIN-font: var(--MAIN-font, "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif);
--INTERNAL-MAIN-TITLES-TEXT-font: var(--MAIN-TITLES-TEXT-font, var(--INTERNAL-MAIN-font));
--INTERNAL-MAIN-TITLES-H1-font: var(--MAIN-TITLES-H1-font, var(--INTERNAL-MAIN-font));
--INTERNAL-MAIN-TITLES-H2-font: var(--MAIN-TITLES-H2-font, var(--INTERNAL-MAIN-TITLES-TEXT-font));
--INTERNAL-MAIN-TITLES-H3-font: var(--MAIN-TITLES-H3-font, var(--INTERNAL-MAIN-TITLES-H2-font));
--INTERNAL-MAIN-TITLES-H4-font: var(--MAIN-TITLES-H4-font, var(--INTERNAL-MAIN-TITLES-H3-font));
--INTERNAL-MAIN-TITLES-H5-font: var(--MAIN-TITLES-H5-font, var(--INTERNAL-MAIN-TITLES-H4-font));
--INTERNAL-MAIN-TITLES-H6-font: var(--MAIN-TITLES-H6-font, var(--INTERNAL-MAIN-TITLES-H5-font));
--INTERNAL-CODE-BLOCK-color: var(--CODE-BLOCK-color, var(--MAIN-CODE-color, #000000));
--INTERNAL-CODE-BLOCK-BG-color: var(--CODE-BLOCK-BG-color, var(--MAIN-CODE-BG-color, #f8f8f8));
--INTERNAL-CODE-BLOCK-BORDER-color: var(--CODE-BLOCK-BORDER-color, var(--MAIN-CODE-BG-color, var(--INTERNAL-CODE-BLOCK-BG-color)));
--INTERNAL-CODE-INLINE-color: var(--CODE-INLINE-color, #5e5e5e);
--INTERNAL-CODE-INLINE-BG-color: var(--CODE-INLINE-BG-color, #fffae9);
--INTERNAL-CODE-INLINE-BORDER-color: var(--CODE-INLINE-BORDER-color, #fbf0cb);
--INTERNAL-CODE-font: var(--CODE-font, "Consolas", menlo, monospace);
--INTERNAL-MERMAID-theme: var(--CONFIG-MERMAID-theme, var(--MERMAID-theme, var(--INTERNAL-PRINT-MERMAID-theme)));
--INTERNAL-SWAGGER-theme: var(--CONFIG-SWAGGER-theme, var(--SWAGGER-theme, var(--INTERNAL-PRINT-SWAGGER-theme)));
--INTERNAL-TAG-BG-color: var(--TAG-BG-color, var(--INTERNAL-PRIMARY-color));
--INTERNAL-MENU-HEADER-BG-color: var(--MENU-HEADER-BG-color, var(--PRIMARY-color, rgba( 0, 0, 0, 0 ))); /* not --INTERNAL-PRIMARY-color */
--INTERNAL-MENU-HEADER-BORDER-color: var(--MENU-HEADER-BORDER-color, var(--INTERNAL-MENU-HEADER-BG-color));
--INTERNAL-MENU-HOME-LINK-color: var(--MENU-HOME-LINK-color, #323232);
--INTERNAL-MENU-HOME-LINK-HOVER-color: var(--MENU-HOME-LINK-HOVER-color, var(--MENU-HOME-LINK-HOVERED-color, #808080));
--INTERNAL-MENU-SEARCH-color: var(--MENU-SEARCH-color, var(--MENU-SEARCH-BOX-ICONS-color, #e0e0e0));
--INTERNAL-MENU-SEARCH-BG-color: var(--MENU-SEARCH-BG-color, #323232);
--INTERNAL-MENU-SEARCH-BORDER-color: var(--MENU-SEARCH-BORDER-color, var(--MENU-SEARCH-BOX-color, var(--INTERNAL-MENU-SEARCH-BG-color)));
--INTERNAL-MENU-SECTIONS-ACTIVE-BG-color: var(--MENU-SECTIONS-ACTIVE-BG-color, rgba( 0, 0, 0, .166 ));
--INTERNAL-MENU-SECTIONS-BG-color: var(--MENU-SECTIONS-BG-color, #282828);
--INTERNAL-MENU-SECTIONS-LINK-color: var(--MENU-SECTIONS-LINK-color, #bababa);
--INTERNAL-MENU-SECTIONS-LINK-HOVER-color: var(--MENU-SECTIONS-LINK-HOVER-color, var(--INTERNAL-MENU-SECTIONS-LINK-color));
--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color: var(--MENU-SECTION-ACTIVE-CATEGORY-color, #444444);
--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-BG-color: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color, var(--INTERNAL-MAIN-BG-color));
--INTERNAL-MENU-VISITED-color: var(--MENU-VISITED-color, var(--INTERNAL-SECONDARY-color));
--INTERNAL-MENU-SECTION-HR-color: var(--MENU-SECTION-HR-color, #606060);
--INTERNAL-BOX-CAPTION-color: var(--BOX-CAPTION-color, rgba( 255, 255, 255, 1 ));
--INTERNAL-BOX-BG-color: var(--BOX-BG-color, rgba( 255, 255, 255, .833 ));
--INTERNAL-BOX-TEXT-color: var(--BOX-TEXT-color, var(--INTERNAL-MAIN-TEXT-color));
--INTERNAL-BOX-BLUE-color: var(--BOX-BLUE-color, rgba( 48, 117, 229, 1 ));
--INTERNAL-BOX-GREEN-color: var(--BOX-GREEN-color, rgba( 42, 178, 24, 1 ));
--INTERNAL-BOX-GREY-color: var(--BOX-GREY-color, rgba( 128, 128, 128, 1 ));
--INTERNAL-BOX-ORANGE-color: var(--BOX-ORANGE-color, rgba( 237, 153, 9, 1 ));
--INTERNAL-BOX-RED-color: var(--BOX-RED-color, rgba( 224, 62, 62, 1 ));
--INTERNAL-BOX-INFO-color: var(--BOX-INFO-color, var(--INTERNAL-BOX-BLUE-color));
--INTERNAL-BOX-NEUTRAL-color: var(--BOX-NEUTRAL-color, var(--INTERNAL-BOX-GREY-color));
--INTERNAL-BOX-NOTE-color: var(--BOX-NOTE-color, var(--INTERNAL-BOX-ORANGE-color));
--INTERNAL-BOX-TIP-color: var(--BOX-TIP-color, var(--INTERNAL-BOX-GREEN-color));
--INTERNAL-BOX-WARNING-color: var(--BOX-WARNING-color, var(--INTERNAL-BOX-RED-color));
--INTERNAL-BOX-BLUE-TEXT-color: var(--BOX-BLUE-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
--INTERNAL-BOX-GREEN-TEXT-color: var(--BOX-GREEN-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
--INTERNAL-BOX-GREY-TEXT-color: var(--BOX-GREY-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
--INTERNAL-BOX-ORANGE-TEXT-color: var(--BOX-ORANGE-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
--INTERNAL-BOX-RED-TEXT-color: var(--BOX-RED-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
--INTERNAL-BOX-INFO-TEXT-color: var(--BOX-INFO-TEXT-color, var(--INTERNAL-BOX-BLUE-TEXT-color));
--INTERNAL-BOX-NEUTRAL-TEXT-color: var(--BOX-NEUTRAL-TEXT-color, var(--INTERNAL-BOX-GREY-TEXT-color));
--INTERNAL-BOX-NOTE-TEXT-color: var(--BOX-NOTE-TEXT-color, var(--INTERNAL-BOX-ORANGE-TEXT-color));
--INTERNAL-BOX-TIP-TEXT-color: var(--BOX-TIP-TEXT-color, var(--INTERNAL-BOX-GREEN-TEXT-color));
--INTERNAL-BOX-WARNING-TEXT-color: var(--BOX-WARNING-TEXT-color, var(--INTERNAL-BOX-RED-TEXT-color));
/* print style, values taken from relearn-light as it is used as a default print style */
--INTERNAL-PRINT-MERMAID-theme: var(--PRINT-MERMAID-theme, default);
--INTERNAL-PRINT-MAIN-BG-color: var(--PRINT-MAIN-BG-color, #ffffff);
--INTERNAL-PRINT-CODE-font: var(--PRINT-CODE-font, "Consolas", menlo, monospace);
--INTERNAL-PRINT-TAG-BG-color: var(--PRINT-TAG-BG-color, #7dc903);
--INTERNAL-PRINT-MAIN-font: var(--PRINT-MAIN-font, "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif);
--INTERNAL-PRINT-MAIN-TEXT-color: var(--PRINT-MAIN-TEXT-color, #101010);
--INTERNAL-PRINT-SWAGGER-theme: var(--PRINT-SWAGGER-theme, light);
html {
color-scheme: only var(--INTERNAL-BROWSER-theme);
}
body {
@ -150,7 +52,7 @@ a:hover,
color: var(--INTERNAL-MENU-SEARCH-color);
}
#sidebar .collapsible-menu .toggle,
#sidebar .collapsible-menu label,
#sidebar .select-container,
#sidebar a,
#sidebar button {
@ -158,28 +60,28 @@ a:hover,
}
#sidebar select:hover,
#sidebar .collapsible-menu .toggle:hover,
#sidebar .collapsible-menu li:not(.active) > label:hover,
#sidebar .select-container:hover,
#sidebar a:hover,
#sidebar button:hover {
color: var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color);
}
#sidebar ul.topics > li.parent,
#sidebar ul.topics > li.active {
#sidebar ul.enlarge > li.parent,
#sidebar ul.enlarge > li.active {
background-color: var(--INTERNAL-MENU-SECTIONS-ACTIVE-BG-color);
}
#sidebar ul.collapsible-menu li.active > .toggle,
#sidebar ul.topics li.active > a {
#sidebar li.active > label,
#sidebar li.active > a {
color: var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color);
}
#sidebar ul.topics li.active > a {
#sidebar li.active > a {
background-color: var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-BG-color);
}
#sidebar ul li.visited > a .read-icon {
#sidebar ul li > a .read-icon {
color: var(--INTERNAL-MENU-VISITED-color);
}
@ -231,6 +133,7 @@ h6 {
div.box {
background-color: var(--VARIABLE-BOX-color);
border-color: var(--VARIABLE-BOX-color);
}
div.box > .box-label {
@ -302,6 +205,13 @@ div.box > .box-content {
--VARIABLE-BOX-TEXT-color: var(--INTERNAL-BOX-RED-TEXT-color);
}
.cstyle.code {
--VARIABLE-BOX-color: var(--INTERNAL-CODE-BLOCK-BORDER-color);
--VARIABLE-BOX-CAPTION-color: var(--INTERNAL-CODE-BLOCK-color);
--VARIABLE-BOX-BG-color: var(--INTERNAL-CODE-BLOCK-BG-color);
--VARIABLE-BOX-TEXT-color: var(--INTERNAL-CODE-BLOCK-color);
}
.cstyle.transparent {
--VARIABLE-BOX-color: transparent;
--VARIABLE-BOX-CAPTION-color: var(--INTERNAL-MAIN-TITLES-TEXT-color);
@ -449,11 +359,6 @@ pre .copy-to-clipboard-button:hover {
background-color: var(--INTERNAL-MAIN-BG-color);
}
#body .tab-nav-button.active {
background-color: var(--INTERNAL-MAIN-BG-color) !important;
border-bottom-color: var(--INTERNAL-MAIN-BG-color) !important;
}
.badge > * {
border-color: var(--VARIABLE-BOX-TEXT-color);
}
@ -466,3 +371,65 @@ pre .copy-to-clipboard-button:hover {
.badge.cstyle.transparent{
--VARIABLE-BOX-BG-color: var(--INTERNAL-BOX-BG-color);
}
article ul > li > input[type="checkbox"] {
background-color: var(--INTERNAL-MAIN-BG-color); /* box background */
color: var(--INTERNAL-MAIN-TEXT-color);
}
#body .tab-nav-button {
color: var(--INTERNAL-MAIN-TEXT-color);
}
#body .tab-nav-button.active {
background-color: var(--VARIABLE-BOX-color);
border-bottom-color: var(--VARIABLE-BOX-BG-color);
color: var(--VARIABLE-BOX-TEXT-color);
}
#body .tab-nav-button.active > *{
background-color: var(--VARIABLE-BOX-BG-color);
}
#body .tab-nav-button > * > *{
border-color: var(--VARIABLE-BOX-color);
}
#body .tab-content{
background-color: var(--VARIABLE-BOX-color);
border-color: var(--VARIABLE-BOX-color);
}
#body .tab-content-text{
background-color: var(--VARIABLE-BOX-BG-color);
color: var(--VARIABLE-BOX-TEXT-color);
}
.tab-panel-style.cstyle.initial,
.tab-panel-style.cstyle.default {
--VARIABLE-BOX-BG-color: var(--INTERNAL-MAIN-BG-color);
}
.tab-panel-style.cstyle.transparent {
--VARIABLE-BOX-color: rgba( 134, 134, 134, .4 );
--VARIABLE-BOX-BG-color: transparent;
}
#body .tab-panel-style.cstyle.initial.tab-nav-button.active,
#body .tab-panel-style.cstyle.default.tab-nav-button.active,
#body .tab-panel-style.cstyle.transparent.tab-nav-button.active{
background-color: var(--VARIABLE-BOX-BG-color);
border-left-color: var(--VARIABLE-BOX-color);
border-right-color: var(--VARIABLE-BOX-color);
border-top-color: var(--VARIABLE-BOX-color);
}
#body .tab-panel-style.cstyle.code.tab-nav-button:not(.active){
--VARIABLE-BOX-color: var(--INTERNAL-BOX-NEUTRAL-color);
}
#body .tab-panel-style.cstyle.initial.tab-content,
#body .tab-panel-style.cstyle.default.tab-content,
#body .tab-panel-style.cstyle.transparent.tab-content{
background-color: var(--VARIABLE-BOX-BG-color);
}

187
docs/public/getting-started/config/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 configure Backy.
">
<title>Config File Definitions - 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,8 +55,7 @@
</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>
@ -65,6 +64,7 @@
<li><a href="#hosts">Hosts</a></li>
<li><a href="#notifications">Notifications</a></li>
<li><a href="#logging">Logging</a></li>
<li><a href="#vault">Vault</a></li>
</ul>
</li>
</ul>
@ -75,49 +75,55 @@
</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="config-file-definitions">Config File Definitions</h1>
<h3 id="commands">Commands</h3>
<p>The commands section is for defining commands. These can be run with or without a shell and on a host or locally.</p>
<p>See the <a href="/config/commands">commands documentation</a> for further information.</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:#ae81ff">   </span> <span style="color:#75715e"># if host is not defined, cmd 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:#ae81ff">   </span> <span style="color:#75715e"># The host has to be defined in the config file</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 style="color:#75715e"># defined in .env file in config directory</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">  shell-cmd</span>:
</span></span><span style="display:flex;"><span><span style="color:#f92672">    cmd</span>: <span style="color:#ae81ff">rsync</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">    shell</span>: <span style="color:#ae81ff">bash</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">      - -av</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">output</span>: <span style="color:#66d9ef">true</span> <span style="color:#75715e"># Optional and only when run in list and notifications are sent</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, cmd 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 the config file</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 style="color:#75715e"># defined in .env file in config directory</span>
</span></span><span style="display:flex;"><span>  <span style="color:#f92672">shell-cmd</span>:
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">cmd</span>: <span style="color:#ae81ff">rsync</span>
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">shell</span>: <span style="color:#ae81ff">bash</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">av</span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">some-host:/path/to/data </span>
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">~/Docker/Backups/docker-data</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">    cmd</span>: <span style="color:#ae81ff">hostname</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">script</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">type</span>: <span style="color:#ae81ff">scriptFile</span> <span style="color:#75715e"># run a local script on a remote host</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cmd</span>: <span style="color:#ae81ff">path/to/your/script.sh</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">hostname</span>:
</span></span><span style="display:flex;"><span>    <span style="color:#f92672">cmd</span>: <span style="color:#ae81ff">hostname</span>
</span></span></code></pre></div><h3 id="lists">Lists</h3>
<p>To execute groups of commands in sequence, use a list configuration.</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">cmd-configs</span>:
<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">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:#75715e"># all commands have to be defined</span>
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># all commands have to be defined in the commands section</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">getOutput</span>: <span style="color:#66d9ef">true</span> <span style="color:#75715e"># Optional and only for when notifications are sent</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>
@ -133,11 +139,12 @@
<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 a commands object does not match any <code>host</code> object, the needed values will be checked in the default SSH config files.</p>
</div>
</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">hosts</span>:
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># any ssh_config(5) keys/values not listed here will be looked up in the config file or the default config file</span>
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># any needed ssh_config(5) keys/values not listed here will be looked up in the config file or the default config file</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">some-host</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">hostname</span>: <span style="color:#ae81ff">some-hostname</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">config</span>: <span style="color:#ae81ff">~/.ssh/config</span>
@ -152,7 +159,7 @@
</span></span><span style="display:flex;"><span> <span style="color:#f92672">proxyjump</span>: <span style="color:#ae81ff">some-proxy-host</span>
</span></span></code></pre></div><h3 id="notifications">Notifications</h3>
<p>The notifications object can have two forms.</p>
<p>For more, <a href="/config/notifications">see the notification object documentation</a>. The top-level map key is id that has to be referenced by the <code>cmd-configs</code> key <code>notifications</code>.</p>
<p>For more, <a href="/config/notifications">see the notification object documentation</a>. The top-level map key is id that has to be referenced by the <code>cmd-lists</code> key <code>notifications</code>.</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>
@ -179,14 +186,30 @@
</span></span><span style="display:flex;"><span> <span style="color:#f92672">file</span>: <span style="color:#ae81ff">path/to/log/file.log</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">console-disabled</span>: <span style="color:#66d9ef">false</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cmd-std-out</span>: <span style="color:#66d9ef">false</span>
</span></span></code></pre></div>
</span></span></code></pre></div><h3 id="vault">Vault</h3>
<p><a href="https://www.vaultproject.io/" target="_blank">Vault</a> can be used to get some configuration values and ENV variables securely.</p>
<pre tabindex="0"><code>vault:
token: hvs.tXqcASvTP8wg92f7riyvGyuf
address: http://127.0.0.1:8200
enabled: false
keys:
- name: mongourl
mountpath: secret
path: mongo/url
type: # KVv1 or KVv2
- name:
path:
type:
mountpath:
</code></pre>
<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>
@ -245,27 +268,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 parent"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle" checked><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 active"><a href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class="dd-item"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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="parent "><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b" checked><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="active"><a class="padding" href="/getting-started/config/index.html">Config File Definitions</a></li></ul></li>
<li data-nav-id="/config/index.html" class=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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">
@ -275,6 +299,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="/getting-started/config/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -294,7 +319,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">
@ -302,8 +327,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 ){
@ -333,23 +358,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>

106
docs/public/getting-started/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 get started with Backy.
">
<title>Getting started - A tool for commands</title>
<link href="/getting-started/index.xml" rel="alternate" type="application/rss+xml" title="Getting started - 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,20 +58,22 @@
</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="getting-started">Getting started</h1>
<p>If you have not installed Backy, <a href="install">see the install documentation</a>.</p>
<p>If you need to configure it, <a href="config">see the config page</a>.</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>
@ -130,27 +132,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 active parent"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle" checked><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"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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="active parent "><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b" checked><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=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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">
@ -160,6 +163,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="/getting-started/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -179,7 +183,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">
@ -187,8 +191,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 ){
@ -218,23 +222,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>

48
docs/public/getting-started/index.xml
View File

@ -11,19 +11,53 @@
<link>http://example.org/getting-started/install/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/getting-started/install/index.html</guid>
<description>Binaries are available from the release page. Make sure to get the correct version for your system, which supports x86_64, ARM64, and i386.
Source Install You can install from source. You will need Go installed.
Then run:
go install git.andrewnw.xyz/CyberShell/backy@master Once set, jump over to the config docs and start configuring your file.</description>
<description>&lt;p&gt;Binaries are available from the &lt;a href=&#34;https://git.andrewnw.xyz/CyberShell/backy/releases&#34; target=&#34;_blank&#34;&gt;release page&lt;/a&gt;. Make sure to get the correct version for your system, which supports x86_64, ARM64, and i386.&lt;/p&gt;
&lt;h3 id=&#34;source-install&#34;&gt;Source Install&lt;/h3&gt;
&lt;p&gt;You can install from source. You will need &lt;a href=&#34;https://go.dev/doc/install&#34; target=&#34;_blank&#34;&gt;Go installed&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;Then run:&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-bash&#34; data-lang=&#34;bash&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;go install git.andrewnw.xyz/CyberShell/backy@master
&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Once set, jump over to the &lt;a href=&#34;http://example.org/getting-started/config&#34;&gt;config docs&lt;/a&gt; and start configuring your file.&lt;/p&gt;</description>
</item>
<item>
<title>Config File Definitions</title>
<link>http://example.org/getting-started/config/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/getting-started/config/index.html</guid>
<description>Commands The commands section is for defining commands. These can be run with or without a shell and on a host or locally.
See the commands documentation for further information.
commands: stop-docker-container: cmd: docker args: - compose - -f /some/path/to/docker-compose.yaml - down # if host is not defined, cmd will be run locally host: some-host backup-docker-container-script: cmd: /path/to/script # The host has to be defined in the config file host: some-host environment: - FOO=BAR - APP=$VAR # defined in .</description>
<description>&lt;h3 id=&#34;commands&#34;&gt;Commands&lt;/h3&gt;
&lt;p&gt;The commands section is for defining commands. These can be run with or without a shell and on a host or locally.&lt;/p&gt;
&lt;p&gt;See the &lt;a href=&#34;http://example.org/config/commands&#34;&gt;commands documentation&lt;/a&gt; for further information.&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;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;output&lt;/span&gt;: &lt;span style=&#34;color:#66d9ef&#34;&gt;true&lt;/span&gt; &lt;span style=&#34;color:#75715e&#34;&gt;# Optional and only when run in list and notifications are sent&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, cmd 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:#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:#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/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;# The host has to be defined in the config file&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:#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 style=&#34;color:#75715e&#34;&gt;# defined in .env file in config directory&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;shell-cmd&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;rsync&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;shell&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;bash&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;av&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-host:/path/to/data &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;~/Docker/Backups/docker-data&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;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;type&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;scriptFile&lt;/span&gt; &lt;span style=&#34;color:#75715e&#34;&gt;# run a local script on a remote 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:#f92672&#34;&gt;cmd&lt;/span&gt;: &lt;span style=&#34;color:#ae81ff&#34;&gt;path/to/your/script.sh&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:#f92672&#34;&gt;hostname&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;hostname&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;h3 id=&#34;lists&#34;&gt;Lists&lt;/h3&gt;
&lt;p&gt;To execute groups of commands in sequence, use a list configuration.&lt;/p&gt;</description>
</item>
</channel>
</rss>

108
docs/public/getting-started/install/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 install Backy.
">
<title>Install Backy - 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,8 +55,7 @@
</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>
@ -71,9 +70,9 @@
</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="install-backy">Install Backy</h1>
<p>Binaries are available from the <a href="https://git.andrewnw.xyz/CyberShell/backy/releases" target="_blank">release page</a>. Make sure to get the correct version for your system, which supports x86_64, ARM64, and i386.</p>
@ -84,12 +83,13 @@
</span></span></code></pre></div><p>Once set, jump over to the <a href="/getting-started/config">config docs</a> and start configuring your file.</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>
@ -148,27 +148,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 parent"><input type="checkbox" id="section-c727fab97b4d77e5b28ce8c448fb9000" aria-controls="subsections-c727fab97b4d77e5b28ce8c448fb9000" class="toggle" checked><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 active"><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"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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="parent "><input type="checkbox" id="section-ffe9773a38b1e1cbc000aa49823cb86b" aria-controls="subsections-ffe9773a38b1e1cbc000aa49823cb86b" checked><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="active"><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=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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">
@ -178,6 +179,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="/getting-started/install/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -197,7 +199,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">
@ -205,8 +207,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 ){
@ -236,23 +238,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>

113
docs/public/index.html
View File

@ -3,24 +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="">
<title>Backy - A tool for commands</title>
<link href="/index.xml" rel="alternate" type="application/rss+xml" title="Backy - A tool for commands">
<link href="/index.search.js" rel="alternate" type="text/javascript" title="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
@ -43,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">
@ -55,8 +56,7 @@
</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><a href="#features">Features</a></li>
</ul>
@ -67,19 +67,21 @@
</nav>
<main id="body-inner" class="highlightable home" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="home">
<header class="headline">
</header>
<h1 id="backy">Backy</h1>
<p>Backy is a tool for automating data backup and remote command execution. It can work over SSH, and provides completion and failure notifications, error reporting, and more.</p>
<p>Why the name Backy? Because I wanted an app for backups.</p>
<p>View the <a href="https://git.andrewnw.xyz/CyberShell/backy/src/branch/master/CHANGELOG.md" target="_blank">changelog here</a>.</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>Feel free to open a <a href="https://git.andrewnw.xyz/CyberShell/backy/pulls" target="_blank">PR</a>, raise an <a href="https://git.andrewnw.xyz/CyberShell/backy/issues" title="Open a Gitea Issue" target="_blank">issue</a>(s), or request new feature(s).</p>
</div>
</div>
</div>
<h2 id="features">Features</h2>
<ul>
@ -104,12 +106,13 @@
</ul>
<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>
@ -168,27 +171,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"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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">
@ -198,6 +202,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="/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -217,7 +222,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">
@ -225,8 +230,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 ){
@ -256,23 +261,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>

49
docs/public/index.search.js
View File

@ -1,4 +1,11 @@
var relearn_search_index = [
{
"content": "The yaml top-level map can be any string.\nThe top-level name must be unique.\nExample Config 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 # The host has to be defined in either the config file or the SSH Config files host: some-host hooks error: - some-other-command-when-failing success: - success-command final: - final-command backup-docker-container-script: cmd: /path/to/local/script # script file is input as stdin to SSH type: scriptFile # also can be script environment: - FOO=BAR - APP=$VAR Values available for this section:\nname notes type required cmd Defines the command to execute string yes args Defines the arguments to the command []string no environment Defines evironment variables for the command []string no type May be scriptFile or script. Runs script from local machine on remote. Only applicable when host is defined. string no getOutput Command(s) output is in the notification(s) bool no host If not specified, the command will execute locally. string no scriptEnvFile When type is scriptFile, the script is appended to this file. string no shell Only applicable when host is not specified string no hooks Hooks are used at the end of the individual command. Must be another command. []string no cmd cmd must be a valid command or script to execute.\nargs args must be arguments to cmd as they would be on the command-line:\ncmd [arg1 arg2 ...] Define them in an array:\nargs: - arg1 - arg2 - arg3 getOutput Get command output when a notification is sent.\nIs not required. Can be true or false.\nhost Info If any host is not defined or left blank, the command will run on the local machine.\nHost may or may not be defined in the hosts section.\nInfo If any host from the commands section does not match any object in the hosts section, the Host is assumed to be this value. This value will be used to search in the default SSH config files.\nFor example, say that I have a host defined in my SSH config with the Host defined as web-prod. If I assign a value to host as host: web-prod and don’t specify this value in the hosts object, web-prod will be used as the Host in searching the SSH config files.\nshell If shell is defined and host is NOT defined, the command will run in the specified shell. Make sure to escape any shell input.\nscriptEnvFile Path to a file.\nWhen type is specified, the script is appended to this file.\nThis is useful for specifying environment variables or other things so they don’t have to be included in the script.\ntype May be scriptFile or script. Runs script from local machine on remote host passed to the SSH session as standard input.\nIf type is script, cmd is used as the script.\nIf type is scriptFile, cmd must be a script file.\nenvironment The environment variables support expansion:\nusing escaped values $VAR or ${VAR} For now, the variables have to be defined in an .env file in the same directory as the config file.\nIf using it with host specified, the SSH server has to be configured to accept those env variables.\nIf the command is run locally, the OS’s environment is added.\nhooks Hooks are run after the command is run.\nErrors are run if the command errors, success if it returns no error. Final hooks are run regardless of error condition.\nValues for hooks are as follows:\ncommand: hook: # these commands are defined elsewhere in the file error: - errcommand success: - successcommand final: - donecommand ",
"description": "",
"tags": null,
"title": "Commands",
"uri": "/config/commands/index.html"
},
{
"content": "Binaries are available from the release page. Make sure to get the correct version for your system, which supports x86_64, ARM64, and i386.\nSource Install You can install from source. You will need Go installed.\nThen run:\ngo install git.andrewnw.xyz/CyberShell/backy@master Once set, jump over to the config docs and start configuring your file.\n",
"description": "This page tells you how to install Backy.\n",
@ -7,56 +14,56 @@ var relearn_search_index = [
"uri": "/getting-started/install/index.html"
},
{
"content": "Command lists are for executing commands in sequence and getting notifications from them.\nThe top-level object key can be anything you want.\nkey 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. Each command must be defined.\nNotifications An array of notification IDs to use on success and failure. Must match any of the notifications object map keys.\nName Name is optional for logging. If name is not defined, name will be the object’s map key.\nCron mode Backy also has a cron mode, so one can run backy cron and start a process that schedules jobs to run at times defined in the configuration file.\nAdding cron: 0 0 1 * * * to a cmd-configs object will schedule the list at 1 in the morning. See https://crontab.guru/ for reference.\nTip Note: Backy uses the second field of cron, so add anything except * to the beginning of a regular cron expression.\ncmd-configs: cmds-to-run: # this can be any name you want # all commands have to be defined order: - stop-docker-container - backup-docker-container-script - shell-cmd - hostname notifications: - matrix name: backup-some-server cron: \"0 0 1 * * *\" hostname: name: hostname order: - hostname notifications: - prod-email ",
"content": "Command lists are for executing commands in sequence and getting notifications from them.\nThe top-level object key can be anything you want but not the same as another.\nLists can go in a separate file. Command lists should be in a separate file if:\nkey ‘cmd-lists.file’ is found hosts.yml or hosts.yaml is found in the same directory as the backy config file test2: name: test2 order: - test - test2 notifications: - mail.prod-email - matrix.sysadmin cron: \"0 * * * * *\" key description type required order Defines the sequence of commands to execute []string yes getOutput Command(s) output is in the notification(s) bool no notifications The notification service(s) and ID(s) to use on success and failure. Must be service.id. See the notifications documentation page for more []string no name Optional name of the list string no cron Time at which to schedule the list. Only has affect when cron subcommand is run. string no Order The order is an array of commands to execute in order. Each command must be defined.\norder: - cmd-1 - cmd-2 getOutput Get command output when a notification is sent.\nIs not required. Can be true or false. Default is false.\nNotifications An array of notification IDs to use on success and failure. Must match any of the notifications object map keys.\nName Name is optional. If name is not defined, name will be the object’s map key.\nCron mode Backy also has a cron mode, so one can run backy cron and start a process that schedules jobs to run at times defined in the configuration file.\nAdding cron: 0 0 1 * * * to a cmd-lists object will schedule the list at 1 in the morning. See https://crontab.guru/ for reference.\nTip Note: Backy uses the second field of cron, so add anything except * to the beginning of a regular cron expression.\ncmd-lists: docker-container-backup: # this can be any name you want # all commands have to be defined order: - stop-docker-container - backup-docker-container-script - shell-cmd - hostname - start-docker-container notifications: - matrix.id name: backup-some-container cron: \"0 0 1 * * *\" hostname: name: hostname order: - hostname notifications: - mail.prod-email ",
"description": "This page tells you how to get started with Backy.\n",
"tags": null,
"title": "Command Lists",
"uri": "/config/command-lists/index.html"
},
{
"content": "The yaml top-level map can be any string.\nThe top-level name must be unique.\ncommands: 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:\nname description type required cmd Defines the command to execute string yes args Defines the arguments to the command []string no environment Defines evironment variables for the command []string no host If not specified, the command will execute locally. string no shell Only applicable when host is not specified string no cmd cmd must be a valid command or script to execute.\nargs args must be arguments to cmd as they would be on the command-line:\ncmd [arg1 arg2 ...] Define them in an array:\nargs: - arg1 - arg2 - arg3 host Info If any host is not defined or left blank, the command will run on the local machine.\nHost may or may not be defined in the hosts section.\nInfo If any host from the commands section does not match any object in the hosts section, the Host is assumed to be this value. This value will be used to search in the default SSH config files.\nFor example, say that I have a host defined in my SSH config with the Host defined as web-prod. If I assign a value to host as host: web-prod and don’t specify this value in the hosts object, web-prod will be used as the Host in searching the SSH config files.\nshell If shell is defined and host is NOT defined, the command will run in the specified shell. Make sure to escape any shell input.\nenvironment The environment variables support expansion:\nusing escaped values $VAR or ${VAR} For now the variables have to be defined in an .env file in the same directory as the config file.\nIf using it with host specified, the SSH server has to be configured to accept those env variables.\nIf the command is run locally, the OS’s environment is added.\n",
"description": "",
"tags": null,
"title": "Commands",
"uri": "/config/commands/index.html"
},
{
"content": "If you have not installed Backy, see the install documentation.\n",
"content": "If you have not installed Backy, see the install documentation.\nIf you need to configure it, see the config page.\n",
"description": "This page tells you how to get started with Backy.\n",
"tags": null,
"title": "Getting started",
"uri": "/getting-started/index.html"
},
{
"content": "Notifications can be sent on command list completion and failure.\nThe supported platforms for notifications are email (SMTP) and Matrix.\nNotifications are defined by type. The top-level object will be the id, and the type is required.\nInfo Type in a cmd-configs object must match one of these.\nnotifications: 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\nThe type’s object and its keys are listed below.\ntype: mail key description type host Specifies the SMTP host to connect to string port Specifies the SMTP port uint16 senderaddress Address from which to send mail string to Recipients to send emails to []string username SMTP username string password SMTP password string type: matrix key description type home-server Specifies the Matrix server connect to string room-id Specifies the room ID of the room to send messages to string access-token Matrix access token string user-id Matrix user ID string To get your access token (assumes you are using Element) :\nLog in to the account you want to get the access token for. Click on the name in the top left corner, then “Settings”. Click the “Help \u0026 About” tab (left side of the dialog). Scroll to the bottom and click on \u003cclick to reveal\u003e part of Access Token. Copy your access token to a safe place. To get the room ID:\nOn Element or a similar client, navigate to the room. Navigate to the settings from the top menu. Click on Advanced, the room ID is there. Info Make sure to quote the room ID, as YAML spec defines tags using !.\n",
"description": "This page tells you how to get set up Backy notifications.\n",
"tags": null,
"title": "Notifications",
"uri": "/config/notifications/index.html"
},
{
"content": "This is the section on the config file.\nTo use a specific file: backy backup -f /path/to/file\nIf you leave the config path blank, the following paths will be searched in order:\n./backy.yml ./backy.yaml ~/.config/backy.yml ~/.config/backy.yaml Create a file at ~/.config/backy.yml.\nSee the documentation in this section to configure it.\n",
"content": "This is the section on the config file.\nTo use a specific file: backy [command] -f /path/to/file\nIf you leave the config path blank, the following paths will be searched in order:\n./backy.yml ./backy.yaml ~/.config/backy.yml ~/.config/backy.yaml Create a file at ~/.config/backy.yml.\nSee the rest of the documentation in this section to configure it.\n",
"description": "This page tells you how to configure Backy.\n",
"tags": null,
"title": "Configuring Backy",
"uri": "/config/index.html"
},
{
"content": "This page lists documentation for the CLI.\nSubcommands backy backup Backup executes commands defined in config file. Use the --lists flag to execute the specified commands. If not specified, all lists will be executed. Usage: backy backup [--lists=list1,list2] [flags] Flags: -h, --help help for backup -l, --lists strings Accepts comma-separated names of command lists to execute. Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level backy exec Exec executes commands defined in config file. Usage: backy exec command ... [flags] Flags: -h, --help help for exec Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level backy cron Cron starts a scheduler that executes command lists at the time defined in config file. Usage: backy cron [flags] Flags: -h, --help help for cron Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level backy version Prints the version and exits. Usage: backy version [flags] Flags: -h, --help help for version ",
"content": "Notifications can be sent on command list completion and failure.\nThe supported platforms for notifications are email (SMTP) and Matrix.\nNotifications are defined by service, with the current form following below. Ids must come after the service.\nnotifications: mail: prod-email: host: yourhost.tld port: 587 senderaddress: email@domain.tld to: - admin@domain.tld username: smtp-username@domain.tld password: your-password-here matrix: matrix: home-server: your-home-server.tld room-id: room-id access-token: your-access-token user-id: your-user-id Sections recognized are mail and matrix\nThere must be a section with an id (eg. mail.test-svr) following one of these sections.\nmail key description type host Specifies the SMTP host to connect to string port Specifies the SMTP port uint16 senderaddress Address from which to send mail string to Recipients to send emails to []string username SMTP username string password SMTP password string matrix key description type home-server Specifies the Matrix server connect to string room-id Specifies the room ID of the room to send messages to string access-token Matrix access token string user-id Matrix user ID string To get your access token (assumes you are using Element) :\nLog in to the account you want to get the access token for. Click on the name in the top left corner, then “Settings”. Click the “Help \u0026 About” tab (left side of the dialog). Scroll to the bottom and click on \u003cclick to reveal\u003e part of Access Token. Copy your access token to a safe place. To get the room ID:\nOn Element or a similar client, navigate to the room. Navigate to the settings from the top menu. Click on Advanced, the room ID is there. Info Make sure to quote the room ID, as YAML spec defines tags using !.\n",
"description": "This page tells you how to get set up Backy notifications.\n",
"tags": null,
"title": "Notifications",
"uri": "/config/notifications/index.html"
},
{
"content": "This page lists documentation for the CLI.\nBacky Backy is a command-line application useful for configuring backups, or any commands run in sequence. Usage: backy [command] Available Commands: backup Runs commands defined in config file. completion Generate the autocompletion script for the specified shell cron Starts a scheduler that runs lists defined in config file. exec Runs commands defined in config file in order given. help Help about any command list Lists commands, lists, or hosts defined in config file. version Prints the version and exits Flags: -f, --config string config file to read from -h, --help help for backy -v, --verbose Sets verbose level Use \"backy [command] --help\" for more information about a command. Subcommands backup Backup executes commands defined in config file. Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed. Usage: backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags] Flags: -h, --help help for backup -l, --lists strings Accepts comma-separated names of command lists to execute. Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level cron Cron starts a scheduler that executes command lists at the time defined in config file. Usage: backy cron [flags] Flags: -h, --help help for cron Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level exec Exec executes commands defined in config file in order given. Usage: backy exec command ... [flags] Flags: -h, --help help for exec Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level version Prints the version and exits. No arguments just prints the version number only. Usage: backy version [flags] Flags: -h, --help help for version -n, --num Output the version number only. -V, --vpre Output the version with v prefixed. Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level list Backup lists commands or groups defined in config file. Use the --lists or -l flag to list the specified lists. If not flag is not given, all lists will be executed. Usage: backy list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...] [flags] Flags: -c, --cmds strings Accepts comma-separated names of commands to list. -h, --help help for list -l, --lists strings Accepts comma-separated names of command lists to list. Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level ",
"description": "",
"tags": null,
"title": "CLI",
"uri": "/cli/index.html"
},
{
"content": "The repo mirrors are:\nhttps://git.andrewnw.xyz/CyberShell/backy https://git.vern.cc/cybershell/backy https://github.com/CybersShell/backy ",
"content": "Vault is a tool for storing secrets and other data securely.\nVault config can be used by prefixing vault: in front of a password or ENV var.\nThis is the object in the config file:\nvault: token: hvs.tXqcASvTP8wg92f7riyvGyuf address: http://127.0.0.1:8200 enabled: false keys: - name: mongourl mountpath: secret path: mongo/url type: # KVv1 or KVv2 - name: path: type: mountpath: ",
"description": "",
"tags": null,
"title": "Vault",
"uri": "/config/vault/index.html"
},
{
"content": "The repo mirrors are:\nhttps://git.andrewnw.xyz/CyberShell/backy https://github.com/CybersShell/backy ",
"description": "",
"tags": null,
"title": "Repositories",
"uri": "/repositories/index.html"
},
{
"content": "Backy is a tool for automating data backup and remote command execution. It can work over SSH, and provides completion and failure notifications, error reporting, and more.\nWhy the name Backy? Because I wanted an app for backups.\nTip Feel free to open a PR, raise an issue(s), or request new feature(s).\nFeatures Allows easy configuration of executable commands\nAllows for commands to be run on many hosts over SSH\nCommands can be grouped in list to run in specific order\nNotifications on completion and failure\nRun in cron mode\nFor any command, especially backup commands\n",
"content": "Backy is a tool for automating data backup and remote command execution. It can work over SSH, and provides completion and failure notifications, error reporting, and more.\nWhy the name Backy? Because I wanted an app for backups.\nView the changelog here.\nTip Feel free to open a PR, raise an issue(s), or request new feature(s).\nFeatures Allows easy configuration of executable commands\nAllows for commands to be run on many hosts over SSH\nCommands can be grouped in list to run in specific order\nNotifications on completion and failure\nRun in cron mode\nFor any command, especially backup commands\n",
"description": "",
"tags": null,
"title": "Backy",
@ -70,7 +77,7 @@ var relearn_search_index = [
"uri": "/categories/index.html"
},
{
"content": "Commands The commands section is for defining commands. These can be run with or without a shell and on a host or locally.\nSee the commands documentation for further information.\ncommands: stop-docker-container: cmd: docker args: - compose - -f /some/path/to/docker-compose.yaml - down # if host is not defined, cmd will be run locally host: some-host backup-docker-container-script: cmd: /path/to/script # The host has to be defined in the config file host: some-host environment: - FOO=BAR - APP=$VAR # defined in .env file in config directory shell-cmd: cmd: rsync shell: bash args: - -av - some-host:/path/to/data - ~/Docker/Backups/docker-data hostname: cmd: hostname Lists To execute groups of commands in sequence, use a list configuration.\ncmd-configs: cmds-to-run: # this can be any name you want # all commands have to be defined order: - stop-docker-container - backup-docker-container-script - shell-cmd - hostname notifications: - matrix name: backup-some-server hostname: name: hostname order: - hostname notifications: - prod-email Hosts The hosts object may or may not be defined.\nInfo If any host from a commands object does not match any host object, the needed values will be checked in the default SSH config files.\nhosts: # any ssh_config(5) keys/values not listed here will be looked up in the config file or the default config file some-host: hostname: some-hostname config: ~/.ssh/config user: user privatekeypath: /path/to/private/key port: 22 # can also be env:VAR or the password itself password: file:/path/to/file # can also be env:VAR or the password itself privatekeypassword: file:/path/to/file # only one is supported for now proxyjump: some-proxy-host Notifications The notifications object can have two forms.\nFor more, see the notification object documentation. The top-level map key is id that has to be referenced by the cmd-configs key notifications.\nnotifications: prod-email: type: mail host: yourhost.tld port: 587 senderAddress: email@domain.tld recipients: - 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 Logging cmd-std-out controls whether commands output is echoed to StdOut.\nIf logfile is not defined, the log file will be written to the config directory in the file backy.log.\nconsole-disabled controls whether the logging messages are echoed to StdOut. Default is false.\nverbose basically does nothing as all necessary info is already output.\nlogging: verbose: false file: path/to/log/file.log console-disabled: false cmd-std-out: false ",
"content": "Commands The commands section is for defining commands. These can be run with or without a shell and on a host or locally.\nSee the commands documentation for further information.\ncommands: stop-docker-container: output: true # Optional and only when run in list and notifications are sent cmd: docker args: - compose - -f /some/path/to/docker-compose.yaml - down # if host is not defined, cmd will be run locally host: some-host backup-docker-container-script: cmd: /path/to/script # The host has to be defined in the config file host: some-host environment: - FOO=BAR - APP=$VAR # defined in .env file in config directory shell-cmd: cmd: rsync shell: bash args: - -av - some-host:/path/to/data - ~/Docker/Backups/docker-data script: type: scriptFile # run a local script on a remote host cmd: path/to/your/script.sh host: some-host hostname: cmd: hostname Lists To execute groups of commands in sequence, use a list configuration.\ncmd-lists: cmds-to-run: # this can be any name you want # all commands have to be defined in the commands section order: - stop-docker-container - backup-docker-container-script - shell-cmd - hostname getOutput: true # Optional and only for when notifications are sent notifications: - matrix name: backup-some-server hostname: name: hostname order: - hostname notifications: - prod-email Hosts The hosts object may or may not be defined.\nInfo If any host from a commands object does not match any host object, the needed values will be checked in the default SSH config files.\nhosts: # any needed ssh_config(5) keys/values not listed here will be looked up in the config file or the default config file some-host: hostname: some-hostname config: ~/.ssh/config user: user privatekeypath: /path/to/private/key port: 22 # can also be env:VAR or the password itself password: file:/path/to/file # can also be env:VAR or the password itself privatekeypassword: file:/path/to/file # only one is supported for now proxyjump: some-proxy-host Notifications The notifications object can have two forms.\nFor more, see the notification object documentation. The top-level map key is id that has to be referenced by the cmd-lists key notifications.\nnotifications: prod-email: type: mail host: yourhost.tld port: 587 senderAddress: email@domain.tld recipients: - 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 Logging cmd-std-out controls whether commands output is echoed to StdOut.\nIf logfile is not defined, the log file will be written to the config directory in the file backy.log.\nconsole-disabled controls whether the logging messages are echoed to StdOut. Default is false.\nverbose basically does nothing as all necessary info is already output.\nlogging: verbose: false file: path/to/log/file.log console-disabled: false cmd-std-out: false Vault Vault can be used to get some configuration values and ENV variables securely.\nvault: token: hvs.tXqcASvTP8wg92f7riyvGyuf address: http://127.0.0.1:8200 enabled: false keys: - name: mongourl mountpath: secret path: mongo/url type: # KVv1 or KVv2 - name: path: type: mountpath: ",
"description": "This page tells you how to configure Backy.\n",
"tags": null,
"title": "Config File Definitions",

120
docs/public/index.xml
View File

@ -11,34 +11,134 @@
<link>http://example.org/getting-started/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/getting-started/index.html</guid>
<description>If you have not installed Backy, see the install documentation.</description>
<description>&lt;p&gt;If you have not installed Backy, &lt;a href=&#34;install&#34;&gt;see the install documentation&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;If you need to configure it, &lt;a href=&#34;config&#34;&gt;see the config page&lt;/a&gt;.&lt;/p&gt;</description>
</item>
<item>
<title>Configuring Backy</title>
<link>http://example.org/config/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/config/index.html</guid>
<description>This is the section on the config file.
To use a specific file: backy backup -f /path/to/file
If you leave the config path blank, the following paths will be searched in order:
./backy.yml ./backy.yaml ~/.config/backy.yml ~/.config/backy.yaml Create a file at ~/.config/backy.yml.
See the documentation in this section to configure it.</description>
<description>&lt;p&gt;This is the section on the config file.&lt;/p&gt;
&lt;p&gt;To use a specific file:
&lt;code&gt;backy [command] -f /path/to/file&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;If you leave the config path blank, the following paths will be searched in order:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;&lt;code&gt;./backy.yml&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;./backy.yaml&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;~/.config/backy.yml&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;~/.config/backy.yaml&lt;/code&gt;&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;Create a file at &lt;code&gt;~/.config/backy.yml&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;See the rest of the documentation in this section to configure it.&lt;/p&gt;</description>
</item>
<item>
<title>CLI</title>
<link>http://example.org/cli/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/cli/index.html</guid>
<description>This page lists documentation for the CLI.
Subcommands backy backup Backup executes commands defined in config file. Use the --lists flag to execute the specified commands. If not specified, all lists will be executed. Usage: backy backup [--lists=list1,list2] [flags] Flags: -h, --help help for backup -l, --lists strings Accepts comma-separated names of command lists to execute. Global Flags: -f, --config string config file to read from -v, --verbose Sets verbose level backy exec Exec executes commands defined in config file.</description>
<description>&lt;p&gt;This page lists documentation for the CLI.&lt;/p&gt;
&lt;h2 id=&#34;backy&#34;&gt;Backy&lt;/h2&gt;
&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;Backy is a command-line application useful for configuring backups, or any commands run in sequence.
Usage:
backy [command]
Available Commands:
backup Runs commands defined in config file.
completion Generate the autocompletion script for the specified shell
cron Starts a scheduler that runs lists defined in config file.
exec Runs commands defined in config file in order given.
help Help about any command
list Lists commands, lists, or hosts defined in config file.
version Prints the version and exits
Flags:
-f, --config string config file to read from
-h, --help help for backy
-v, --verbose Sets verbose level
Use &amp;#34;backy [command] --help&amp;#34; for more information about a command.
&lt;/code&gt;&lt;/pre&gt;&lt;h1 id=&#34;subcommands&#34;&gt;Subcommands&lt;/h1&gt;
&lt;h2 id=&#34;backup&#34;&gt;backup&lt;/h2&gt;
&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;Backup executes commands defined in config file.
Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.
Usage:
backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags]
Flags:
-h, --help help for backup
-l, --lists strings Accepts comma-separated names of command lists to execute.
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
&lt;/code&gt;&lt;/pre&gt;&lt;h2 id=&#34;cron&#34;&gt;cron&lt;/h2&gt;
&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;Cron starts a scheduler that executes command lists at the time defined in config file.
Usage:
backy cron [flags]
Flags:
-h, --help help for cron
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
&lt;/code&gt;&lt;/pre&gt;&lt;h2 id=&#34;exec&#34;&gt;exec&lt;/h2&gt;
&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;Exec executes commands defined in config file in order given.
Usage:
backy exec command ... [flags]
Flags:
-h, --help help for exec
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
&lt;/code&gt;&lt;/pre&gt;&lt;h2 id=&#34;version&#34;&gt;version&lt;/h2&gt;
&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;Prints the version and exits. No arguments just prints the version number only.
Usage:
backy version [flags]
Flags:
-h, --help help for version
-n, --num Output the version number only.
-V, --vpre Output the version with v prefixed.
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
&lt;/code&gt;&lt;/pre&gt;&lt;h2 id=&#34;list&#34;&gt;list&lt;/h2&gt;
&lt;pre tabindex=&#34;0&#34;&gt;&lt;code&gt;Backup lists commands or groups defined in config file.
Use the --lists or -l flag to list the specified lists. If not flag is not given, all lists will be executed.
Usage:
backy list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...] [flags]
Flags:
-c, --cmds strings Accepts comma-separated names of commands to list.
-h, --help help for list
-l, --lists strings Accepts comma-separated names of command lists to list.
Global Flags:
-f, --config string config file to read from
-v, --verbose Sets verbose level
&lt;/code&gt;&lt;/pre&gt;</description>
</item>
<item>
<title>Repositories</title>
<link>http://example.org/repositories/index.html</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://example.org/repositories/index.html</guid>
<description>The repo mirrors are:
https://git.andrewnw.xyz/CyberShell/backy https://git.vern.cc/cybershell/backy https://github.com/CybersShell/backy </description>
<description>&lt;p&gt;The repo mirrors are:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;https://git.andrewnw.xyz/CyberShell/backy&#34; target=&#34;_blank&#34;&gt;https://git.andrewnw.xyz/CyberShell/backy&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/CybersShell/backy&#34; target=&#34;_blank&#34;&gt;https://github.com/CybersShell/backy&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;</description>
</item>
</channel>
</rss>

1534
docs/public/js/mermaid.min.js vendored
View File

File diff suppressed because one or more lines are too long

4
docs/public/js/perfect-scrollbar.min.js vendored
View File

File diff suppressed because one or more lines are too long

81
docs/public/js/search.js
View File

@ -2,7 +2,12 @@ window.relearn = window.relearn || {};
window.relearn.runInitialSearch = function(){
if( window.relearn.isSearchInit && window.relearn.isLunrInit ){
searchDetail();
var input = document.querySelector('#search-by-detail');
if( !input ){
return;
}
var value = input.value;
searchDetail( value );
}
}
@ -40,24 +45,55 @@ function initLunrIndex( index ){
}
function triggerSearch(){
searchDetail();
var input = document.querySelector('#search-by-detail');
if( !input ){
return;
}
var value = input.value;
searchDetail( value );
// add a new entry to the history after the user
// changed the term; this does not reload the page
// but will add to the history and update the address bar URL
var url = new URL( window.location );
var oldValue = url.searchParams.get('search-by');
var oldValue = url.searchParams.get( 'search-by' );
if( value != oldValue ){
url.searchParams.set('search-by', value);
window.history.pushState(url.toString(), '', url);
var state = window.history.state || {};
state = Object.assign( {}, ( typeof state === 'object' ) ? state : {} );
url.searchParams.set( 'search-by', value );
state.search = url.toString();
// with normal pages, this is handled by the 'pagehide' event, but this
// doesn't fire in case of pushState, so we have to do the same thing
// here, too
state.contentScrollTop = +elc.scrollTop;
window.history.pushState( state, '', url );
}
}
window.addEventListener('popstate', function ( event ) {
window.addEventListener( 'popstate', function ( event ){
// restart search if browsed thru history
if (event.state && event.state.indexOf('search.html?search-by=') >= 0) {
window.location.reload();
if( event.state ){
var state = window.history.state || {};
state = Object.assign( {}, ( typeof state === 'object' ) ? state : {} );
if( state.search ) {
var url = new URL( state.search );
if( url.searchParams.has('search-by') ){
var search = url.searchParams.get( 'search-by' );
// we have to insert the old search term into the inputs
var inputs = document.querySelectorAll( 'input.search-by' );
inputs.forEach( function( e ){
e.value = search;
var event = document.createEvent( 'Event' );
event.initEvent( 'input', false, false );
e.dispatchEvent( event );
});
// recreate the last search results and eventually
// restore the previous scrolling position
searchDetail( search );
}
}
}
});
@ -161,12 +197,7 @@ function resolvePlaceholders( s, args ) {
});
};
function searchDetail() {
var input = document.querySelector('#search-by-detail');
if( !input ){
return;
}
var value = input.value;
function searchDetail( value ) {
var results = document.querySelector('#searchresults');
var hint = document.querySelector('.searchhint');
hint.innerText = '';
@ -201,14 +232,32 @@ function searchDetail() {
}
input.focus();
setTimeout( adjustContentWidth, 0 );
// if we are initiating search because of a browser history
// operation, we have to restore the scrolling postion the
// user previously has used; if this search isn't initiated
// by a browser history operation, it simply does nothing
var state = window.history.state || {};
state = Object.assign( {}, ( typeof state === 'object' ) ? state : {} );
if( state.hasOwnProperty( 'contentScrollTop' ) ){
window.setTimeout( function(){
elc.scrollTop = +state.contentScrollTop;
}, 10 );
return;
}
}
initLunrJson();
initLunrJs();
function startSearch(){
var url = new URL( window.location );
window.history.replaceState(url.toString(), '', url);
var input = document.querySelector('#search-by-detail');
if( input ){
var state = window.history.state || {};
state = Object.assign( {}, ( typeof state === 'object' ) ? state : {} );
state.search = window.location.toString();
window.history.replaceState( state, '', window.location );
}
var searchList = new autoComplete({
/* selector for the search box element */

418
docs/public/js/theme.js
View File

@ -9,16 +9,27 @@ if( isIE ){
else{
document.querySelector( 'body' ).classList.add( 'mobile-support' );
}
var isPrint = document.querySelector( 'body' ).classList.contains( 'print' );
var isRtl = document.querySelector( 'html' ).getAttribute( 'dir' ) == 'rtl';
var dir_padding_start = 'padding-left';
var dir_padding_end = 'padding-right';
var dir_key_start = 37;
var dir_key_end = 39;
var dir_scroll = 1;
if( isRtl && !isIE ){
dir_padding_start = 'padding-right';
dir_padding_end = 'padding-left';
dir_key_start = 39;
dir_key_end = 37;
dir_scroll = -1;
}
var touchsupport = ('ontouchstart' in window) || (navigator.maxTouchPoints > 0) || (navigator.msMaxTouchPoints > 0)
var formelements = 'button, datalist, fieldset, input, label, legend, meter, optgroup, option, output, progress, select, textarea';
// rapidoc: #280 disable broad document syntax highlightning
window.Prism = window.Prism || {};
Prism.manual = true;
// PerfectScrollbar
var psc;
var psm;
@ -26,7 +37,7 @@ var pst;
var elc = document.querySelector('#body-inner');
function documentFocus(){
document.querySelector( '#body-inner' ).focus();
elc.focus();
psc && psc.scrollbarY.focus();
}
@ -45,13 +56,34 @@ function scrollbarWidth(){
var scrollbarSize = scrollbarWidth();
function adjustContentWidth(){
var left = parseFloat( getComputedStyle( elc ).getPropertyValue( 'padding-left' ) );
var right = left;
var start = parseFloat( getComputedStyle( elc ).getPropertyValue( dir_padding_start ) );
var end = start;
if( elc.scrollHeight > elc.clientHeight ){
// if we have a scrollbar reduce the right margin by the scrollbar width
right = Math.max( 0, left - scrollbarSize );
// if we have a scrollbar reduce the end margin by the scrollbar width
end = Math.max( 0, start - scrollbarSize );
}
elc.style[ 'padding-right' ] = '' + right + 'px';
elc.style[ dir_padding_end ] = '' + end + 'px';
}
function fixCodeTabs(){
/* if only a single code block is contained in the tab and no style was selected, treat it like style=code */
var codeTabContents = Array.from( document.querySelectorAll( '.tab-content.tab-panel-style' ) ).filter( function( tabContent ){
return tabContent.querySelector( '*:scope > .tab-content-text > div.highlight:only-child, *:scope > .tab-content-text > pre.pre-code:only-child');
});
codeTabContents.forEach( function( tabContent ){
var tabId = tabContent.dataset.tabItem;
var tabPanel = tabContent.parentNode.parentNode;
var tabButton = tabPanel.querySelector( '.tab-nav-button.tab-panel-style[data-tab-item="'+tabId+'"]' );
if( tabContent.classList.contains( 'initial' ) ){
tabButton.classList.remove( 'initial' );
tabButton.classList.add( 'code' );
tabContent.classList.remove( 'initial' );
tabContent.classList.add( 'code' );
}
// mark code blocks for FF without :has()
tabContent.classList.add( 'codify' );
});
}
function switchTab(tabGroup, tabId) {
@ -126,21 +158,27 @@ function initMermaid( update, attrs ) {
};
var parseGraph = function( graph ){
var d = /^\s*(%%\s*\{\s*\w+\s*:([^%]*?)%%\s*\n?)/g;
// See https://github.com/mermaid-js/mermaid/blob/9a080bb975b03b2b1d4ef6b7927d09e6b6b62760/packages/mermaid/src/diagram-api/frontmatter.ts#L10
// for reference on the regex originally taken from jekyll
var YAML=1;
var INIT=2;
var GRAPH=3;
var d = /^(?:\s*[\n\r])*(-{3}\s*[\n\r](?:.*?)[\n\r]-{3}(?:\s*[\n\r]+)+)?(?:\s*(?:%%\s*\{\s*\w+\s*:([^%]*?)%%\s*[\n\r]?))?(.*)$/s
var m = d.exec( graph );
var yaml = '';
var dir = {};
var content = graph;
if( m && m.length == 3 ){
dir = JSON.parse( '{ "dummy": ' + m[2] ).dummy;
content = graph.substring( d.lastIndex );
if( m && m.length == 4 ){
yaml = m[YAML] ? m[YAML] : yaml;
dir = m[INIT] ? JSON.parse( '{ "init": ' + m[INIT] ).init : dir;
content = m[GRAPH] ? m[GRAPH] : content;
}
content = content.trim();
return { dir: dir, content: content };
var ret = { yaml: yaml, dir: dir, content: content.trim() }
return ret;
};
var serializeGraph = function( graph ){
var s = '%%{init: ' + JSON.stringify( graph.dir ) + '}%%\n';
s += graph.content;
var s = graph.yaml + '%%{init: ' + JSON.stringify( graph.dir ) + '}%%\n' + graph.content;
return s;
};
@ -247,7 +285,11 @@ function initMermaid( update, attrs ) {
}
}
function initSwagger( update, attrs ){
function initOpenapi( update, attrs ){
if( isIE ){
return;
}
var state = this;
if( update && !state.is_initialized ){
return;
@ -259,39 +301,162 @@ function initSwagger( update, attrs ){
if( !state.is_initialized ){
state.is_initialized = true;
window.addEventListener( 'beforeprint', function(){
initSwagger( true, {
'bg-color': variants.getColorValue( 'PRINT-MAIN-BG-color' ),
'mono-font': variants.getColorValue( 'PRINT-CODE-font' ),
'primary-color': variants.getColorValue( 'PRINT-TAG-BG-color' ),
'regular-font': variants.getColorValue( 'PRINT-MAIN-font' ),
'text-color': variants.getColorValue( 'PRINT-MAIN-TEXT-color' ),
'theme': variants.getColorValue( 'PRINT-SWAGGER-theme' ),
});
initOpenapi( true, { isPrintPreview: true } );
}.bind( this ) );
window.addEventListener( 'afterprint', function(){
initSwagger( true );
initOpenapi( true, { isPrintPreview: false } );
}.bind( this ) );
}
attrs = attrs || {
'bg-color': variants.getColorValue( 'MAIN-BG-color' ),
'mono-font': variants.getColorValue( 'CODE-font' ),
'primary-color': variants.getColorValue( 'TAG-BG-color' ),
'regular-font': variants.getColorValue( 'MAIN-font' ),
'text-color': variants.getColorValue( 'MAIN-TEXT-color' ),
'theme': variants.getColorValue( 'SWAGGER-theme' ),
isPrintPreview: false
};
document.querySelectorAll( 'rapi-doc' ).forEach( function( e ){
Object.keys( attrs ).forEach( function( key ){
/* this doesn't work for FF 102, maybe related to custom elements? */
e.setAttribute( key, attrs[key] );
function addFunctionToResizeEvent(){
}
function getFirstAncestorByClass(){
}
function renderOpenAPI(oc) {
var buster = window.themeUseOpenapi.assetsBuster ? '?' + window.themeUseOpenapi.assetsBuster : '';
var print = isPrint || attrs.isPrintPreview ? "PRINT-" : "";
var theme = print ? `${baseUri}/css/theme-relearn-light.css` : document.querySelector( '#variant-style' ).attributes.href.value
var swagger_theme = variants.getColorValue( print + 'OPENAPI-theme' );
var swagger_code_theme = variants.getColorValue( print + 'OPENAPI-CODE-theme' );
const openapiId = 'relearn-swagger-ui';
const openapiIframeId = openapiId + "-iframe";
const openapiIframe = document.getElementById(openapiIframeId);
if (openapiIframe) {
openapiIframe.remove();
}
const openapiErrorId = openapiId + '-error';
const openapiError = document.getElementById(openapiErrorId);
if (openapiError) {
openapiError.remove();
}
const oi = document.createElement('iframe');
oi.id = openapiIframeId;
oi.classList.toggle('sc-openapi-iframe', true);
oi.srcdoc =
'<!doctype html>' +
'<html lang="en">' +
'<head>' +
'<link rel="stylesheet" href="' + window.themeUseOpenapi.css + '">' +
'<link rel="stylesheet" href="' + theme + '">' +
'<link rel="stylesheet" href="' + baseUri + '/css/swagger.css' + buster + '">' +
'<link rel="stylesheet" href="' + baseUri + '/css/swagger-' + swagger_theme + '.css' + buster + '">' +
'</head>' +
'<body>' +
'<a class="relearn-expander" href="" onclick="return relearn_collapse_all()">Collapse all</a>' +
'<a class="relearn-expander" href="" onclick="return relearn_expand_all()">Exapnd all</a>' +
'<div id="relearn-swagger-ui"></div>' +
'<script>' +
'function relearn_expand_all(){' +
'document.querySelectorAll( ".opblock-summary-control[aria-expanded=false]" ).forEach( btn => btn.click() );' +
'document.querySelectorAll( ".model-container > .model-box > button[aria-expanded=false]" ).forEach( btn => btn.click() );' +
'return false;' +
'}' +
'function relearn_collapse_all(){' +
'document.querySelectorAll( ".opblock-summary-control[aria-expanded=true]" ).forEach( btn => btn.click() );' +
'document.querySelectorAll( ".model-container > .model-box > .model-box > .model > span > button[aria-expanded=true]" ).forEach( btn => btn.click() );' +
'return false;' +
'}' +
'</script>' +
'</body>' +
'</html>';
oi.height = '100%';
oi.width = '100%';
oi.onload = function(){
const openapiWrapper = getFirstAncestorByClass(oc, 'sc-openapi-wrapper');
const openapiPromise = new Promise( function(resolve){ resolve() });
openapiPromise
.then( function(){
SwaggerUIBundle({
defaultModelsExpandDepth: 2,
defaultModelExpandDepth: 2,
docExpansion: isPrint || attrs.isPrintPreview ? 'full' : 'list',
domNode: oi.contentWindow.document.getElementById(openapiId),
filter: !( isPrint || attrs.isPrintPreview ),
layout: 'BaseLayout',
onComplete: function(){
if( isPrint || attrs.isPrintPreview ){
oi.contentWindow.document.querySelectorAll( '.model-container > .model-box > button[aria-expanded=false]' ).forEach( function(btn){ btn.click() });
setOpenAPIHeight(oi);
}
},
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset,
],
syntaxHighlight: {
activated: true,
theme: swagger_code_theme,
},
url: oc.getAttribute('openapi-url'),
validatorUrl: 'none',
});
})
.then( function(){
let observerCallback = function () {
setOpenAPIHeight(oi);
};
let observer = new MutationObserver(observerCallback);
observer.observe(oi.contentWindow.document.documentElement, {
childList: true,
subtree: true,
});
})
.then( function(){
if (openapiWrapper) {
openapiWrapper.classList.toggle('is-loading', false);
}
setOpenAPIHeight(oi);
})
.catch( function(error){
const ed = document.createElement('div');
ed.classList.add('sc-alert', 'sc-alert-error');
ed.innerHTML = error;
ed.id = openapiErrorId;
while (oc.lastChild) {
oc.removeChild(oc.lastChild);
}
if (openapiWrapper) {
openapiWrapper.classList.toggle('is-loading', false);
openapiWrapper.insertAdjacentElement('afterbegin', ed);
}
});
};
oc.appendChild(oi);
}
function setOpenAPIHeight(oi) {
// add empirical offset if in print preview (GC 103)
oi.style.height =
(oi.contentWindow.document.documentElement.getBoundingClientRect().height + (attrs.isPrintPreview ? 200 : 0) )+
'px';
}
function resizeOpenAPI() {
let divi = document.getElementsByClassName('sc-openapi-iframe');
for (let i = 0; i < divi.length; i++) {
setOpenAPIHeight(divi[i]);
}
};
let divo = document.getElementsByClassName('sc-openapi-container');
for (let i = 0; i < divo.length; i++) {
renderOpenAPI(divo[i]);
}
if (divo.length) {
addFunctionToResizeEvent(resizeOpenAPI);
}
}
function initAnchorClipboard(){
document.querySelectorAll( 'h1~h2,h1~h3,h1~h4,h1~h5,h1~h6').forEach( function( element ){
var url = encodeURI(document.location.origin + document.location.pathname);
var url = encodeURI( (document.location.origin == "null" ? (document.location.protocol + "//" + document.location.host) : document.location.origin )+ document.location.pathname);
var link = url + "#" + element.id;
var new_element = document.createElement( 'span' );
new_element.classList.add( 'anchor' );
@ -312,9 +477,8 @@ function initAnchorClipboard(){
var clip = new ClipboardJS( '.anchor' );
clip.on( 'success', function( e ){
e.clearSelection();
var rtl = e.trigger.closest( '*[dir]' ).getAttribute( 'dir' ) == 'rtl';
e.trigger.setAttribute( 'aria-label', window.T_Link_copied_to_clipboard );
e.trigger.classList.add( 'tooltipped', 'tooltipped-s'+(rtl?'e':'w') );
e.trigger.classList.add( 'tooltipped', 'tooltipped-s'+(isRtl?'e':'w') );
});
}
@ -356,19 +520,17 @@ function initCodeClipboard(){
clip.on( 'success', function( e ){
e.clearSelection();
var inPre = e.trigger.parentNode.tagName.toLowerCase() == 'pre';
var rtl = e.trigger.closest( '*[dir]' ).getAttribute( 'dir' ) == 'rtl';
e.trigger.setAttribute( 'aria-label', window.T_Copied_to_clipboard );
e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (inPre ? 'w' : 's'+(rtl?'e':'w')) );
e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (inPre ? 'w' : 's'+(isRtl?'e':'w')) );
});
clip.on( 'error', function( e ){
var inPre = e.trigger.parentNode.tagName.toLowerCase() == 'pre';
var rtl = e.trigger.closest( '*[dir]' ).getAttribute( 'dir' ) == 'rtl';
e.trigger.setAttribute( 'aria-label', fallbackMessage(e.action) );
e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (inPre ? 'w' : 's'+(rtl?'e':'w')) );
e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (inPre ? 'w' : 's'+(isRtl?'e':'w')) );
var f = function(){
e.trigger.setAttribute( 'aria-label', window.T_Copied_to_clipboard );
e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (inPre ? 'w' : 's'+(rtl?'e':'w')) );
e.trigger.classList.add( 'tooltipped', 'tooltipped-' + (inPre ? 'w' : 's'+(isRtl?'e':'w')) );
document.removeEventListener( 'copy', f );
};
document.addEventListener( 'copy', f );
@ -377,7 +539,7 @@ function initCodeClipboard(){
code.classList.add( 'copy-to-clipboard-code' );
if( inPre ){
code.classList.add( 'copy-to-clipboard' );
code.classList.add( 'pre-code' );
code.parentNode.classList.add( 'pre-code' );
}
else{
var clone = code.cloneNode( true );
@ -392,7 +554,6 @@ function initCodeClipboard(){
button.setAttribute( 'title', window.T_Copy_to_clipboard );
button.innerHTML = '<i class="fas fa-copy"></i>';
button.addEventListener( 'mouseleave', function() {
var rtl = this.closest( '*[dir]' ).getAttribute( 'dir' ) == 'rtl';
this.removeAttribute( 'aria-label' );
this.classList.remove( 'tooltipped', 'tooltipped-w', 'tooltipped-se', 'tooltipped-sw' );
});
@ -416,41 +577,41 @@ function initArrowNav(){
// avoid prev/next navigation if we are not at the start/end of the
// horizontal area
var el = document.querySelector('#body-inner');
var scrollLeft = 0;
var scrollRight = 0;
var scrollStart = 0;
var scrollEnd = 0;
document.addEventListener('keydown', function(event){
if( !event.shiftKey && !event.ctrlKey && !event.altKey && !event.metaKey ){
if( event.which == '37' ){
if( !scrollLeft && +el.scrollLeft.toFixed() <= 0 ){
if( event.which == dir_key_start ){
if( !scrollStart && +el.scrollLeft.toFixed()*dir_scroll <= 0 ){
prev && prev.click();
}
else if( scrollLeft != -1 ){
clearTimeout( scrollLeft );
else if( scrollStart != -1 ){
clearTimeout( scrollStart );
}
scrollLeft = -1;
scrollStart = -1;
}
if( event.which == '39' ){
if( !scrollRight && +el.scrollLeft.toFixed() + +el.clientWidth.toFixed() >= +el.scrollWidth.toFixed() ){
if( event.which == dir_key_end ){
if( !scrollEnd && +el.scrollLeft.toFixed()*dir_scroll + +el.clientWidth.toFixed() >= +el.scrollWidth.toFixed() ){
next && next.click();
}
else if( scrollRight != -1 ){
clearTimeout( scrollRight );
else if( scrollEnd != -1 ){
clearTimeout( scrollEnd );
}
scrollRight = -1;
scrollEnd = -1;
}
}
});
document.addEventListener('keyup', function(event){
if( !event.shiftKey && !event.ctrlKey && !event.altKey && !event.metaKey ){
if( event.which == '37' ){
if( event.which == dir_key_start ){
// check for false indication if keyup is delayed after navigation
if( scrollLeft == -1 ){
scrollLeft = setTimeout( function(){ scrollLeft = 0; }, 300 );
if( scrollStart == -1 ){
scrollStart = setTimeout( function(){ scrollStart = 0; }, 300 );
}
}
if( event.which == '39' ){
if( scrollRight == -1 ){
scrollRight = setTimeout( function(){ scrollRight = 0; }, 300 );
if( event.which == dir_key_end ){
if( scrollEnd == -1 ){
scrollEnd = setTimeout( function(){ scrollEnd = 0; }, 300 );
}
}
}
@ -459,7 +620,7 @@ function initArrowNav(){
// avoid keyboard navigation for input fields
document.querySelectorAll( formelements ).forEach( function( e ){
e.addEventListener( 'keydown', function( event ){
if( event.which == 37 || event.which == 39 ){
if( event.which == dir_key_start || event.which == dir_key_end ){
event.stopPropagation();
}
});
@ -534,19 +695,24 @@ function initMenuScrollbar(){
// on resize, we have to redraw the scrollbars to let new height
// affect their size
window.addEventListener('resize', function(){
pst && pst.update();
psm && psm.update();
psc && psc.update();
pst && setTimeout( function(){ pst.update(); }, 10 );
psm && setTimeout( function(){ psm.update(); }, 10 );
psc && setTimeout( function(){ psc.update(); }, 10 );
});
// now that we may have collapsible menus, we need to call a resize
// for the menu scrollbar if sections are expanded/collapsed
document.querySelectorAll('#sidebar .collapsible-menu input.toggle').forEach( function(e){
document.querySelectorAll('#sidebar .collapsible-menu input').forEach( function(e){
e.addEventListener('change', function(){
psm && psm.update();
psm && setTimeout( function(){ psm.update(); }, 10 );
});
});
// bugfix for PS in RTL mode: the initial scrollbar position is off;
// calling update() once, fixes this
pst && setTimeout( function(){ pst.update(); }, 10 );
psm && setTimeout( function(){ psm.update(); }, 10 );
psc && setTimeout( function(){ psc.update(); }, 10 );
// finally, we want to adjust the contents right padding if there is a scrollbar visible
// finally, we want to adjust the contents end padding if there is a scrollbar visible
window.addEventListener('resize', adjustContentWidth );
adjustContentWidth();
}
@ -652,7 +818,7 @@ function showToc(){
var b = document.querySelector( 'body' );
b.classList.toggle( 'toc-flyout' );
if( b.classList.contains( 'toc-flyout' ) ){
pst && pst.update();
pst && setTimeout( function(){ pst.update(); }, 10 );
pst && pst.scrollbarY.focus();
document.querySelector( '.toc-wrapper ul a' ).focus();
document.addEventListener( 'keydown', tocEscapeHandler );
@ -800,22 +966,60 @@ function initHistory() {
}
}
function scrollToActiveMenu() {
window.setTimeout(function(){
var e = document.querySelector( '#sidebar ul.topics li.active a' );
function initScrollPositionSaver(){
function savePosition( event ){
var state = window.history.state || {};
state = Object.assign( {}, ( typeof state === 'object' ) ? state : {} );
state.contentScrollTop = +elc.scrollTop;
window.history.replaceState( state, '', window.location );
};
window.addEventListener( 'pagehide', savePosition );
}
function scrollToPositions() {
// show active menu entry
window.setTimeout( function(){
var e = document.querySelector( '#sidebar li.active a' );
if( e && e.scrollIntoView ){
e.scrollIntoView({
block: 'center',
});
}
}, 10);
}
}, 10 );
function scrollToFragment() {
if( !window.location.hash || window.location.hash.length <= 1 ){
// scroll the content to point of interest;
// if we have a scroll position saved, the user was here
// before in his history stack and we want to reposition
// to the position he was when he left the page;
// otherwise if he used page search before, we want to position
// to its last outcome;
// otherwise he may want to see a specific fragment
var state = window.history.state || {};
state = ( typeof state === 'object') ? state : {};
if( state.hasOwnProperty( 'contentScrollTop' ) ){
window.setTimeout( function(){
elc.scrollTop = +state.contentScrollTop;
}, 10 );
return;
}
window.setTimeout(function(){
var search = sessionStorage.getItem( baseUriFull+'search-value' );
if( search && search.length ){
var found = elementContains( search, elc );
var searchedElem = found.length && found[ 0 ];
if( searchedElem ){
searchedElem.scrollIntoView( true );
var scrolledY = window.scrollY;
if( scrolledY ){
window.scroll( 0, scrolledY - 125 );
}
}
return;
}
if( window.location.hash && window.location.hash.length > 1 ){
window.setTimeout( function(){
try{
var e = document.querySelector( window.location.hash );
if( e && e.scrollIntoView ){
@ -824,7 +1028,9 @@ function scrollToFragment() {
});
}
} catch( e ){}
}, 10);
}, 10 );
return;
}
}
function mark() {
@ -855,8 +1061,8 @@ function mark() {
expandInputs[0].checked = true;
}
}
if( parent.tagName.toLowerCase() === 'li' ){
var toggleInputs = parent.querySelectorAll( 'input.toggle:not(.menu-marked)' );
if( parent.tagName.toLowerCase() === 'li' && parent.parentNode && parent.parentNode.tagName.toLowerCase() === 'ul' && parent.parentNode.classList.contains( 'collapsible-menu' )){
var toggleInputs = parent.querySelectorAll( 'input:not(.menu-marked)' );
if( toggleInputs.length ){
toggleInputs[0].classList.add( 'menu-marked' );
toggleInputs[0].dataset.checked = toggleInputs[0].checked ? 'true' : 'false';
@ -866,7 +1072,7 @@ function mark() {
parent = parent.parentNode;
}
}
psm && psm.update();
psm && setTimeout( function(){ psm.update(); }, 10 );
}
window.relearn.markSearch = mark;
@ -932,8 +1138,8 @@ function unmark() {
for( var i = 0; i < markedElements.length; i++ ){
var parent = markedElements[i].parentNode;
while( parent && parent.classList ){
if( parent.tagName.toLowerCase() === 'li' ){
var toggleInputs = parent.querySelectorAll( 'input.toggle.menu-marked' );
if( parent.tagName.toLowerCase() === 'li' && parent.parentNode && parent.parentNode.tagName.toLowerCase() === 'ul' && parent.parentNode.classList.contains( 'collapsible-menu' )){
var toggleInputs = parent.querySelectorAll( 'input.menu-marked' );
if( toggleInputs.length ){
toggleInputs[0].checked = toggleInputs[0].dataset.checked === 'true';
toggleInputs[0].dataset.checked = null;
@ -954,7 +1160,7 @@ function unmark() {
var highlighted = document.querySelectorAll( '.highlightable' );
unhighlight( highlighted, { element: 'mark' } );
psm && psm.update();
psm && setTimeout( function(){ psm.update(); }, 10 );
}
function unhighlight( es, options ){
@ -1049,25 +1255,15 @@ function initSearch() {
}
mark();
// set initial search value on page load
// set initial search value for inputs on page load
if( sessionStorage.getItem( baseUriFull+'search-value' ) ){
var searchValue = sessionStorage.getItem( baseUriFull+'search-value' );
var search = sessionStorage.getItem( baseUriFull+'search-value' );
inputs.forEach( function( e ){
e.value = searchValue;
e.value = search;
var event = document.createEvent( 'Event' );
event.initEvent( 'input', false, false );
e.dispatchEvent( event );
});
var found = elementContains( searchValue, document.querySelector( '#body-inner' ) );
var searchedElem = found.length && found[ 0 ];
if( searchedElem ){
searchedElem.scrollIntoView( true );
var scrolledY = window.scrollY;
if( scrolledY ){
window.scroll( 0, scrolledY - 125 );
}
}
}
window.relearn.isSearchInit = true;
@ -1077,18 +1273,19 @@ function initSearch() {
ready( function(){
initArrowNav();
initMermaid();
initSwagger();
initOpenapi();
initMenuScrollbar();
scrollToActiveMenu();
scrollToFragment();
initToc();
initAnchorClipboard();
initCodeClipboard();
fixCodeTabs();
restoreTabSelections();
initSwipeHandler();
initHistory();
initSearch();
initImage();
initScrollPositionSaver();
scrollToPositions();
});
function useMermaid( config ){
@ -1108,12 +1305,11 @@ if( window.themeUseMermaid ){
useMermaid( window.themeUseMermaid );
}
function useSwagger( config ){
if( config.theme && variants ){
var write_style = variants.findLoadedStylesheet( 'variant-style' );
write_style.setProperty( '--CONFIG-SWAGGER-theme', config.theme );
function useOpenapi( config ){
if( config.css && config.css.startsWith( '/' ) ){
config.css = baseUri + config.css;
}
}
if( window.themeUseSwagger ){
useSwagger( window.themeUseSwagger );
if( window.themeUseOpenapi ){
useOpenapi( window.themeUseOpenapi );
}

6
docs/public/js/variant.js
View File

@ -76,7 +76,7 @@ var variants = {
if( this.isVariantLoaded() ){
clearInterval( interval_id );
initMermaid( true );
initSwagger( true );
initOpenapi( true );
}
}.bind( this ), 25 );
// remove selection, because if some uses an arrow navigation"
@ -575,8 +575,10 @@ var variants = {
{ name: 'CODE-font', group: 'code', default: '"Consolas", menlo, monospace', tooltip: 'text font of code', },
{ name: 'BROWSER-theme', group: '3rd party', default: 'light', tooltip: 'name of the theme for browser scrollbars of the main section', },
{ name: 'MERMAID-theme', group: '3rd party', default: 'default', tooltip: 'name of the default Mermaid theme for this variant, can be overridden in config.toml', },
{ name: 'SWAGGER-theme', group: '3rd party', default: 'light', tooltip: 'name of the default Swagger theme for this variant, can be overridden in config.toml', },
{ name: 'OPENAPI-theme', group: '3rd party', default: 'light', tooltip: 'name of the default OpenAPI theme for this variant, can be overridden in config.toml', },
{ name: 'OPENAPI-CODE-theme', group: '3rd party', default: 'obsidian', tooltip: 'name of the default OpenAPI coee theme for this variant, can be overridden in config.toml', },
{ name: 'MENU-HEADER-BG-color', group: 'header', fallback: 'PRIMARY-color', tooltip: 'background color of menu header', },
{ name: 'MENU-HEADER-BORDER-color', group: 'header', fallback: 'MENU-HEADER-BG-color', tooltip: 'separator color of menu header', },

106
docs/public/repositories/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="">
<title>Repositories - A tool for commands</title>
<link href="/repositories/index.xml" rel="alternate" type="application/rss+xml" title="Repositories - 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
@ -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">
@ -57,25 +57,25 @@
</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="repositories">Repositories</h1>
<p>The repo mirrors are:</p>
<ul>
<li><a href="https://git.andrewnw.xyz/CyberShell/backy" target="_blank">https://git.andrewnw.xyz/CyberShell/backy</a></li>
<li><a href="https://git.vern.cc/cybershell/backy" target="_blank">https://git.vern.cc/cybershell/backy</a></li>
<li><a href="https://github.com/CybersShell/backy" target="_blank">https://github.com/CybersShell/backy</a></li>
</ul>
<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>
@ -134,27 +134,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"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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 active"><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=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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="active"><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">
@ -164,6 +165,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="/repositories/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -183,7 +185,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">
@ -191,8 +193,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 ){
@ -222,23 +224,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>

15
docs/public/sitemap.xml
View File

@ -1,26 +1,29 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>http://example.org/config/commands/index.html</loc>
</url>
<url>
<loc>http://example.org/getting-started/install/index.html</loc>
</url>
<url>
<loc>http://example.org/config/command-lists/index.html</loc>
</url>
<url>
<loc>http://example.org/config/commands/index.html</loc>
</url>
<url>
<loc>http://example.org/getting-started/index.html</loc>
</url>
<url>
<loc>http://example.org/config/notifications/index.html</loc>
</url>
<url>
<loc>http://example.org/config/index.html</loc>
</url>
<url>
<loc>http://example.org/config/notifications/index.html</loc>
</url>
<url>
<loc>http://example.org/cli/index.html</loc>
</url>
<url>
<loc>http://example.org/config/vault/index.html</loc>
</url>
<url>
<loc>http://example.org/repositories/index.html</loc>
</url>

106
docs/public/tags/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="">
<title>Tags - A tool for commands</title>
<link href="/tags/index.xml" rel="alternate" type="application/rss+xml" title="Tags - 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
@ -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">
@ -57,19 +57,17 @@
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article>
<header class="headline">
</header>
<h1 id="tags">Tags</h1>
<ul>
</ul>
<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>
@ -128,27 +126,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"><input type="checkbox" id="section-98a8c13bcd8ebb34cfcbafd00ee6590b" aria-controls="subsections-98a8c13bcd8ebb34cfcbafd00ee6590b" class="toggle"><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=""><input type="checkbox" id="section-05a1934784c32ed5016a6c9b2dd9e019" aria-controls="subsections-05a1934784c32ed5016a6c9b2dd9e019"><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">
@ -158,6 +157,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="/tags/index.html" selected></option>
</select>
</div>
<div class="select-clear"></div>
@ -177,7 +177,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">
@ -185,8 +185,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 ){
@ -216,23 +216,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>