2023-07-02 02:46:54 +00:00
<!DOCTYPE html>
< html lang = "en" dir = "ltr" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2024-11-20 06:08:16 +00:00
< meta name = "generator" content = "Hugo 0.135.0" >
< meta name = "generator" content = "Relearn 5.16.2" >
2023-07-02 02:46:54 +00:00
< meta name = "description" content = "" >
< title > Commands - A tool for commands< / title >
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2024-11-20 06:08:16 +00:00
< 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 >
2023-07-02 02:46:54 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
window.index_js_url="/index.search.js";
var root_url="/";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy to clipboard';
window.T_Copied_to_clipboard = 'Copied to clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
// some further base stuff
var baseUriFull='http:\/\/example.org/';
window.variants & & variants.init( [ 'auto' ] );
< / script >
< / head >
< body class = "mobile-support html" data-url = "/config/commands/index.html" >
< div id = "body" class = "default-animation" >
< div id = "sidebar-overlay" > < / div >
< div id = "toc-overlay" > < / div >
2024-11-20 06:08:16 +00:00
< nav id = "topbar" class = "highlightable" >
2023-07-02 02:46:54 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
< a href = "#" id = "sidebar-toggle" class = "topbar-link" title = 'Menu (CTRL+ALT+n)' > < i class = "fas fa-bars fa-fw" > < / i > < / a >
< / span >
< span id = "toc-menu" title = 'Table of Contents (CTRL+ALT+t)' > < i class = "fas fa-list-alt fa-fw" > < / i > < / span >
< span class = "links" >
Commands
< / span >
< / div >
< div class = "default-animation progress" >
2024-11-20 06:08:16 +00:00
< div class = "toc-wrapper" > < nav id = "TableOfContents" >
2023-07-02 02:46:54 +00:00
< ul >
< li >
< ul >
2024-11-20 06:08:16 +00:00
< li > < a href = "#example-config" > Example Config< / a > < / li >
< li > < a href = "#getoutput" > getOutput< / a > < / li >
2023-07-02 02:46:54 +00:00
< li > < a href = "#shell" > shell< / a > < / li >
2024-11-20 06:08:16 +00:00
< li > < a href = "#scriptenvfile" > scriptEnvFile< / a > < / li >
< li > < a href = "#type" > type< / a > < / li >
2023-07-02 02:46:54 +00:00
< li > < a href = "#environment" > environment< / a > < / li >
2024-11-20 06:08:16 +00:00
< li > < a href = "#hooks" > hooks< / a > < / li >
2023-07-02 02:46:54 +00:00
< / ul >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< / nav >
< main id = "body-inner" class = "highlightable default" tabindex = "-1" >
< div class = "flex-block-wrapper" >
< article class = "default" >
2024-11-20 06:08:16 +00:00
< header class = "headline" >
< / header >
2023-07-02 02:46:54 +00:00
< 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 >
2024-11-20 06:08:16 +00:00
< h3 id = "example-config" > Example Config< / h3 >
2023-07-02 02:46:54 +00:00
< div class = "highlight" > < pre tabindex = "0" style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;" > < code class = "language-yaml" data-lang = "yaml" > < span style = "display:flex;" > < span > < span style = "color:#f92672" > commands< / span > :
< / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#f92672" > stop-docker-container< / span > :
< / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#f92672" > cmd< / span > : < span style = "color:#ae81ff" > docker< / span >
< / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#f92672" > Args< / span > :
< / span > < / span > < span style = "display:flex;" > < span > - < span style = "color:#ae81ff" > compose< / span >
< / span > < / span > < span style = "display:flex;" > < span > - -< span style = "color:#ae81ff" > f /some/path/to/docker-compose.yaml< / span >
< / span > < / span > < span style = "display:flex;" > < span > - < span style = "color:#ae81ff" > down< / span >
< / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#75715e" > # if host is not defined, command will be run locally< / span >
< / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#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 >
2024-11-20 06:08:16 +00:00
< / 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 >
2023-07-02 02:46:54 +00:00
< / 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 >
2024-11-20 06:08:16 +00:00
< 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 >
2023-07-02 02:46:54 +00:00
< / table >
< h4 id = "cmd" > cmd< / h4 >
< p > cmd must be a valid command or script to execute.< / p >
< h4 id = "args" > args< / h4 >
< p > args must be arguments to cmd as they would be on the command-line:< / p >
< div class = "highlight" > < pre tabindex = "0" style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;" > < code class = "language-sh" data-lang = "sh" > < span style = "display:flex;" > < span > cmd < span style = "color:#f92672" > [< / span > arg1 arg2 ...< span style = "color:#f92672" > ]< / span >
< / span > < / span > < / code > < / pre > < / div > < p > Define them in an array:< / p >
< div class = "highlight" > < pre tabindex = "0" style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;" > < code class = "language-yaml" data-lang = "yaml" > < span style = "display:flex;" > < span > < span style = "color:#f92672" > args< / span > :
< / span > < / span > < span style = "display:flex;" > < span > - < span style = "color:#ae81ff" > arg1< / span >
< / span > < / span > < span style = "display:flex;" > < span > - < span style = "color:#ae81ff" > arg2< / span >
< / span > < / span > < span style = "display:flex;" > < span > - < span style = "color:#ae81ff" > arg3< / span >
2024-11-20 06:08:16 +00:00
< / 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 >
2023-07-02 02:46:54 +00:00
< 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" >
2024-11-20 06:08:16 +00:00
2023-07-02 02:46:54 +00:00
< p > If any < code > host< / code > is not defined or left blank, the command will run on the local machine.< / p >
2024-11-20 06:08:16 +00:00
< / div >
2023-07-02 02:46:54 +00:00
< / 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" >
2024-11-20 06:08:16 +00:00
2023-07-02 02:46:54 +00:00
< p > If any < code > host< / code > from the commands section does not match any object in the < code > hosts< / code > section, the < code > Host< / code > is assumed to be this value. This value will be used to search in the default SSH config files.< / p >
< p > For example, say that I have a host defined in my SSH config with the < code > Host< / code > defined as < code > web-prod< / code > .
If I assign a value to host as < code > host: web-prod< / code > and don’ t specify this value in the < code > hosts< / code > object, web-prod will be used as the < code > Host< / code > in searching the SSH config files.< / p >
2024-11-20 06:08:16 +00:00
< / div >
2023-07-02 02:46:54 +00:00
< / 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 >
2024-11-20 06:08:16 +00:00
< 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’ 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 >
2023-07-02 02:46:54 +00:00
< 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 >
2024-11-20 06:08:16 +00:00
< p > For now, the variables have to be defined in an < code > .env< / code > file in the same directory as the config file.< / p >
2023-07-02 02:46:54 +00:00
< p > If using it with host specified, the SSH server has to be configured to accept those env variables.< / p >
< p > If the command is run locally, the OS’ s environment is added.< / p >
2024-11-20 06:08:16 +00:00
< 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 >
2023-07-02 02:46:54 +00:00
< footer class = "footline" >
2024-11-20 06:08:16 +00:00
2023-07-02 02:46:54 +00:00
< / footer >
< / article >
< / div >
< / main >
< / div >
2024-11-20 06:08:16 +00:00
< aside id = "sidebar" class = "default-animation" >
2023-07-02 02:46:54 +00:00
< div id = "header-wrapper" class = "default-animation" >
< div id = "header" class = "default-animation" >
< style >
a#logo {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
font-size: 30px;
font-weight: 300;
margin-top: -13px;
text-transform: uppercase;
width: 256px;
white-space: nowrap;
}
a#logo:hover {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
}
#logo svg {
margin-bottom: -20px;
margin-left: -23.5px;
width: 40.5%;
}
@media only all and (max-width: 59.938em) {
a#logo {
font-size: 25px;
margin-top: -3px;
}
#logo svg {
margin-bottom: -12px;
margin-left: -23px;
}
}
@media all and (-ms-high-contrast:none) {
/* IE11s understanding of positioning is weird at best */
a#logo {
margin-top: -58px;
}
#logo svg {
margin-bottom: -62px;
}
}
< / style >
< a id = "logo" href = "/index.html" >
< svg version = "1.1" id = "_x36_" xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" viewBox = "-51.2 -51.2 614.40 614.40" xml:space = "preserve" width = "128px" height = "128px" fill = "#ffffff" stroke = "#ffffff" stroke-width = "0.00512" transform = "rotate(0)" > < g id = "SVGRepo_bgCarrier" stroke-width = "0" > < rect x = "-51.2" y = "-51.2" width = "614.40" height = "614.40" rx = "0" fill = "#000000" strokewidth = "0" > < / rect > < / g > < g id = "SVGRepo_tracerCarrier" stroke-linecap = "round" stroke-linejoin = "round" > < / g > < g id = "SVGRepo_iconCarrier" > < g > < polygon style = "fill:none;" points = "275.211,140.527 360.241,140.527 380.083,120.685 275.211,120.685 " > < / polygon > < polygon style = "fill:none;" points = "232.234,268.534 219.714,281.054 232.234,281.054 " > < / polygon > < g > < g > < rect x = "232.254" y = "69.157" style = "fill:#718176;" width = "42.982" height = "377.465" > < / rect > < polygon style = "fill:#718176;" points = "56.146,446.588 76.861,489.564 232.234,489.564 232.234,446.588 " > < / polygon > < polygon style = "fill:#718176;" points = "275.21,446.588 275.21,489.564 435.111,489.564 455.826,446.588 " > < / polygon > < rect x = "232.234" y = "446.588" style = "fill:#979696;" width = "42.977" height = "42.977" > < / rect > < path style = "fill:#718176;" d = "M511.972,7.837v105.05c0,4.315-3.485,7.8-7.8,7.8H7.8c-4.315,0-7.8-3.485-7.8-7.8V7.837 c0-4.315,3.485-7.799,7.8-7.799h496.372C508.487,0.037,511.972,3.522,511.972,7.837z" > < / path > < path style = "fill:#718176;" d = "M511.972,148.318v105.05c0,4.315-3.485,7.883-7.8,7.883H7.8c-4.315,0-7.8-3.568-7.8-7.883v-105.05 c0-4.315,3.485-7.8,7.8-7.8h496.372C508.487,140.518,511.972,144.003,511.972,148.318z" > < / path > < path style = "fill:#718176;" d = "M511.972,288.882v105.05c0,4.315-3.485,7.799-7.8,7.799H7.8c-4.315,0-7.8-3.484-7.8-7.799v-105.05 c0-4.314,3.485-7.799,7.8-7.799h496.372C508.487,281.082,511.972,284.568,511.972,288.882z" > < / path > < path style = "fill:#FFFFFF;" d = "M492.427,6.264H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.309,13.31,13.309h472.882c7.351,0,13.31-5.959,13.31-13.309V19.573 C505.737,12.222,499.778,6.264,492.427,6.264z" > < / path > < path style = "fill:#FFFFFF;" d = "M492.427,146.79H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539c0,7.351,5.959,13.31,13.31,13.31 h472.882c7.351,0,13.31-5.959,13.31-13.31V160.1C505.737,152.749,499.778,146.79,492.427,146.79z" > < / path > < path style = "fill:#FFFFFF;" d = "M492.427,287.318H19.545c-7.351,0-13.31,5.959-13.31,13.31v81.539 c0,7.351,5.959,13.31,13.31,13.31h472.882c7.351,0,13.31-5.959,13.31-13.31v-81.539 C505.737,293.276,499.778,287.318,492.427,287.318z" > < / path > < g > < g > < path style = "fill:#718176;" d = "M57.355,26.558H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C59.471,27.505,58.524,26.558,57.355,26.558z" > < / path > < path style = "fill:#718176;" d = "M57.355,52.308H43.829c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C59.471,53.256,58.524,52.308,57.355,52.308z" > < / path > < path style = "fill:#718176;" d = "M57.355,78.059H43.829c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C59.471,79.006,58.524,78.059,57.355,78.059z" > < / path > < / g > < g > < path style = "fill:#718176;" d = "M89.021,26.558H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V28.674C91.137,27.505,90.19,26.558,89.021,26.558z" > < / path > < path style = "fill:#718176;" d = "M89.021,52.308H75.495c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V54.424C91.137,53.256,90.19,52.308,89.021,52.308z" > < / path > < path style = "fill:#718176;" d = "M89.021,78.059H75.495c-1.169,0-2.116,0.948-2.116,2.116v13.548 c0,1.169,0.948,2.116,2.116,2.116h13.526c1.169,0,2.116-0.948,2.116-2.116V80.175C91.137,79.006,90.19,78.059,89.021,78.059z" > < / path > < / g > < g > < path style = "fill:#718176;" d = "M120.687,26.558h-13.525c-1.169,0-2.116,0.947-2.116,2.116v13.548 c0 , 1 . 169 , 0 . 948 , 2 . 116 , 2 . 116 , 2 . 116h13 . 525c1 . 169 , 0 , 2 . 116-0 . 948 , 2 . 116-2 . 116V28 . 674 C122 . 804 , 27 . 505 , 121 . 856 , 26 . 558 , 120 . 68
Backy
< / a >
< / div >
< div class = "searchbox default-animation" >
< i class = "fas fa-search" title = "Search (CTRL+ALT+f)" > < / i >
< label class = "a11y-only" for = "search-by" > Search< / label >
< input data-search-input id = "search-by" name = "search-by" class = "search-by" type = "search" placeholder = "Search..." >
< span data-search-clear = "" > < i class = "fas fa-times" > < / i > < / span >
< / div >
< script >
var contentLangs=['en'];
< / script >
2024-11-20 06:08:16 +00:00
< 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 >
2023-07-02 02:46:54 +00:00
< / div >
< div id = "content-wrapper" class = "highlightable" >
2024-11-20 06:08:16 +00:00
< 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 >
2023-07-02 02:46:54 +00:00
< / ul >
2024-11-20 06:08:16 +00:00
< div class = "padding footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter" > < / div >
< hr class = "padding default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showFooter" >
2023-07-02 02:46:54 +00:00
< div id = "prefooter" class = "footerLangSwitch footerVariantSwitch footerVisitedLinks" >
< ul >
< li id = "select-language-container" class = "footerLangSwitch" >
< div class = "padding select-container" >
< i class = "fas fa-language fa-fw" > < / i >
< span > < / span >
< div class = "select-style" >
< label class = "a11y-only" for = "select-language" > Language< / label >
< select id = "select-language" onchange = "location = baseUri + this.value;" >
2024-11-20 06:08:16 +00:00
< option lang = "en" id = "en" value = "/config/commands/index.html" selected > < / option >
2023-07-02 02:46:54 +00:00
< / select >
< / div >
< div class = "select-clear" > < / div >
< / div >
< / li >
< li id = "select-variant-container" class = "footerVariantSwitch" >
< div class = "padding select-container" >
< i class = "fas fa-paint-brush fa-fw" > < / i >
< span > < / span >
< div class = "select-style" >
< label class = "a11y-only" for = "select-variant" > Theme< / label >
< select id = "select-variant" onchange = "window.variants && variants.changeVariant( this.value );" >
< option id = "auto" value = "auto" selected > Auto< / option >
< / select >
< / div >
< div class = "select-clear" > < / div >
< / div >
< script > window . variants && variants . markSelectedVariant ( ) ; < / script >
< / li >
2024-11-20 06:08:16 +00:00
< li class = "footerVisitedLinks" > < button class = "padding" onclick = "clearHistory();" > < i class = "fas fa-history fa-fw" > < / i > < span > < / span > Clear History< / button > < / li >
2023-07-02 02:46:54 +00:00
< / ul >
< / div >
< div id = "footer" class = "footerFooter showFooter" >
< p > Built with < a href = "https://github.com/McShelby/hugo-theme-relearn" title = "love" > < i class = "fas fa-heart" > < / i > < / a > by < a href = "https://gohugo.io/" > Hugo< / a > < / p >
< / div >
< / div >
< / aside >
2024-11-20 06:08:16 +00:00
< script src = "/js/clipboard.min.js?1732082585" defer > < / script >
< script src = "/js/perfect-scrollbar.min.js?1732082585" defer > < / script >
2023-07-02 02:46:54 +00:00
< script >
function useMathJax( config ){
if( !Object.assign ){
return;
}
window.MathJax = Object.assign( window.MathJax || {}, {
loader: {
load: ['[tex]/mhchem']
},
startup: {
elements: [
'.math'
]
},
tex: {
inlineMath: [
['$', '$'],
['\\(', '\\)']
]
},
options: {
enableMenu: false
}
}, config );
}
useMathJax( JSON.parse("{}") );
< / script >
< script id = "MathJax-script" async src = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" > < / script >
2024-11-20 06:08:16 +00:00
< 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 >
2023-07-02 02:46:54 +00:00
< script src = "https://unpkg.com/mermaid/dist/mermaid.min.js" defer > < / script >
< script >
window.themeUseMermaid = JSON.parse("{ \"theme\": \"default\" }");
< / script >
2024-11-20 06:08:16 +00:00
< script src = "/js/theme.js?1732082585" defer > < / script >
2023-07-02 02:46:54 +00:00
< / body >
< / html >
