luismedel / nbagent

A Nullboard backup agent for Unix systems

nbagent

nbagent is a Nullboard backup agent for Unix systems.

It works in the same way that the official Nullboard Backup Agent for Windows.

Note: I also created https://github.com/luismedel/docker-nullboard in case you want to have a full self-contained Nullboard installation (Nullboard app + nbagent)

Installation

$ pip install nbagent

Usage

Invoke nbagent:

$ nbagent

Immediately you'll see an output similar to this:

 * [i] Using data directory /Users/luis/.local/share/nbagent
 * [i] Config saved to /Users/luis/.local/share/nbagent/app-config.json
 * [!] Nullboard token: d6606ecaaae54612906cc56a75583b61
 * [i] Server listening 0.0.0.0:10001...

Note the line:

 * [!] Nullboard token: d6606ecaaae54612906cc56a75583b61

Just copy the auth token (in this example d6606ecaaae54612906cc56a75583b61) into Nullboard, as per the instructions and you're ready to go.

If for any reason you need to reset the auth token use:

$ nbagent --reset-token

You can also set a custom token if you want:

$ nbagent --override-token "123-456-789"

Overriding defaults

nbagent allows you to specify several settings if you're not comfortable with the defaults.

Note that nbagent don't use hardcoded paths for the data. It tries to use the standard directory $XDG_DATA_HOME. If not defined, it defaults to $HOME/.local/share.`

$ nbagent --help

Usage: nbagent [OPTIONS]

 Start listening for Nullboard requests.

Options:
 --addr TEXT            Bind to address  [default: 0.0.0.0]
 --port INTEGER         Use custom port  [default: 10001]
 --data TEXT            Directory for data  [default: ~/.local/share/nbagent]
 --reset-token          Generate a new random auth token
 --override-token TEXT  Use a custom auth token
 --help                 Show this message and exit.