added logging section to example config
This commit is contained in:
parent
4bdad20a92
commit
36318cd485
37 changed files with 4192 additions and 0 deletions
3
docs/content/reference/norgbackupweb/.domains
Normal file
3
docs/content/reference/norgbackupweb/.domains
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
norgbackup.net
|
||||||
|
www.norgbackup.net
|
||||||
|
pages.norgbackupweb.pswilde.codeberg.page
|
||||||
3
docs/content/reference/norgbackupweb/404.html
Normal file
3
docs/content/reference/norgbackupweb/404.html
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
<!doctype html>
|
||||||
|
<title>404 Not Found</title>
|
||||||
|
<h1>404 Not Found</h1>
|
||||||
|
|
@ -0,0 +1,166 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Contributing </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Contributing</h1>
|
||||||
|
|
||||||
|
<p>We are very happy to take on an ideas or issues you may have with Norg, and
|
||||||
|
welcome pull requests that can implement these features within reason.<br />
|
||||||
|
The source code is published here: <a href="https://codeberg.org/pswilde/norgbackup">codeberg.org/pswilde/norgbackup</a>, which is where you can raise issue and make pull requests.</p>
|
||||||
|
<p>When creating new features, or adjusting anything within the current state of Norg,
|
||||||
|
please also update the documentation to reflect these changes.
|
||||||
|
The documentation uses the <a href="https://getzola.org">Zola</a> static site generator,
|
||||||
|
which uses markdown content files in the <code>docs/content/</code> directory.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
165
docs/content/reference/norgbackupweb/contributing/index.html
Normal file
165
docs/content/reference/norgbackupweb/contributing/index.html
Normal file
|
|
@ -0,0 +1,165 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Contributing to Norg </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1></h1>
|
||||||
|
|
||||||
|
<h2 class="title"> Contributing to Norg </h2>
|
||||||
|
|
||||||
|
<h3>Pages:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://norgbackup.net/contributing/contributing/">Contributing</a></li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,181 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Download Norg </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Download Norg</h1>
|
||||||
|
|
||||||
|
<h2 id="installing-from-nimble-directory">Installing from nimble.directory</h2>
|
||||||
|
<p>The latest version of Norg is most simply downloaded and installed using Nim's <code>nimble</code> command line tool.</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">nimble</span><span> install norg
|
||||||
|
</span></code></pre>
|
||||||
|
<h2 id="installing-direct-from-the-norg-code-repository">Installing direct from the Norg code repository</h2>
|
||||||
|
<p>You can also install, via nimble, direct from the code repository.</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">nimble</span><span> install https://codeberg.org/pswilde/norgbackup
|
||||||
|
</span></code></pre>
|
||||||
|
<h2 id="building-from-source">Building from Source</h2>
|
||||||
|
<p>Norg source code can be downloaded from our <a href="https://codeberg.org/pswilde/norgbackup/releases">releases page at Codeberg</a> and can be built using the following commands:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">unzip</span><span> norgbackup-{version}.zip
|
||||||
|
</span><span style="color:#a7adba;"># or
|
||||||
|
</span><span style="color:#bf616a;">tar</span><span> xf norgbackup-{version}.tar.gz
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#96b5b4;">cd</span><span> norgbackup
|
||||||
|
</span><span style="color:#bf616a;">nimble</span><span> install
|
||||||
|
</span></code></pre>
|
||||||
|
<h2 id="pre-compiled-binaries">Pre-compiled Binaries</h2>
|
||||||
|
<p>We are working on providing pre-compiled binaries on our <a href="https://codeberg.org/pswilde/norgbackup/releases">releases page at Codeberg</a>. Currently these are not available, so using the options above are the best option.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
165
docs/content/reference/norgbackupweb/download/index.html
Normal file
165
docs/content/reference/norgbackupweb/download/index.html
Normal file
|
|
@ -0,0 +1,165 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Download </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1></h1>
|
||||||
|
|
||||||
|
<h2 class="title"> Download </h2>
|
||||||
|
|
||||||
|
<h3>Pages:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://norgbackup.net/download/download-norg/">Download Norg</a></li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
10
docs/content/reference/norgbackupweb/elasticlunr.min.js
vendored
Normal file
10
docs/content/reference/norgbackupweb/elasticlunr.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1 @@
|
||||||
|
@font-face{font-family:"FabricMDL2Icons";src:url("data:application/octet-stream;base64,d09GRgABAAAAAAusAA4AAAAAFLgABDXDAAAAAAAAAAAAAAAAAAAAAAAAAABPUy8yAAABRAAAAEgAAABgMUZ1H2NtYXAAAAGMAAAAWgAAAYKg2Y81Y3Z0IAAAAegAAAAgAAAAKgnZCa9mcGdtAAACCAAAAPAAAAFZ/J7mjmdhc3AAAAL4AAAADAAAAAwACAAbZ2x5ZgAAAwQAAANyAAAEuLnx29VoZWFkAAAGeAAAADIAAAA2A3zu4GhoZWEAAAasAAAAFQAAACQQAQgDaG10eAAABsQAAAAYAAAAGA+HAaZsb2NhAAAG3AAAABYAAAAWBoYE+m1heHAAAAb0AAAAHQAAACAAJAHEbmFtZQAABxQAAAP3AAAJ+o6N8lFwb3N0AAALDAAAABQAAAAg/1EAgXByZXAAAAsgAAAAiQAAANN4vfIOeJxjYGHfzjiBgZWBgXUWqzEDA6M0hGa+yJDGJMTBysrFyMQIBgxAIMCAAL7BCgoMDs8Z3ulxgPkQkgGsjgXCU2BgAADc3QgGeJxjYGBgZoBgGQZGBhCoAfIYwXwWhgQgLcIgABRhec7wXPG50XO/54df7H5x4mXBO73//xkYsIlKMko8lLgqsVXCUdxL3E5shuBtqMkYgJENu/hIAgCdyyInAAB4nGPQYghlKGBoYFjFyMDYwOzAeIDBAYsIEAAAqhwHlXicXY+/TsNADMZzJLSEJ0A6IZ11KkOViJ3phksk1CUlDOelgNRKpO+AlIXFA8/ibhnzYgjMEf4utr/P+ny/c6f5yXx2nKVHKilWnDfhoNQLDurtmf35IU/vNmVhTNV5VvdlwWoJomtOF/VNsGjI0PWWTG0eH7acLWKXxY7w0nDShk7qbQB2qL/HHeJVPJLFI4QS30/xfYxL+rUsVobTiyasA/des/OoAUzFYxN49BoQf8ikP3VnE+NsOWXbwE5zgkSfygL3RJqE+0uPf/Wgkv+G+23Iv6tB9U3c9Bb0h2HBgrChl2fbUAkaYPkOhPxkxgABAAIACAAK//8AD3icXVNNaBtXEJ55b1dPsl0165UqUOJ1dze7mx+quFrJilwQwgQ3P8UpOGCKUhNfSnrqJb/Q4BcoGAr9CfSUGHpyLr2VJCT0klsv7SVXQ29uySmJCbQr7646byWnpjvsm583b+bNN/OAwX0A7Sv9GnAQAC3DNjzbsO/zP+JH7FFyFvRr/a9/0BaBPg6AMg85OgAFKMJR+CWzctCOPwY48ATegtzrJzAGnNZ8Juskz7yPdtMuG2+WPPwD//26lDIGKRmurQFTifJE4EKL8tUtrVwqaq7jB5ijtdloYQ2bjY5m1jus2agx1ymycslienf1wcbti/X6xdsbD1ZvbV+KX5jVqm/yA+cvDG3Xn230ehvPro94Hobm4bEL5+OXpl+tmty4tH1raNuFfe4Zp8olSEFE9U9CFYLsjozqCoxGh4VI4NEfEtnoEpquUSHRsAUcrLmlaHu75NYOIsWJCbeESkfJQO6CvPsZJ1lItR/JP/W7yj8BJndlKhEGhHtCR/r37jFIYdgPCdS0vOqHIOwBVSLTLmTcEBBJreehl26hTCGW+lbfy9NZ9KKeTkhHFAPf4D0OUEBRwKCArQJWtDv8izsxEfFsIZUuvV+NlQtAhgkImgwKMw4GVEY3IQRCMww8ewSKQoEqTYH3UEpvczOWzBtAQppGNSZSA21r10OZIy2Vm1sIfckIlL5Us6fCMwnvwTn4fIR6qchc26mxwC7yTGiqHti0VbE7PEQakVY2NLMfYE15DEeFPEazoywirL9TLuWOo8XD3NP5K8thuHxlfgDty0tzE+nribmly+0BzF9drteXr87j0I4TmT2WVnvm8NjDqu9XH44dnmlbAziy0LCsxsIRXe5JA/i/F5Mqh4rpn1o5eXLllK9iq9x7egqTzokpGkh/6oQzqaLsRVN8/x4gfgoi96GI1NMsMNVAtsijWLziIo5eCZJiscMFFzv0HiWwPIhf4W0wqVM+1FW3iAQaNDg50VS8hUYL9SHGOYG6iR2szDYbvuuQKlqcusXenU7WeJd3F+YSme6w038n371MHqd/6c+PnZmdtg4lYbq+wn6fOt0rH50uVseSj5x1HLBPsBt/n75Yw672Mf6YrqY7485P6dM00JbSn7/EdvLtDVz8JpVW88yx4CxFWcGb7LepQ1HZmg4KFGXdgX8Bg/8uhAAAeJxjYGRgYGAxPVwnx6UQz2/zlYGbgwEE9v892ACi78Sumg+iORjA4pwMTCAKAB/CCRAAAHicY2BkYOBgAAE4yciACpgAAsoAHQAAAAUqAKYIAAAAAAAAgACAAAAAgAAAAV0AgAAAABYASACYAN4BAAEiAVQB4gH4AlwAAHicY2BkYGDgYshiYGUAAUYwyQXCjJEgJgAOogDqAAAAeJy1VE+LGzcUf1472S1plhIo5KhDKZvFjLNuIDQ5LUlzyl42YSGXgjySZ0TGIyFpMkzpoccc+jF6CfRTlBZ67LmfoOeeeux7bzReb+yGbaEeRvPT0/v7e08GgLujz2EE/e8LfHs8gju46/Ee7MNXCY9R/jzhCeKvE74BH4NL+CZ8At8mvA9fwvcJH8Cn8EvCt+AYfk/49ujn0SThQzje+xWjjCYf4U7t/ZnwCD4bXyS8B4fjbxIeo/xtwhPEPyZ8A+6Of0v4JojxHwnvg58cJHwAx5PBzy14Ofkh4dvjt5O/Ej6Elwff/fROzO+fPBRnJvc22GUUT6x31stobJ2J06oS56YoYxDnOmj/RqvsmVx4k4uzp8/n4jQEHcO5LppK+u2DbcmF9gE9iwfZ/KQ/pcP+7IUurBYmCCmil0qvpH8t7FLEUm/kV3jbOBLnduVkbXTIdiZfxugezWZt22ar4TxDm1nsnC28dGU3W9o6htmleWicq4xWgg4y8co2YiU70QSNSWBiJBbRitxrGfVUKBNcJbupkLUSzhs8zVFF41cG4bRfmRjR3aLjIiqT65p84UEQ1g9gSRGm26U6b1WTx6kg5tF2SjZDAFOLtjR5uZFZi0FNnVeNwjats7d11Ykjc0/o1QJzuVRHDx/KltWVqQvhdYjYKWL1MgCZr309ZgaODEaJekUt8AajKtvWlZXqKnuyp0p7KsdiKFyb6JoolKYySafUlbvKKA5j3SV1agg6RH5KszCYc3b9bsM7EDCH+3ACDxGdgYEcPFgI+C4houwJIo93nlaJEoOohgxPTqHCR8A5ygoo8SzwTuNXo/YbXBVqPkO7Be7JN8V4iv8sc7YPrEl2ZFVAg/4kal7H4jo6F5xHSDkLeIDZzLHWTdvBctPuBWdjcRWoQ1VJfCMzoFC64ixfo4xYopOSdXfxV/C+QQYH7Ry/K9xLzMkwW9m/YJ54jih9BDN8Wn4y9Pe+fZbizBB37KVgPw49dChdsjeqdrYzeuCcHXbEcB/F2oJ6/4prEsxEh9+GueuZ6BkbtElmuWqPGlSHhinuFes57njHEuKD4jjuTG+bJy867SX7dtxXqjnyGVktOI+hExVXRFZDXr1F4C74LclyXcP0Wl11vFdok+N+ynz1M9/Hna7jvF+B4Ulsmacc192ctalS0s6xmobnTu3knmwqRkeofw+/NKGLxMsu730O/5XbS++KPRUo8zzHMd2pYVZ3VTBE387r8cYMUCV9LZHjDbeA/Pe1KpS0XLnlW/mh2ZNXpkpzX2xa+6p63PDNatiSsh26OfghzYpv8j/PaP/PWKfOXHofbohJLNP8UL4LZrrv7f9wt/8GD0U4iAB4nGNgZgCD/34M5QyYgAsAKTQB0nic28CgzbCJkZNJm3ETF4jcztWaG2qrysChvZ07NdhBTwbE4onwsNCQBLF4nc215YVBLD4dFRkRHhCLX05CmI8DxBLg4+FkZwGxBMEAxBLaMKEgwADIYtjOCDeaCW40M9xoFrjRrHCj2eQkoUazw43mgBvNCTd6kzAju/YGBgXX2kwJFwDEASgaAAAA") format("truetype")}.ms-Icon{-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased;display:inline-block;font-family:"FabricMDL2Icons";font-style:normal;font-weight:normal;speak:none}.ms-Icon--ChevronRightSmall:before{content:""}.ms-Icon--ChromeClose:before{content:""}.ms-Icon--Copy:before{content:""}.ms-Icon--GlobalNavButton:before{content:""}.ms-Icon--MiniLink:before{content:""}.ms-Icon--Page:before{content:""}.ms-Icon--ProductRelease:before{content:""}.ms-Icon--Save:before{content:""}.ms-Icon--Search:before{content:""}
|
||||||
BIN
docs/content/reference/norgbackupweb/favicon.png
Normal file
BIN
docs/content/reference/norgbackupweb/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 441 B |
46
docs/content/reference/norgbackupweb/favicon.svg
Normal file
46
docs/content/reference/norgbackupweb/favicon.svg
Normal file
|
|
@ -0,0 +1,46 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||||
|
|
||||||
|
<svg
|
||||||
|
width="4.5940185mm"
|
||||||
|
height="5.2606449mm"
|
||||||
|
viewBox="0 0 4.5940185 5.2606449"
|
||||||
|
version="1.1"
|
||||||
|
id="svg1"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg">
|
||||||
|
<sodipodi:namedview
|
||||||
|
id="namedview1"
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1.0"
|
||||||
|
inkscape:showpageshadow="2"
|
||||||
|
inkscape:pageopacity="0.0"
|
||||||
|
inkscape:pagecheckerboard="0"
|
||||||
|
inkscape:deskcolor="#d1d1d1"
|
||||||
|
inkscape:document-units="mm" />
|
||||||
|
<defs
|
||||||
|
id="defs1" />
|
||||||
|
<g
|
||||||
|
inkscape:label="Layer 1"
|
||||||
|
inkscape:groupmode="layer"
|
||||||
|
id="layer1"
|
||||||
|
transform="translate(-70.078165,-44.555655)">
|
||||||
|
<text
|
||||||
|
xml:space="preserve"
|
||||||
|
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10.5833px;line-height:1.25;font-family:'Bauhaus 93';-inkscape-font-specification:'Bauhaus 93, ';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583"
|
||||||
|
x="69.514893"
|
||||||
|
y="49.816299"
|
||||||
|
id="text2"
|
||||||
|
inkscape:export-filename="favicon.svg"
|
||||||
|
inkscape:export-xdpi="190.56087"
|
||||||
|
inkscape:export-ydpi="190.56087"><tspan
|
||||||
|
sodipodi:role="line"
|
||||||
|
id="tspan2"
|
||||||
|
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Bauhaus 93';-inkscape-font-specification:'Bauhaus 93, ';stroke-width:0.264583"
|
||||||
|
x="69.514893"
|
||||||
|
y="49.816299">n</tspan></text>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.7 KiB |
6
docs/content/reference/norgbackupweb/index.html
Normal file
6
docs/content/reference/norgbackupweb/index.html
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
<!doctype html>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="canonical" href="https://norgbackup.net/introduction/about-norg/">
|
||||||
|
<meta http-equiv="refresh" content="0; url=https://norgbackup.net/introduction/about-norg/">
|
||||||
|
<title>Redirect</title>
|
||||||
|
<p><a href="https://norgbackup.net/introduction/about-norg/">Click here</a> to be redirected.</p>
|
||||||
|
|
@ -0,0 +1,172 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | About Norg </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>About Norg</h1>
|
||||||
|
|
||||||
|
<p><code>Norg</code> is a simple, portable, wrapper utility for the <a href="https://borgbackup.com">BorgBackup</a> and <a href="https://restic.net">Restic</a> backup utilities.<br />
|
||||||
|
This website serves as a point of reference for both documentation and
|
||||||
|
assistance when using the <code>norg</code> backup utilitiy.<br />
|
||||||
|
Please use the menu or search function to find the information you require.</p>
|
||||||
|
<h2 id="naming-why-norg">Naming. Why "Norg"?</h2>
|
||||||
|
<p>Norg is short for "Nice Borg" - a way to nicely handle borg based backups.</p>
|
||||||
|
<p>Also, I'm a Star Trek fan so obviously I wanted to keep something in line with the
|
||||||
|
<a href="https://memory-alpha.fandom.com/wiki/Borg">Borg pseudo-species</a> as the borg backup utility does.<br />
|
||||||
|
Also, sometimes I feel my code has elements of inexperience but loads of potential... which reminded me of <a href="https://memory-alpha.fandom.com/wiki/Nog">Nog</a>.<br />
|
||||||
|
So, simply put, Norg could also be a portmanteau of "Borg" and "Nog".</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
<!doctype html>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="canonical" href="https://norgbackup.net/introduction/about-norg/">
|
||||||
|
<meta http-equiv="refresh" content="0; url=https://norgbackup.net/introduction/about-norg/">
|
||||||
|
<title>Redirect</title>
|
||||||
|
<p><a href="https://norgbackup.net/introduction/about-norg/">Click here</a> to be redirected.</p>
|
||||||
|
|
@ -0,0 +1,181 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | System Compatibility </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>System Compatibility</h1>
|
||||||
|
|
||||||
|
<p>Norg should run on any platform able to compile <code>nim</code> code using <code>nimble</code>.<br />
|
||||||
|
It has been tested on the following operating systems:</p>
|
||||||
|
<ul>
|
||||||
|
<li>FreeBSD</li>
|
||||||
|
<li>Arch Linux</li>
|
||||||
|
<li>AlmaLinux</li>
|
||||||
|
<li>Rocky Linux</li>
|
||||||
|
<li>Debian</li>
|
||||||
|
</ul>
|
||||||
|
<p>Ultimately, any system that can compile the code and has the <code>borg</code> or <code>restic</code>
|
||||||
|
binary files in the running user's <code>$PATH</code> environment variable should be able
|
||||||
|
to run <code>norg</code> without issue.</p>
|
||||||
|
<h2 id="windows-support">Windows Support</h2>
|
||||||
|
<p>Running <code>norg</code> on Windows is feasibly possible (for Restic repositories,
|
||||||
|
Borg is not supported on Windows), and is planned for a future release.
|
||||||
|
<code>Norg</code> uses fairly pure nim code, which should be transferrable between
|
||||||
|
Operating Systems. The only thing lacking for Windows is a reference to the
|
||||||
|
correct path for running Restic. This should be an easy fix, and will work in a
|
||||||
|
future release.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
295
docs/content/reference/norgbackupweb/js.js
Normal file
295
docs/content/reference/norgbackupweb/js.js
Normal file
|
|
@ -0,0 +1,295 @@
|
||||||
|
// search script, borrowed from book theme
|
||||||
|
|
||||||
|
function debounce(func, wait) {
|
||||||
|
var timeout;
|
||||||
|
|
||||||
|
return function () {
|
||||||
|
var context = this;
|
||||||
|
var args = arguments;
|
||||||
|
clearTimeout(timeout);
|
||||||
|
|
||||||
|
timeout = setTimeout(function () {
|
||||||
|
timeout = null;
|
||||||
|
func.apply(context, args);
|
||||||
|
}, wait);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Taken from mdbook
|
||||||
|
// The strategy is as follows:
|
||||||
|
// First, assign a value to each word in the document:
|
||||||
|
// Words that correspond to search terms (stemmer aware): 40
|
||||||
|
// Normal words: 2
|
||||||
|
// First word in a sentence: 8
|
||||||
|
// Then use a sliding window with a constant number of words and count the
|
||||||
|
// sum of the values of the words within the window. Then use the window that got the
|
||||||
|
// maximum sum. If there are multiple maximas, then get the last one.
|
||||||
|
// Enclose the terms in <b>.
|
||||||
|
function makeTeaser(body, terms) {
|
||||||
|
var TERM_WEIGHT = 40;
|
||||||
|
var NORMAL_WORD_WEIGHT = 2;
|
||||||
|
var FIRST_WORD_WEIGHT = 8;
|
||||||
|
var TEASER_MAX_WORDS = 30;
|
||||||
|
|
||||||
|
var stemmedTerms = terms.map(function (w) {
|
||||||
|
return elasticlunr.stemmer(w.toLowerCase());
|
||||||
|
});
|
||||||
|
var termFound = false;
|
||||||
|
var index = 0;
|
||||||
|
var weighted = []; // contains elements of ["word", weight, index_in_document]
|
||||||
|
|
||||||
|
// split in sentences, then words
|
||||||
|
var sentences = body.toLowerCase().split(". ");
|
||||||
|
|
||||||
|
for (var i in sentences) {
|
||||||
|
var words = sentences[i].split(" ");
|
||||||
|
var value = FIRST_WORD_WEIGHT;
|
||||||
|
|
||||||
|
for (var j in words) {
|
||||||
|
var word = words[j];
|
||||||
|
|
||||||
|
if (word.length > 0) {
|
||||||
|
for (var k in stemmedTerms) {
|
||||||
|
if (elasticlunr.stemmer(word).startsWith(stemmedTerms[k])) {
|
||||||
|
value = TERM_WEIGHT;
|
||||||
|
termFound = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
weighted.push([word, value, index]);
|
||||||
|
value = NORMAL_WORD_WEIGHT;
|
||||||
|
}
|
||||||
|
|
||||||
|
index += word.length;
|
||||||
|
index += 1; // ' ' or '.' if last word in sentence
|
||||||
|
}
|
||||||
|
|
||||||
|
index += 1; // because we split at a two-char boundary '. '
|
||||||
|
}
|
||||||
|
|
||||||
|
if (weighted.length === 0) {
|
||||||
|
return body;
|
||||||
|
}
|
||||||
|
|
||||||
|
var windowWeights = [];
|
||||||
|
var windowSize = Math.min(weighted.length, TEASER_MAX_WORDS);
|
||||||
|
// We add a window with all the weights first
|
||||||
|
var curSum = 0;
|
||||||
|
for (var i = 0; i < windowSize; i++) {
|
||||||
|
curSum += weighted[i][1];
|
||||||
|
}
|
||||||
|
windowWeights.push(curSum);
|
||||||
|
|
||||||
|
for (var i = 0; i < weighted.length - windowSize; i++) {
|
||||||
|
curSum -= weighted[i][1];
|
||||||
|
curSum += weighted[i + windowSize][1];
|
||||||
|
windowWeights.push(curSum);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we didn't find the term, just pick the first window
|
||||||
|
var maxSumIndex = 0;
|
||||||
|
if (termFound) {
|
||||||
|
var maxFound = 0;
|
||||||
|
// backwards
|
||||||
|
for (var i = windowWeights.length - 1; i >= 0; i--) {
|
||||||
|
if (windowWeights[i] > maxFound) {
|
||||||
|
maxFound = windowWeights[i];
|
||||||
|
maxSumIndex = i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var teaser = [];
|
||||||
|
var startIndex = weighted[maxSumIndex][2];
|
||||||
|
for (var i = maxSumIndex; i < maxSumIndex + windowSize; i++) {
|
||||||
|
var word = weighted[i];
|
||||||
|
if (startIndex < word[2]) {
|
||||||
|
// missing text from index to start of `word`
|
||||||
|
teaser.push(body.substring(startIndex, word[2]));
|
||||||
|
startIndex = word[2];
|
||||||
|
}
|
||||||
|
|
||||||
|
// add <em/> around search terms
|
||||||
|
if (word[1] === TERM_WEIGHT) {
|
||||||
|
teaser.push("<b>");
|
||||||
|
}
|
||||||
|
startIndex = word[2] + word[0].length;
|
||||||
|
teaser.push(body.substring(word[2], startIndex));
|
||||||
|
|
||||||
|
if (word[1] === TERM_WEIGHT) {
|
||||||
|
teaser.push("</b>");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
teaser.push("…");
|
||||||
|
return teaser.join("");
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatSearchResultItem(item, terms) {
|
||||||
|
var li = document.createElement("li");
|
||||||
|
li.classList.add("search-results__item");
|
||||||
|
li.innerHTML = `<a href="${item.ref}">${item.doc.title}</a>`;
|
||||||
|
li.innerHTML += `<div class="search-results__teaser">${makeTeaser(item.doc.body, terms)}</div>`;
|
||||||
|
return li;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Go from the book view to the search view
|
||||||
|
function toggleSearchMode() {
|
||||||
|
var $wrapContent = document.querySelector("#wrap");
|
||||||
|
var $searchIcon = document.querySelector("#search-ico");
|
||||||
|
var $searchContainer = document.querySelector(".search-container");
|
||||||
|
if ($searchContainer.classList.contains("search-container--is-visible")) {
|
||||||
|
$searchContainer.classList.remove("search-container--is-visible");
|
||||||
|
$wrapContent.style.display = "";
|
||||||
|
$searchIcon.className = "ms-Icon--Search";
|
||||||
|
} else {
|
||||||
|
$searchContainer.classList.add("search-container--is-visible");
|
||||||
|
$wrapContent.style.display = "none";
|
||||||
|
$searchIcon.className = "ms-Icon--ChromeClose";
|
||||||
|
document.getElementById("search").focus();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function initSearch() {
|
||||||
|
var $searchInput = document.getElementById("search");
|
||||||
|
if (!$searchInput) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
var $searchIcon = document.querySelector("#search-ico");
|
||||||
|
$searchIcon.addEventListener("click", toggleSearchMode);
|
||||||
|
|
||||||
|
var $searchResults = document.querySelector(".search-results");
|
||||||
|
var $searchResultsHeader = document.querySelector(".search-results__header");
|
||||||
|
var $searchResultsItems = document.querySelector(".search-results__items");
|
||||||
|
var MAX_ITEMS = 100;
|
||||||
|
|
||||||
|
var options = {
|
||||||
|
bool: "AND",
|
||||||
|
fields: {
|
||||||
|
title: {boost: 2},
|
||||||
|
body: {boost: 1},
|
||||||
|
}
|
||||||
|
};
|
||||||
|
var currentTerm = "";
|
||||||
|
var index = elasticlunr.Index.load(window.searchIndex);
|
||||||
|
|
||||||
|
$searchInput.addEventListener("keyup", debounce(function() {
|
||||||
|
var term = $searchInput.value.trim();
|
||||||
|
if (term === currentTerm || !index) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
$searchResults.style.display = term === "" ? "none" : "block";
|
||||||
|
$searchResultsItems.innerHTML = "";
|
||||||
|
if (term === "") {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var results = index.search(term, options).filter(function (r) {
|
||||||
|
return r.doc.body !== "";
|
||||||
|
});
|
||||||
|
if (results.length === 0) {
|
||||||
|
$searchResultsHeader.innerText = `Nothing like «${term}»`;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
currentTerm = term;
|
||||||
|
$searchResultsHeader.innerText = `${results.length} found for «${term}»:`;
|
||||||
|
for (var i = 0; i < Math.min(results.length, MAX_ITEMS); i++) {
|
||||||
|
if (!results[i].doc.body) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
// var item = document.createElement("li");
|
||||||
|
// item.innerHTML = formatSearchResultItem(results[i], term.split(" "));
|
||||||
|
console.log(results[i]);
|
||||||
|
$searchResultsItems.appendChild(formatSearchResultItem(results[i], term.split(" ")));
|
||||||
|
}
|
||||||
|
}, 150));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === "complete" ||
|
||||||
|
(document.readyState !== "loading" && !document.documentElement.doScroll)
|
||||||
|
) {
|
||||||
|
initSearch();
|
||||||
|
} else {
|
||||||
|
document.addEventListener("DOMContentLoaded", initSearch);
|
||||||
|
}
|
||||||
|
|
||||||
|
// mobile
|
||||||
|
|
||||||
|
function burger() {
|
||||||
|
let x = document.querySelector("#trees");
|
||||||
|
let y = document.querySelector("#mobile");
|
||||||
|
|
||||||
|
if (x.style.display === "block") {
|
||||||
|
x.style.display = "none";
|
||||||
|
y.className = "ms-Icon--GlobalNavButton";
|
||||||
|
} else {
|
||||||
|
x.style.display = "block";
|
||||||
|
y.className = "ms-Icon--ChromeClose";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://aaronluna.dev/blog/add-copy-button-to-code-blocks-hugo-chroma/
|
||||||
|
|
||||||
|
function createCopyButton(highlightDiv) {
|
||||||
|
const button = document.createElement("button");
|
||||||
|
button.className = "copy-code-button ";
|
||||||
|
button.type = "button";
|
||||||
|
button.innerHTML = "";
|
||||||
|
button.addEventListener("click", () =>
|
||||||
|
copyCodeToClipboard(button, highlightDiv)
|
||||||
|
);
|
||||||
|
addCopyButtonToDom(button, highlightDiv);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function copyCodeToClipboard(button, highlightDiv) {
|
||||||
|
const codeToCopy = highlightDiv.querySelector(":last-child > code")
|
||||||
|
.innerText;
|
||||||
|
try {
|
||||||
|
result = await navigator.permissions.query({ name: "clipboard-write" });
|
||||||
|
if (result.state == "granted" || result.state == "prompt") {
|
||||||
|
await navigator.clipboard.writeText(codeToCopy);
|
||||||
|
} else {
|
||||||
|
copyCodeBlockExecCommand(codeToCopy, highlightDiv);
|
||||||
|
}
|
||||||
|
} catch (_) {
|
||||||
|
copyCodeBlockExecCommand(codeToCopy, highlightDiv);
|
||||||
|
} finally {
|
||||||
|
codeWasCopied(button);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function copyCodeBlockExecCommand(codeToCopy, highlightDiv) {
|
||||||
|
const textArea = document.createElement("textArea");
|
||||||
|
textArea.contentEditable = "true";
|
||||||
|
textArea.readOnly = "false";
|
||||||
|
textArea.className = "copyable-text-area";
|
||||||
|
textArea.value = codeToCopy;
|
||||||
|
highlightDiv.insertBefore(textArea, highlightDiv.firstChild);
|
||||||
|
const range = document.createRange();
|
||||||
|
range.selectNodeContents(textArea);
|
||||||
|
const sel = window.getSelection();
|
||||||
|
sel.removeAllRanges();
|
||||||
|
sel.addRange(range);
|
||||||
|
textArea.setSelectionRange(0, 999999);
|
||||||
|
document.execCommand("copy");
|
||||||
|
highlightDiv.removeChild(textArea);
|
||||||
|
}
|
||||||
|
|
||||||
|
function codeWasCopied(button) {
|
||||||
|
button.blur();
|
||||||
|
button.innerHTML = "";
|
||||||
|
setTimeout(function () {
|
||||||
|
button.innerHTML = "";
|
||||||
|
}, 2000);
|
||||||
|
}
|
||||||
|
|
||||||
|
function addCopyButtonToDom(button, highlightDiv) {
|
||||||
|
highlightDiv.insertBefore(button, highlightDiv.firstChild);
|
||||||
|
const wrapper = document.createElement("div");
|
||||||
|
wrapper.className = "highlight-wrapper";
|
||||||
|
highlightDiv.parentNode.insertBefore(wrapper, highlightDiv);
|
||||||
|
wrapper.appendChild(highlightDiv);
|
||||||
|
}
|
||||||
|
|
||||||
|
document
|
||||||
|
.querySelectorAll("pre")
|
||||||
|
.forEach((highlightDiv) => createCopyButton(highlightDiv));
|
||||||
1
docs/content/reference/norgbackupweb/logo.svg
Normal file
1
docs/content/reference/norgbackupweb/logo.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg id="logo-11" width="119" height="30" viewBox="0 0 119 30" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M2.94098 27.825H28.591V2.175H2.94098V27.825ZM23.654 12.532H18.234V7.112H23.654V12.532ZM7.87698 7.112H13.3V17.468H23.654V22.888H7.87698V7.112ZM45.294 2.175C42.7574 2.175 40.2778 2.92718 38.1688 4.33641C36.0597 5.74564 34.4159 7.74863 33.4452 10.0921C32.4745 12.4356 32.2206 15.0142 32.7154 17.502C33.2103 19.9898 34.4317 22.275 36.2253 24.0686C38.0189 25.8623 40.3041 27.0837 42.7919 27.5786C45.2798 28.0734 47.8584 27.8195 50.2019 26.8488C52.5454 25.8781 54.5483 24.2343 55.9576 22.1252C57.3668 20.0161 58.119 17.5365 58.119 15C58.115 11.5998 56.7625 8.34004 54.3582 5.93575C51.9539 3.53145 48.6942 2.17897 45.294 2.175V2.175ZM45.294 22.888C43.7339 22.888 42.2088 22.4254 40.9116 21.5586C39.6145 20.6919 38.6034 19.46 38.0064 18.0186C37.4094 16.5773 37.2532 14.9913 37.5575 13.4611C37.8619 11.931 38.6132 10.5255 39.7163 9.42234C40.8195 8.31919 42.225 7.56793 43.7551 7.26357C45.2852 6.95921 46.8712 7.11542 48.3126 7.71244C49.7539 8.30946 50.9859 9.32049 51.8526 10.6177C52.7194 11.9148 53.182 13.4399 53.182 15C53.1788 17.0911 52.3467 19.0956 50.8681 20.5742C49.3895 22.0528 47.385 22.8848 45.294 22.888V22.888ZM104.013 2.175C101.476 2.17481 98.9967 2.92681 96.8875 4.33592C94.7783 5.74503 93.1344 7.74795 92.1635 10.0914C91.1927 12.4348 90.9385 15.0136 91.4333 17.5014C91.928 19.9893 93.1494 22.2746 94.943 24.0683C96.7365 25.862 99.0217 27.0836 101.51 27.5785C103.997 28.0734 106.576 27.8195 108.92 26.8489C111.263 25.8782 113.266 24.2344 114.675 22.1253C116.085 20.0162 116.837 17.5366 116.837 15C116.833 11.6 115.481 8.34036 113.077 5.9361C110.673 3.53183 107.413 2.17924 104.013 2.175V2.175ZM104.013 22.888C102.453 22.8882 100.928 22.4257 99.6304 21.5591C98.3331 20.6925 97.3219 19.4606 96.7247 18.0193C96.1275 16.578 95.9712 14.9919 96.2754 13.4617C96.5797 11.9316 97.3309 10.526 98.434 9.4227C99.5371 8.31944 100.943 7.56808 102.473 7.26364C104.003 6.9592 105.589 7.11535 107.03 7.71235C108.472 8.30934 109.704 9.32036 110.571 10.6176C111.437 11.9148 111.9 13.4399 111.9 15C111.897 17.0909 111.065 19.0952 109.586 20.5738C108.108 22.0524 106.104 22.8846 104.013 22.888V22.888ZM74.653 2.175C72.1164 2.175 69.6368 2.92718 67.5278 4.33641C65.4187 5.74564 63.7749 7.74863 62.8042 10.0921C61.8335 12.4356 61.5796 15.0142 62.0744 17.502C62.5693 19.9898 63.7907 22.275 65.5843 24.0686C67.3779 25.8623 69.6631 27.0837 72.1509 27.5786C74.6387 28.0734 77.2174 27.8195 79.5609 26.8488C81.9044 25.8781 83.9073 24.2343 85.3166 22.1252C86.7258 20.0161 87.478 17.5365 87.478 15C87.474 11.5998 86.1215 8.34004 83.7172 5.93575C81.3129 3.53145 78.0532 2.17897 74.653 2.175ZM74.653 22.888C73.1994 22.8887 71.774 22.4878 70.5339 21.7295C69.2939 20.9712 68.2874 19.8851 67.6257 18.5909C66.9641 17.2967 66.6728 15.8448 66.7842 14.3956C66.8956 12.9463 67.4052 11.556 68.2569 10.3781C69.1086 9.20026 70.2692 8.28061 71.6105 7.72071C72.9519 7.1608 74.4219 6.98242 75.8582 7.20524C77.2946 7.42807 78.6414 8.04343 79.7501 8.98342C80.8588 9.9234 81.6862 11.1515 82.141 12.532H74.653V17.468H82.141C81.6201 19.0433 80.6165 20.4147 79.2724 21.3875C77.9284 22.3604 76.3122 22.8853 74.653 22.888V22.888Z" class="ccustom" fill="#394149"></path> </svg>
|
||||||
|
After Width: | Height: | Size: 3.2 KiB |
1
docs/content/reference/norgbackupweb/main.css
Normal file
1
docs/content/reference/norgbackupweb/main.css
Normal file
File diff suppressed because one or more lines are too long
BIN
docs/content/reference/norgbackupweb/norg-logo.png
Normal file
BIN
docs/content/reference/norgbackupweb/norg-logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.2 KiB |
50
docs/content/reference/norgbackupweb/norg-logo.svg
Normal file
50
docs/content/reference/norgbackupweb/norg-logo.svg
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||||
|
|
||||||
|
<svg
|
||||||
|
width="19.99361mm"
|
||||||
|
height="7.6532798mm"
|
||||||
|
viewBox="0 0 19.99361 7.6532798"
|
||||||
|
version="1.1"
|
||||||
|
id="svg1"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg">
|
||||||
|
<sodipodi:namedview
|
||||||
|
id="namedview1"
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1.0"
|
||||||
|
inkscape:showpageshadow="2"
|
||||||
|
inkscape:pageopacity="0.0"
|
||||||
|
inkscape:pagecheckerboard="0"
|
||||||
|
inkscape:deskcolor="#d1d1d1"
|
||||||
|
inkscape:document-units="mm" />
|
||||||
|
<defs
|
||||||
|
id="defs1">
|
||||||
|
<rect
|
||||||
|
x="76.577263"
|
||||||
|
y="161.08498"
|
||||||
|
width="580.76581"
|
||||||
|
height="240.47597"
|
||||||
|
id="rect1" />
|
||||||
|
</defs>
|
||||||
|
<g
|
||||||
|
inkscape:label="Layer 1"
|
||||||
|
inkscape:groupmode="layer"
|
||||||
|
id="layer1"
|
||||||
|
transform="translate(-20.824568,-47.088397)">
|
||||||
|
<text
|
||||||
|
xml:space="preserve"
|
||||||
|
transform="scale(0.26458333)"
|
||||||
|
id="text1"
|
||||||
|
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:40px;line-height:1.25;font-family:'Bauhaus 93';-inkscape-font-specification:'Bauhaus 93, ';letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect1);fill:#000000;fill-opacity:1;stroke:none"
|
||||||
|
inkscape:export-filename="norg-logo.svg"
|
||||||
|
inkscape:export-xdpi="190.56087"
|
||||||
|
inkscape:export-ydpi="190.56087"><tspan
|
||||||
|
x="76.578125"
|
||||||
|
y="197.8547"
|
||||||
|
id="tspan2">norg</tspan></text>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.6 KiB |
1
docs/content/reference/norgbackupweb/norg.css
Normal file
1
docs/content/reference/norgbackupweb/norg.css
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
a:link{color:green}a:visited{color:#006400}a:hover{color:#90ee90}main a:link{text-decoration:underline}main nav a:link{text-decoration:none}main p>code,main a>code{background:lightgrey;padding:2px;border-radius:5px}footer{padding:1rem;text-align:right}
|
||||||
|
|
@ -0,0 +1,186 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Command Line Reference </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Command Line Reference</h1>
|
||||||
|
|
||||||
|
<p>Here are the available norg command line parameters for the most recent version.
|
||||||
|
If you are using an older version of norg some of these parameters may not work.
|
||||||
|
Please use <code>norg --help</code> to view all available parameters in your version.</p>
|
||||||
|
<pre data-lang="help" style="background-color:#eff1f5;color:#4f5b66;" class="language-help "><code class="language-help" data-lang="help"><span>Norg
|
||||||
|
</span><span>A portable borg backup wrapper utility
|
||||||
|
</span><span>
|
||||||
|
</span><span>Usage:
|
||||||
|
</span><span> [options] [command] [further_args ...]
|
||||||
|
</span><span>
|
||||||
|
</span><span>Arguments:
|
||||||
|
</span><span> [command] The command to run, defaults to 'create' which will perform a backup. (default: create)
|
||||||
|
</span><span> [further_args ...]
|
||||||
|
</span><span> Any further arguments to send onto borg or restic.
|
||||||
|
</span><span>
|
||||||
|
</span><span>Options:
|
||||||
|
</span><span> -h, --help
|
||||||
|
</span><span> -c, --config=CONFIG Config file to use.
|
||||||
|
</span><span> -d, --destination=DESTINATION
|
||||||
|
</span><span> Destination when extracting backup
|
||||||
|
</span><span> -r, --repository=REPOSITORY
|
||||||
|
</span><span> Define an explicit repository to work on by either label or path.
|
||||||
|
</span><span> -a, --archive=ARCHIVE The archive or snapshot to operate on
|
||||||
|
</span><span> -s, --stats Provides statistics at the end of a backup (Borg only)
|
||||||
|
</span></code></pre>
|
||||||
|
<p>The <code>-c</code>, or <code>--config</code>, parameter is required. Failing to provide this will only show the above help information.</p>
|
||||||
|
<p>When specifying the <code>-r</code> or <code>--repository</code> parameter, you can specify either
|
||||||
|
the <code>label</code> or <code>path</code> for the repository defined in the configuration file.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,245 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Example Configuration </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Example Configuration</h1>
|
||||||
|
|
||||||
|
<p>Below is an example configuration in <a href="https://toml.io"><code>toml</code></a> format which can be used as a base for setting up a new norg backup.</p>
|
||||||
|
<pre data-lang="toml" style="background-color:#eff1f5;color:#4f5b66;" class="language-toml "><code class="language-toml" data-lang="toml"><span style="color:#a7adba;"># Defines what folders you would like to back up
|
||||||
|
</span><span style="color:#bf616a;">source_directories </span><span>= [
|
||||||
|
</span><span> "</span><span style="color:#a3be8c;">/home/me</span><span>",
|
||||||
|
</span><span> "</span><span style="color:#a3be8c;">/opt/other_things</span><span>"
|
||||||
|
</span><span>]
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Defines your backup repository/repositories
|
||||||
|
</span><span>[[repositories]]
|
||||||
|
</span><span style="color:#bf616a;">label </span><span>= "</span><span style="color:#a3be8c;">LocalBorgBackup</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">path </span><span>= "</span><span style="color:#a3be8c;">/path/to/backup</span><span>"
|
||||||
|
</span><span style="color:#a7adba;"># You can define to backup tool here, default is "borg"
|
||||||
|
</span><span style="color:#bf616a;">tool </span><span>= "</span><span style="color:#a3be8c;">borg</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># You can add more repositories of varying types.
|
||||||
|
</span><span style="color:#a7adba;"># When defining multiple repositories, a new backup will run for each repository
|
||||||
|
</span><span style="color:#a7adba;"># defined.
|
||||||
|
</span><span>[[repositories]]
|
||||||
|
</span><span style="color:#bf616a;">label </span><span>= "</span><span style="color:#a3be8c;">RemoteBorgBase</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">path </span><span>= "</span><span style="color:#a3be8c;">ssh://1234abcd@1234abcd.repo.borgbase.com/./repo</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">tool </span><span>= "</span><span style="color:#a3be8c;">borg</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span>[[repositories]]
|
||||||
|
</span><span style="color:#bf616a;">label </span><span>= "</span><span style="color:#a3be8c;">LocalResticBackup</span><span style="background-color:#bf616a;color:#eff1f5;">
|
||||||
|
</span><span style="color:#bf616a;">path </span><span>= "</span><span style="color:#a3be8c;">/path/to/another/backup</span><span>"
|
||||||
|
</span><span style="color:#a7adba;"># You can define restic as a backup tool
|
||||||
|
</span><span style="color:#bf616a;">tool </span><span>= "</span><span style="color:#a3be8c;">restic</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Defines encryption information i.e. backup encryption passphrase
|
||||||
|
</span><span style="color:#a7adba;"># If a passphrase is not set or is incorrect, borg/restic will prompt you for one
|
||||||
|
</span><span style="color:#a7adba;"># which is likely to cause your backups to not run.
|
||||||
|
</span><span>[encryption]
|
||||||
|
</span><span style="color:#a7adba;"># Set a string variable for the passphrase
|
||||||
|
</span><span style="color:#bf616a;">encryption_passphrase </span><span>= "</span><span style="color:#a3be8c;">MyVeryS3curePassphrase!</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Get the passphrase from the result of a command
|
||||||
|
</span><span style="color:#a7adba;"># encryption_passcommand = "cat my_passphrase.txt"
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># These actions can be configured to run scripts (i.e. back up a database)
|
||||||
|
</span><span style="color:#a7adba;"># at various times throughout the running process
|
||||||
|
</span><span>[actions]
|
||||||
|
</span><span style="color:#a7adba;"># "everything" means before or after every possible option for all repositories
|
||||||
|
</span><span style="color:#bf616a;">before_everything </span><span>= ["</span><span style="color:#a3be8c;">echo before everything</span><span>"]
|
||||||
|
</span><span style="color:#bf616a;">after_everything </span><span>= ["</span><span style="color:#a3be8c;">echo after everything</span><span>"]
|
||||||
|
</span><span style="color:#a7adba;"># "actions" means before any action, per repository
|
||||||
|
</span><span style="color:#bf616a;">before_actions </span><span>= ["</span><span style="color:#a3be8c;">echo before actions</span><span>"]
|
||||||
|
</span><span style="color:#bf616a;">after_actions </span><span>= ["</span><span style="color:#a3be8c;">echo after actions</span><span>"]
|
||||||
|
</span><span style="color:#a7adba;"># before or after the backup process per repository
|
||||||
|
</span><span style="color:#bf616a;">before_backup </span><span>= ["</span><span style="color:#a3be8c;">echo before backup</span><span>"]
|
||||||
|
</span><span style="color:#bf616a;">after_backup </span><span>= ["</span><span style="color:#a3be8c;">echo after backup</span><span>"]
|
||||||
|
</span><span style="color:#a7adba;"># before or after the extract process per repository
|
||||||
|
</span><span style="color:#bf616a;">before_extract </span><span>= ["</span><span style="color:#a3be8c;">echo before extract</span><span>"]
|
||||||
|
</span><span style="color:#bf616a;">after_extract </span><span>= ["</span><span style="color:#a3be8c;">echo after extract</span><span>"]
|
||||||
|
</span><span style="color:#a7adba;"># before or after the prune process per repository
|
||||||
|
</span><span style="color:#bf616a;">before_prune </span><span>= ["</span><span style="color:#a3be8c;">echo before prune</span><span>"]
|
||||||
|
</span><span style="color:#bf616a;">after_prune </span><span>= ["</span><span style="color:#a3be8c;">echo after prune</span><span>"]
|
||||||
|
</span><span style="color:#a7adba;"># before or after the compact process per respository
|
||||||
|
</span><span style="color:#bf616a;">before_compact </span><span>= ["</span><span style="color:#a3be8c;">echo before compact</span><span>"]
|
||||||
|
</span><span style="color:#bf616a;">after_compact </span><span>= ["</span><span style="color:#a3be8c;">echo after compact</span><span>"]
|
||||||
|
</span><span style="color:#a7adba;"># before or after the check processs per repository
|
||||||
|
</span><span style="color:#bf616a;">before_check </span><span>= ["</span><span style="color:#a3be8c;">echo before check</span><span>"]
|
||||||
|
</span><span style="color:#bf616a;">after_check </span><span>= ["</span><span style="color:#a3be8c;">echo after check</span><span>"]
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Send a status update to Uptime Kuma
|
||||||
|
</span><span style="color:#a7adba;"># more status monitor tools are planned to be supported in the future
|
||||||
|
</span><span>[uptimekuma]
|
||||||
|
</span><span style="color:#a7adba;"># The base/push url of your Uptime Kuma monitor - without the query string.
|
||||||
|
</span><span style="color:#a7adba;"># The query string will be generated at run time and will change dependant on the state of your backup.
|
||||||
|
</span><span style="color:#bf616a;">base_url </span><span>= "</span><span style="color:#a3be8c;">https://uptime.kuma.url/api/push/1234abcd</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># what backup states you wish to send an alert for, defaults to Success, Failure and Running
|
||||||
|
</span><span style="color:#bf616a;">states </span><span>= ["</span><span style="color:#a3be8c;">Success</span><span>","</span><span style="color:#a3be8c;">Failure</span><span>", "</span><span style="color:#a3be8c;">Running</span><span>"]
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Set locations of the borg or restic binaries if you need to.
|
||||||
|
</span><span style="color:#a7adba;"># Norg will check some common locations and use the first one it finds, but
|
||||||
|
</span><span style="color:#a7adba;"># if you have them installed in a non-standard location, set that location here
|
||||||
|
</span><span>[binaries]
|
||||||
|
</span><span style="color:#bf616a;">borg_bin </span><span>= "</span><span style="color:#a3be8c;">/usr/local/bin/borg</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">restic_bin </span><span>= "</span><span style="color:#a3be8c;">/usr/local/bin/restic</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Logging configuration - will output to console
|
||||||
|
</span><span>[logging]
|
||||||
|
</span><span style="color:#a7adba;"># Log level options are below, each option includes the logs from the one before it
|
||||||
|
</span><span style="color:#a7adba;"># "notice", "info", "warn", "error", "fatal", "debug"
|
||||||
|
</span><span style="color:#bf616a;">log_level </span><span>= "</span><span style="color:#a3be8c;">info</span><span>"
|
||||||
|
</span></code></pre>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
166
docs/content/reference/norgbackupweb/reference/index.html
Normal file
166
docs/content/reference/norgbackupweb/reference/index.html
Normal file
|
|
@ -0,0 +1,166 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Reference Guides </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1></h1>
|
||||||
|
|
||||||
|
<h2 class="title"> Reference Guides </h2>
|
||||||
|
|
||||||
|
<h3>Pages:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a></li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
4
docs/content/reference/norgbackupweb/robots.txt
Normal file
4
docs/content/reference/norgbackupweb/robots.txt
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
User-agent: *
|
||||||
|
Disallow:
|
||||||
|
Allow: /
|
||||||
|
Sitemap: https://norgbackup.net/sitemap.xml
|
||||||
1
docs/content/reference/norgbackupweb/search_index.en.js
Normal file
1
docs/content/reference/norgbackupweb/search_index.en.js
Normal file
File diff suppressed because one or more lines are too long
70
docs/content/reference/norgbackupweb/sitemap.xml
Normal file
70
docs/content/reference/norgbackupweb/sitemap.xml
Normal file
|
|
@ -0,0 +1,70 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/contributing/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/contributing/contributing/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/download/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/download/download-norg/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/introduction/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/introduction/about-norg/</loc>
|
||||||
|
<lastmod>2024-08-24T13:00:00</lastmod>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/introduction/system-compatibility/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/reference/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/reference/command-line/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/reference/example-configuration/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/before-and-after-actions/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/both-borg-and-restic/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/configuration/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/create-a-backup/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/extract-a-backup/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/initialize/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/inspect-your-backups/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/monitoring-backup-jobs/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/redundancy/</loc>
|
||||||
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://norgbackup.net/usage/setup/</loc>
|
||||||
|
</url>
|
||||||
|
</urlset>
|
||||||
|
|
@ -0,0 +1,180 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Before and After Actions </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Before and After Actions</h1>
|
||||||
|
|
||||||
|
<p>Norg has the ability to run other commands before and after various points
|
||||||
|
during its running session.<br />
|
||||||
|
These times are as follows:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>before_everything</code> - Runs before anything else happens, just after starting.</li>
|
||||||
|
<li><code>after_everything</code> - Runs after everything has happened, just before closing.</li>
|
||||||
|
<li><code>before_actions</code> - Runs before any action for each repository.</li>
|
||||||
|
<li><code>after_actions</code> - Runs after any action for each repository.</li>
|
||||||
|
<li><code>before_backup</code> - Runs before each backup for each repository.</li>
|
||||||
|
<li><code>after_backup</code> - Runs after each backup for each repository.</li>
|
||||||
|
<li><code>before_extract</code> - Runs before an extract.</li>
|
||||||
|
<li><code>after_extract</code> - Runs after an extract.</li>
|
||||||
|
<li><code>before_prune</code> - Runs before a prune job (when run manually).</li>
|
||||||
|
<li><code>after_prune</code> - Runs after a prune job (when run manually).</li>
|
||||||
|
<li><code>before_compact</code> - Runs before a compact action, for each repository.</li>
|
||||||
|
<li><code>after_compact</code> - Runs after a compact aciton, for each repository.</li>
|
||||||
|
<li><code>before_check</code> - Runs before a check action, for each repository.</li>
|
||||||
|
<li><code>after_check</code> - Runs after a check action, for each repository.</li>
|
||||||
|
</ul>
|
||||||
|
<p>The general use here is to run a database backup/dump to store a database
|
||||||
|
backup file in a location that is then backed up, but could be used for other things.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,186 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Using both Borg and Restic </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Using both Borg and Restic</h1>
|
||||||
|
|
||||||
|
<p>Allowances have been made to be able to use both Borg and Restic repositories
|
||||||
|
for the same backup in one configuration file, and this will largely work
|
||||||
|
correctly. However, caution must be taken when using any direct Borg/Restic
|
||||||
|
command line parameters as they could cause either backup tool to fail as it
|
||||||
|
does not understand the parameter given.</p>
|
||||||
|
<p>A good example of this is the <code>--stats</code> parameter. Borg understands this and
|
||||||
|
outputs backup stats when its backup has completed. However, Restic does not
|
||||||
|
have a <code>--stats</code> parameter and fails to run when it is provided.</p>
|
||||||
|
<p>Since <code>Norg version 0.1.6</code>, we have taken steps to ignore the <code>--stats</code> parameter
|
||||||
|
when provided for restic repositories, so it will work correctly. However,
|
||||||
|
other parameters could cause a similar effect. We shall try to cater for these
|
||||||
|
as they are learned about. Please file an issue on our <a href="https://codeberg.org/pswilde/norgbackup/issues">Codeberg Repo</a> if you discover a parameter which causes either backup tool to fail to run.</p>
|
||||||
|
<h2 id="aliased-commands">Aliased Commands</h2>
|
||||||
|
<p>Terminology in both Borg and Restic differs, but the result is effectively the same.
|
||||||
|
Some different yet similar commands are aliased so they can be used interchangeably.
|
||||||
|
The table below shows some of these:</p>
|
||||||
|
<table><thead><tr><th>Borg Command</th><th>Restic Command</th><th>Result</th></tr></thead><tbody>
|
||||||
|
<tr><td>create</td><td>backup</td><td>creates a backup</td></tr>
|
||||||
|
<tr><td>list</td><td>snapshots</td><td>lists archives/snapshots</td></tr>
|
||||||
|
<tr><td>extract</td><td>restore</td><td>restores/extracts a backup</td></tr>
|
||||||
|
<tr><td>delete</td><td>forget</td><td>removes a archive/snapshot</td></tr>
|
||||||
|
<tr><td>prune</td><td>forget (with --prune flag)</td><td>removes snapshots as per <code>--keep-*</code> config</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p>You may specify either command and it will work with both except the <code>forget</code> command. This will only forget a single snapshot in restic, and delete a single archive with borg.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,174 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Configuring Norg </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Configuring Norg</h1>
|
||||||
|
|
||||||
|
<p>Norg is configured using a <a href="https://toml.io">TOML</a> format configuration file.<br />
|
||||||
|
There is an <a href="/reference/example-configuration">Example Configuration File</a> on the norgbackup website that you can use as a base to create your own backups.</p>
|
||||||
|
<h2 id="many-backups-from-one-system">Many backups from one system</h2>
|
||||||
|
<p>You can run multiple different backups on the same system by specifying different
|
||||||
|
configuration files using the <code>-c</code> <a href="/reference/command-line">command line parameter</a>.</p>
|
||||||
|
<h2 id="scheduling">Scheduling</h2>
|
||||||
|
<p>Norg can be scheduled to run using your system's task scheduler. For the sake of
|
||||||
|
this example, we are using <code>cron</code> to run a backups every day at 8pm and 10pm.</p>
|
||||||
|
<pre data-lang="ini" style="background-color:#eff1f5;color:#4f5b66;" class="language-ini "><code class="language-ini" data-lang="ini"><span style="color:#d08770;">0 20 </span><span>* * * norg -c /home/me/myconfig.toml
|
||||||
|
</span><span style="color:#d08770;">0 22 </span><span>* * * norg -c /home/me/myotherbackup.toml
|
||||||
|
</span></code></pre>
|
||||||
|
<p>This concept should be transferrable to any other scheduling tool.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,176 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Create a Backup </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Create a Backup</h1>
|
||||||
|
|
||||||
|
<p>Now norg is configured and your repositories are created and initialized, it's
|
||||||
|
sensible to test everything is working. Run norg with the <code>create</code> command to start a backup like this:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">norg -c</span><span> myconfig.toml create</span><span style="color:#bf616a;"> --stats
|
||||||
|
</span></code></pre>
|
||||||
|
<p>As the command runs, you should check the output of borg or restic to see if files
|
||||||
|
you expect to be backed up are being backed up.<br />
|
||||||
|
The <code>--stats</code> flag provides statistics of a borg backup once completed. It is
|
||||||
|
ignored for Restic backups.<br />
|
||||||
|
The <code>-c</code> or <code>--config</code> option is required, and must reference a norg configuration file.</p>
|
||||||
|
<h2 id="default-options">Default Options</h2>
|
||||||
|
<p>If you do not specify <code>create</code>, or any other option, norg will default to the <code>create</code> option anyway, so the above command can be simplified as so:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">norg -c</span><span> myconfig.toml
|
||||||
|
</span></code></pre>
|
||||||
|
<p>With Restic, the terminology for creating a snapshot is <code>backup</code>. Norg has both <code>create</code> and <code>backup</code> as aliases to each other, so either will work as desired.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,197 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Extract/Restore a Backup </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Extract/Restore a Backup</h1>
|
||||||
|
|
||||||
|
<blockquote>
|
||||||
|
<p><em>"People don't want backups. People want Restores."</em></p>
|
||||||
|
</blockquote>
|
||||||
|
<p>What's the point in backing up if you can't restore from it?<br />
|
||||||
|
Of course, Norg has a restore functionality, and can restore an entire backup to
|
||||||
|
a directory of your choice.<br />
|
||||||
|
To protect current data, Norg will only restore to an empty directory, so it is
|
||||||
|
important to specify a directory that is empty. Norg will create directories that
|
||||||
|
do not exist.</p>
|
||||||
|
<h2 id="steps">Steps</h2>
|
||||||
|
<p>First, find the backup you wish to restore. This can easily be done by using
|
||||||
|
the <a href="http://127.0.0.1:1111/usage/inspect-your-backups#list-existing-backups"><code>list</code></a> command.</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">norg -c</span><span> myconfig.toml list
|
||||||
|
</span></code></pre>
|
||||||
|
<p>Which will give you an output similar to this:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#a7adba;"># For Borg
|
||||||
|
</span><span style="color:#bf616a;">hostname-2024-08-23T15:46:19.037234</span><span> Fri, 2024-08-23 15:46:19
|
||||||
|
</span><span style="color:#bf616a;">hostname-2024-08-24T15:21:17.738163</span><span> Sat, 2024-08-24 15:21:18
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># or for Restic
|
||||||
|
</span><span style="color:#bf616a;">ID</span><span> Time Host Paths Size
|
||||||
|
</span><span style="color:#bf616a;">---------------------------------------------------------------
|
||||||
|
</span><span style="color:#bf616a;">5f2bc4f1</span><span> 2024-08-23 10:30:25 hostname /home/me 96.361 MiB
|
||||||
|
</span><span style="color:#bf616a;">e0de9b6c</span><span> 2024-08-24 11:50:52 hostname /home/me 94.123 MiB
|
||||||
|
</span></code></pre>
|
||||||
|
<p>When you know which archive or snapshot you want to extract, you can run the
|
||||||
|
<code>extract</code> command with <code>repository</code>, <code>archive</code> and <code>destination</code> parameters.</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#a7adba;"># Borg example
|
||||||
|
</span><span style="color:#bf616a;">norg -c</span><span> myconfig.toml extract</span><span style="color:#bf616a;"> -r</span><span> MyBorgRepo</span><span style="color:#bf616a;"> -a</span><span> hostname-2024-08-23T15:46:19.037234</span><span style="color:#bf616a;"> --destination</span><span> /my/restore/location
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Restic example
|
||||||
|
</span><span style="color:#bf616a;">norg -c</span><span> myconfig.toml extract</span><span style="color:#bf616a;"> -r</span><span> MyResticRepo</span><span style="color:#bf616a;"> -a</span><span> 5f2bc4f1</span><span style="color:#bf616a;"> --destination</span><span> /my/restore/location
|
||||||
|
</span></code></pre>
|
||||||
|
<h2 id="further-command-line-reference">Further Command Line Reference</h2>
|
||||||
|
<p>Like with all other commands, you can specify Borg/Restic command line parameters after all other parameters to adjust how the extract will run. Please see <a href="/usage/both-borg-and-restic/">Using both Borg and Restic</a> for more information.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
174
docs/content/reference/norgbackupweb/usage/index.html
Normal file
174
docs/content/reference/norgbackupweb/usage/index.html
Normal file
|
|
@ -0,0 +1,174 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Usage </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1></h1>
|
||||||
|
|
||||||
|
<h2 class="title"> Usage </h2>
|
||||||
|
|
||||||
|
<h3>Pages:</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://norgbackup.net/usage/setup/">Setting up Norg</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a></li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
168
docs/content/reference/norgbackupweb/usage/initialize/index.html
Normal file
168
docs/content/reference/norgbackupweb/usage/initialize/index.html
Normal file
|
|
@ -0,0 +1,168 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Initialize Repositories </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Initialize Repositories</h1>
|
||||||
|
|
||||||
|
<p>Your backup repositories need to be initialized before they can be used. Norg
|
||||||
|
has a command to do this for you once you.<br />
|
||||||
|
To initialize your repositories one by one, you can run the following command:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">norg -c</span><span> myconfig.toml init</span><span style="color:#bf616a;"> -e</span><span> repokey-blake2
|
||||||
|
</span></code></pre>
|
||||||
|
<p>This will initialize a Borg repository using the <code>repokey-blake2</code> encryption algorithm, making it ready for use.</p>
|
||||||
|
<p>Restic does not use the same encryption algorithm option, so the above command may fail. However, running the below command again, without the <code>-e repokey-blake2</code> option
|
||||||
|
will initialize a Restic repository correctly, leaving the borg repository untouched.</p>
|
||||||
|
<p><strong>TODO</strong>: We plan to resolve the requirement of running this command twice in the future.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,198 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Inspect your Backups </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Inspect your Backups</h1>
|
||||||
|
|
||||||
|
<p>The output of a backup will be shown in your terminal if running manually.
|
||||||
|
You could output this into a log file if you wish, like so:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">norg -c</span><span> myconfig.toml</span><span style="color:#bf616a;"> --stats </span><span>>> mybackup.log
|
||||||
|
</span></code></pre>
|
||||||
|
<p>This is great for letting you know some basic information about your backup.</p>
|
||||||
|
<h2 id="list-existing-backups">List Existing Backups</h2>
|
||||||
|
<p>Norg provides command line parameters to allow you to list your backups for all
|
||||||
|
or specific repositories.</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#a7adba;"># List all archives/snapshots on all repositories
|
||||||
|
</span><span style="color:#bf616a;">norg -c</span><span> myconfig.toml list
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># List all archives/snapshots on a specific repository
|
||||||
|
</span><span style="color:#bf616a;">norg -c</span><span> myconfig.toml list</span><span style="color:#bf616a;"> -r</span><span> MyRepository
|
||||||
|
</span></code></pre>
|
||||||
|
<p>When specifying the <code>-r</code> or <code>--repository</code> parameter, you can specify either
|
||||||
|
the <code>label</code> or <code>path</code> for the repository defined in the configuration file.</p>
|
||||||
|
<p>You can also specify further <a href="/usage/both-borg-and-restic#further-args">Borg or Restic command line options</a>
|
||||||
|
(like <code>--last 3</code> to show the last 3 archives in a Borg repository). It is advised to
|
||||||
|
<em>always</em> use the <code>-r</code> parameter in these cases as specifc flags for Borg do not
|
||||||
|
work with Restic and vice-versa.</p>
|
||||||
|
<h2 id="mount-a-backup">Mount a Backup</h2>
|
||||||
|
<p>Both Borg and Restic provide the ability to mount an archive (Borg) or repository (Restic) so you can inspect and recover individual files this way. Norg provides the ability to do this via the below command:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#a7adba;"># For Borg repositories, where we mount an Archive
|
||||||
|
</span><span style="color:#bf616a;">norg -c</span><span> myconfig.toml mount</span><span style="color:#bf616a;"> -r</span><span> MyBorgRepository</span><span style="color:#bf616a;"> -a</span><span> hostname-date-of-backup /path/to/mount/point
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># For Restic repositories, where we mount the entire repository
|
||||||
|
</span><span style="color:#bf616a;">norg -c</span><span> myconfig.toml mount</span><span style="color:#bf616a;"> -r</span><span> MyResticRepository /path/to/mount/point
|
||||||
|
</span></code></pre>
|
||||||
|
<p>It is sensible to always provide the <code>-r</code> parameter as you will not be able to mount multiple archive/repositories to the same location.</p>
|
||||||
|
<h3 id="unmount-a-backup">Unmount a Backup</h3>
|
||||||
|
<p>Unmounting a backup is different for both Borg and Restic.<br />
|
||||||
|
Borg has a <code>umount</code> command which can be run via norg as follows:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">norg -c</span><span> myconfig.toml umount /path/to/mount/point
|
||||||
|
</span></code></pre>
|
||||||
|
<p>Restic however, remains running after a <code>mount</code> command has been issues, and awaits
|
||||||
|
<code>Ctrl+C</code> keyboard entry to unmount. In short, there is no <code>umount</code> command for Restic.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,211 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Knowing your Backup has Run </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Knowing your Backup has Run</h1>
|
||||||
|
|
||||||
|
<p>Great, we have backups set up and running automatically, but how do we know
|
||||||
|
they're running successfully?<br />
|
||||||
|
Well, Norg can interact with monitoring tools to let you know backups are running...
|
||||||
|
Or, probably more accuractely, when they fail.</p>
|
||||||
|
<p>Currently only <a href="https://uptime.kuma.pet">Uptime Kuma</a> is supported, but it would be
|
||||||
|
possible to connect to many other types of monitoring service by creating a new <code>notifiers/{notifier_name}.nim</code> codefile and linking it all up.</p>
|
||||||
|
<h2 id="supported-monitoring-tools">Supported Monitoring Tools</h2>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://norgbackup.net/usage/monitoring-backup-jobs/#uptime-kuma">Uptime Kuma</a></li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/monitoring-backup-jobs/#ntfy">Ntfy</a> - Planned, Not implemented yet.</li>
|
||||||
|
<li><a href="https://norgbackup.net/usage/monitoring-backup-jobs/#healthchecks-io">Healthchecks.io</a> - Planned, Not implemented yet.</li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="uptime-kuma">Uptime Kuma</h3>
|
||||||
|
<p>Uptime Kuma is a self-hosted monitoring tool. It's generally used to call <em>out</em> to
|
||||||
|
a service or server every minute to check it is running. But, it does have the option
|
||||||
|
of a "Push" type of monitor, which waits for a service to make a <code>HTTP GET</code> request to it, and reports on the status of that request, or if that request is missed within a timeframe.<br />
|
||||||
|
Some basic Uptime Kuma Settings for a backup job would be as follows:</p>
|
||||||
|
<pre data-lang="ini" style="background-color:#eff1f5;color:#4f5b66;" class="language-ini "><code class="language-ini" data-lang="ini"><span style="color:#a7adba;"># These are to be entered into Uptime Kuma and not into your Norg
|
||||||
|
</span><span style="color:#a7adba;"># configuration.
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Push monitors wait for the client to contact Uptime Kuma instead of Uptime
|
||||||
|
</span><span style="color:#a7adba;"># Kuma contacting the client. This is perfect for backup monitoring.
|
||||||
|
</span><span style="color:#bf616a;">Monitor </span><span>Type = Push
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#bf616a;">Heartbeat </span><span>Interval = </span><span style="color:#d08770;">90000 </span><span style="color:#a7adba;"># = 25 hours = 1 day + 1 hour
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Wait 6 times the Heartbeat Retry (below) before logging a heartbeat missed.
|
||||||
|
</span><span style="color:#bf616a;">Retries </span><span>= </span><span style="color:#d08770;">6
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># Multiplied by Retries this gives a grace period within which the monitor
|
||||||
|
</span><span style="color:#a7adba;"># goes into the "Pending" state.
|
||||||
|
</span><span style="color:#bf616a;">Heartbeat </span><span>Retry = </span><span style="color:#d08770;">360 </span><span style="color:#a7adba;"># = 10 minutes
|
||||||
|
</span><span>
|
||||||
|
</span><span style="color:#a7adba;"># For each Heartbeat Interval if the backup fails repeatedly, a notification
|
||||||
|
</span><span style="color:#a7adba;"># is sent each time.
|
||||||
|
</span><span style="color:#bf616a;">Resend </span><span>Notification every X times = </span><span style="color:#d08770;">1
|
||||||
|
</span></code></pre>
|
||||||
|
<p>Your Norg configuration file should have an <code>uptimekuma</code> section as below</p>
|
||||||
|
<pre data-lang="toml" style="background-color:#eff1f5;color:#4f5b66;" class="language-toml "><code class="language-toml" data-lang="toml"><span style="background-color:#bf616a;color:#eff1f5;">...</span><span>
|
||||||
|
</span><span>[uptimekuma]
|
||||||
|
</span><span style="color:#bf616a;">base_url </span><span>= "</span><span style="color:#a3be8c;">https://uptime.kuma.example/api/push/abcd1234</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">states </span><span>= ["</span><span style="color:#a3be8c;">Success</span><span>", "</span><span style="color:#a3be8c;">Failure</span><span>", "</span><span style="color:#a3be8c;">Running</span><span>"]
|
||||||
|
</span></code></pre>
|
||||||
|
<p>This will make Norg request your Uptime Kuma service on <code>Running</code>, <code>Failure</code> and <code>Success</code> states. Uptime Kuma could then alert you about this change in state,
|
||||||
|
depending on how your Uptime Kuma is configured.</p>
|
||||||
|
<h3 id="ntfy">Ntfy</h3>
|
||||||
|
<p>Not implemented yet.</p>
|
||||||
|
<h3 id="healthchecks-io">Healthchecks.io</h3>
|
||||||
|
<p>Not implemented yet.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
188
docs/content/reference/norgbackupweb/usage/redundancy/index.html
Normal file
188
docs/content/reference/norgbackupweb/usage/redundancy/index.html
Normal file
|
|
@ -0,0 +1,188 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Backup Redundancy </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Backup Redundancy</h1>
|
||||||
|
|
||||||
|
<p>Norg has the ability to back up to multiple repositories using both the <a href="https://borgbackup.com">BorgBackup</a> or <a href="https://restic.net">Restic</a> backup utilities.<br />
|
||||||
|
To enable this, simply configure multiple different repositories in your configuration file and norg will take care of the rest.</p>
|
||||||
|
<p>For example, the <code>repositories</code> section of your configuration file may look like this:</p>
|
||||||
|
<pre data-lang="toml" style="background-color:#eff1f5;color:#4f5b66;" class="language-toml "><code class="language-toml" data-lang="toml"><span style="background-color:#bf616a;color:#eff1f5;">...</span><span>
|
||||||
|
</span><span>[[repositories]]
|
||||||
|
</span><span style="color:#bf616a;">label </span><span>= "</span><span style="color:#a3be8c;">MyFirstLocation</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">path </span><span>= "</span><span style="color:#a3be8c;">/location1</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span>[[repositories]]
|
||||||
|
</span><span style="color:#bf616a;">label </span><span>= "</span><span style="color:#a3be8c;">MySecondLocation</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">path </span><span>= "</span><span style="color:#a3be8c;">ssh://1234abcd@1234abcd.repo.borgbase.com/./repo</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span>[[repositories]]
|
||||||
|
</span><span style="color:#bf616a;">label </span><span>= "</span><span style="color:#a3be8c;">MyThirdLocationUsingRestic</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">path </span><span>= "</span><span style="color:#a3be8c;">/location3</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">tool </span><span>= "</span><span style="color:#a3be8c;">restic</span><span>"
|
||||||
|
</span><span>
|
||||||
|
</span><span>[[repositories]]
|
||||||
|
</span><span style="color:#bf616a;">label </span><span>= "</span><span style="color:#a3be8c;">MyFourthLocationUsingRestic</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">path </span><span>= "</span><span style="color:#a3be8c;">rest:https://5678zyxw:9090abab@5678zyxw.repo.borgbase.com</span><span>"
|
||||||
|
</span><span style="color:#bf616a;">tool </span><span>= "</span><span style="color:#a3be8c;">restic</span><span>"
|
||||||
|
</span><span style="background-color:#bf616a;color:#eff1f5;">...</span><span>
|
||||||
|
</span></code></pre>
|
||||||
|
<p>When running norg with this configuration, it invokes Borg or Restic once per
|
||||||
|
repository in sequence (i.e. not at the same time) which means in each
|
||||||
|
repository a new archive or snapshot is made containing all source directories.<br />
|
||||||
|
This provides redundancy across multiple backup repositories and across backup
|
||||||
|
tools. You could even configure multiple storage providers to gain redundancy
|
||||||
|
there as well.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
215
docs/content/reference/norgbackupweb/usage/setup/index.html
Normal file
215
docs/content/reference/norgbackupweb/usage/setup/index.html
Normal file
|
|
@ -0,0 +1,215 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/main.css">
|
||||||
|
<link rel="stylesheet" href="https://norgbackup.net/norg.css">
|
||||||
|
<link rel="icon" href="https://norgbackup.net/favicon.png">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||||
|
<title> Norg | Setting up Norg </title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<a href="https://norgbackup.net">
|
||||||
|
<img src="https://norgbackup.net/norg-logo.png" alt="logo"/>
|
||||||
|
</a>
|
||||||
|
<a href="javascript:void(0);" onclick="burger()" id="mobile" class="ms-Icon--GlobalNavButton"></a>
|
||||||
|
<div id="trees">
|
||||||
|
<input class="tree-toggle" type="checkbox" id="introduction"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="introduction">Introduction</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/about-norg/">About Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/introduction/system-compatibility/">System Compatibility</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="reference-guides"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="reference-guides">Reference Guides</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/example-configuration/">Example Configuration</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/reference/command-line/">Command Line Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="usage"
|
||||||
|
checked/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="usage">Usage</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li class="active">
|
||||||
|
<a href="https://norgbackup.net/usage/setup/">Setting up Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<ul id="toc">
|
||||||
|
<li><a href="
|
||||||
|
https://norgbackup.net/usage/setup/#prerequisites">Prerequisites</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="
|
||||||
|
https://norgbackup.net/usage/setup/#installation">Installation</a>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="https://norgbackup.net/usage/setup/#path-variable">PATH variable</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href="
|
||||||
|
https://norgbackup.net/usage/setup/#portability">Portability</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="
|
||||||
|
https://norgbackup.net/usage/setup/#upgrading-norg">Upgrading Norg</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/configuration/">Configuring Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/redundancy/">Backup Redundancy</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/initialize/">Initialize Repositories</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/create-a-backup/">Create a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/inspect-your-backups/">Inspect your Backups</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/monitoring-backup-jobs/">Knowing your Backup has Run</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/extract-a-backup/">Extract/Restore a Backup</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/before-and-after-actions/">Before and After Actions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/usage/both-borg-and-restic/">Using both Borg and Restic</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="download"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="download">Download</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/download/download-norg/">Download Norg</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<input class="tree-toggle" type="checkbox" id="contributing-to-norg"
|
||||||
|
/>
|
||||||
|
<label class="tree-toggle-label"
|
||||||
|
for="contributing-to-norg">Contributing to Norg</label>
|
||||||
|
|
||||||
|
<ul class="subtree">
|
||||||
|
<li >
|
||||||
|
<a href="https://norgbackup.net/contributing/contributing/">Contributing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<article>
|
||||||
|
|
||||||
|
<div id="on_right">
|
||||||
|
<span id="search-ico" class="ms-Icon--Search"></span>
|
||||||
|
</div>
|
||||||
|
<div class="search-container">
|
||||||
|
<input id="search" type="search" placeholder="Search as you type...">
|
||||||
|
<div class="search-results">
|
||||||
|
<div class="search-results__header"></div>
|
||||||
|
<ul class="search-results__items"></ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="wrap">
|
||||||
|
<h1>Setting up Norg</h1>
|
||||||
|
|
||||||
|
<h2 id="prerequisites">Prerequisites</h2>
|
||||||
|
<p>Install <a href="https://borgbackup.readthedocs.io/en/stable/installation.html">Borg</a> or <a href="https://restic.net/#installation">Restic</a> as these do not get installed automatically.</p>
|
||||||
|
<p>You will also need to install <a href="https://nim-lang.org">Nim v2</a> and <code>nimble</code></p>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://www.freebsd.org">FreeBSD</a> - <code>pkg install nimble</code></li>
|
||||||
|
<li><a href="https://archlinux.org">Arch Linux</a> - <code>pacman -S nimble</code></li>
|
||||||
|
<li>For other distros you may need to use the official <a href="https://nim-lang.org/install_unix.html"><code>choosenim</code> Installer</a> to get the latest version of nim installed.</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="installation">Installation</h2>
|
||||||
|
<p>Norg is listed on <a href="https://nimble.directory">Nimble Directory</a> so you can install
|
||||||
|
norg using nimble</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">nimble</span><span> install norg
|
||||||
|
</span></code></pre>
|
||||||
|
<p>or, if you'd rather not use the directory, you can install direct from our
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup">Codeberg Repo</a>:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#bf616a;">nimble</span><span> install https://codeberg.org/pswilde/norgbackup
|
||||||
|
</span></code></pre>
|
||||||
|
<h4 id="path-variable">PATH variable</h4>
|
||||||
|
<p>Once installed, <code>norg</code> will be installed in your <code>$HOME/.nimble/bin/</code> directory.
|
||||||
|
You should add this location to your <code>$PATH</code> variable so it can be found remains
|
||||||
|
up-to-date when running <code>nimble install norg</code> again.</p>
|
||||||
|
<h2 id="portability">Portability</h2>
|
||||||
|
<p>Norg is a single binary executable, so it can be copied wherever you need providing
|
||||||
|
it has been compiled in the required system and architecture beforehand.<br />
|
||||||
|
For example, I have multiple FreeBSD servers where I use Norg. I install the latest version on one of these servers, then just copy that binary to all others servers that
|
||||||
|
need to make use of it.</p>
|
||||||
|
<h2 id="upgrading-norg">Upgrading Norg</h2>
|
||||||
|
<p>Norg can be upgraded easily via nimble:</p>
|
||||||
|
<pre data-lang="sh" style="background-color:#eff1f5;color:#4f5b66;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#a7adba;"># Update nimble directory cache
|
||||||
|
</span><span style="color:#bf616a;">nimble</span><span> update
|
||||||
|
</span><span style="color:#a7adba;"># Upgrade Norg
|
||||||
|
</span><span style="color:#bf616a;">nimble</span><span> install norg
|
||||||
|
</span></code></pre>
|
||||||
|
<p>The latest version of Norg should then be installed in your <code>$HOME/.nimble/bin/</code> directory.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr />
|
||||||
|
<h2>Help us improve this documentation.</h2>
|
||||||
|
<p>If you find an error, or think something could be explained better,
|
||||||
|
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
|
||||||
|
send your feedback.</p>
|
||||||
|
<footer>
|
||||||
|
<p>Norg Backup Utility © 2024 Paul Wilde<br/>
|
||||||
|
Site created using <a href="https://getzola.org">Zola</a> using the
|
||||||
|
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/elasticlunr.min.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/search_index.en.js" defer></script>
|
||||||
|
<script type="text/javascript" src="https://norgbackup.net/js.js" defer></script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Loading…
Reference in a new issue