Skip to main content

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.

Release files for nbagent 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nbagent 1.1.0
File Size Uploaded
nbagent-1.1.0.tar.gz 5.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nbagent 1.1.0
File Interpreter ABI Platform
nbagent-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.8 kB

Release files / nbagent-1.1.0.tar.gz

Download URL nbagent-1.1.0.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
2e09ca9c6b1a3bf89f4266e8583ade10970fb6d89f0af78e828daa6668316f61
BLAKE2b-256 checksum
How to use checksums
28cc436a530be1601f9ce1ceb9974ece640b76902ab75834b20084f22297ed67
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.9.21

Release files / nbagent-1.1.0-py3-none-any.whl

Download URL nbagent-1.1.0-py3-none-any.whl
Size 5.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e7897753a2369eb5f752daac72b5a89846f4a70841b7aa2cecc85bb9273555d8
BLAKE2b-256 checksum
How to use checksums
48609e8636b33bb59dece13432c5d54523153c03403b985d97e80dd7ad8c54c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.9.21

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page