Setting up Norg

    Prerequisites

    Install Borg or Restic as these do not get installed automatically.

    You will also need to install Nim v2 and nimble

    Installation

    Norg is listed on Nimble Directory so you can install norg using nimble

    nimble install norg
    

    or, if you'd rather not use the directory, you can install direct from our Codeberg Repo:

    nimble install https://codeberg.org/pswilde/norgbackup
    

    PATH variable

    Once installed, norg will be installed in your $HOME/.nimble/bin/ directory. You should add this location to your $PATH variable so it can be found remains up-to-date when running nimble install norg again.

    Portability

    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.
    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.

    Upgrading Norg

    Norg can be upgraded easily via nimble:

    # Update nimble directory cache
    nimble update
    # Upgrade Norg
    nimble install norg
    

    The latest version of Norg should then be installed in your $HOME/.nimble/bin/ directory.


    Help us improve this documentation.

    If you find an error, or think something could be explained better, raise an issue to send your feedback.