216 lines
11 KiB
HTML
216 lines
11 KiB
HTML
|
<!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>
|