| Name | nbagent JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | |
| Summary | A Nullboard backup agent for Unix systems |
| upload_time | 2023-09-22 23:55:51 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
click
Flask
Flask-Cors
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# nbagent
`nbagent` is a [Nullboard](https://github.com/apankrat/nullboard) backup agent for Unix systems.
It works in the same way that the official [Nullboard Backup Agent](https://github.com/apankrat/nullboard-agent) for Windows.
## Installation
```sh
$ pip install nbagent
```
## Usage
Invoke `nbagent`:
```sh
$ nbagent
```
Immediately you'll see an output similar to this:
```sh
* [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](https://nullboard.io/backups) and you're ready to go.
If for any reason you need to reset the auth token use:
```sh
$ nbagent --reset-token
```
You can also set a custom token if you want:
```sh
$ 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`.`
```sh
$ 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.
```
Raw data
{
"_id": null,
"home_page": "",
"name": "nbagent",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Luis Medel <luis@luismedel.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/4b/14ddf1e8b12ee9e2734cdcf4a220e627a3c15b96cfafda41d9cf1ae3a8b5/nbagent-1.0.1.tar.gz",
"platform": null,
"description": "# nbagent\n\n`nbagent` is a [Nullboard](https://github.com/apankrat/nullboard) backup agent for Unix systems.\n\nIt works in the same way that the official [Nullboard Backup Agent](https://github.com/apankrat/nullboard-agent) for Windows.\n\n## Installation\n\n```sh\n$ pip install nbagent\n```\n\n## Usage\n\nInvoke `nbagent`:\n\n```sh\n$ nbagent\n```\n\nImmediately you'll see an output similar to this:\n\n```sh\n * [i] Using data directory /Users/luis/.local/share/nbagent\n * [i] Config saved to /Users/luis/.local/share/nbagent/app-config.json\n * [!] Nullboard token: d6606ecaaae54612906cc56a75583b61\n * [i] Server listening 0.0.0.0:10001...\n ```\n\nNote the line:\n\n```\n * [!] Nullboard token: d6606ecaaae54612906cc56a75583b61\n```\n\nJust copy the auth token (in this example `d6606ecaaae54612906cc56a75583b61`) into Nullboard, [as per the instructions](https://nullboard.io/backups) and you're ready to go.\n\nIf for any reason you need to reset the auth token use:\n\n ```sh\n$ nbagent --reset-token\n```\n\nYou can also set a custom token if you want:\n\n ```sh\n$ nbagent --override-token \"123-456-789\"\n```\n\n### Overriding defaults\n\n`nbagent` allows you to specify several settings if you're not comfortable with the defaults.\n\n> 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`.`\n\n ```sh\n $ nbagent --help\n\nUsage: nbagent [OPTIONS]\n\n Start listening for Nullboard requests.\n\nOptions:\n --addr TEXT Bind to address [default: 0.0.0.0]\n --port INTEGER Use custom port [default: 10001]\n --data TEXT Directory for data [default: ~/.local/share/nbagent]\n --reset-token Generate a new random auth token\n --override-token TEXT Use a custom auth token\n --help Show this message and exit.\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A Nullboard backup agent for Unix systems",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/luismedel/nbagent"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0dd9e9792f5ccfc12f931972eb4e3363d7d2d10ad0a7bc01c25ba39ad31ec58",
"md5": "a66cdf1c20c9af829dc8c42f6e769633",
"sha256": "64ac520c13f55c01c9507ed0f3794fd56a765eeed627793ebbecc920d8f384ad"
},
"downloads": -1,
"filename": "nbagent-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a66cdf1c20c9af829dc8c42f6e769633",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5528,
"upload_time": "2023-09-22T23:55:49",
"upload_time_iso_8601": "2023-09-22T23:55:49.979423Z",
"url": "https://files.pythonhosted.org/packages/d0/dd/9e9792f5ccfc12f931972eb4e3363d7d2d10ad0a7bc01c25ba39ad31ec58/nbagent-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba4b14ddf1e8b12ee9e2734cdcf4a220e627a3c15b96cfafda41d9cf1ae3a8b5",
"md5": "83b9379f6a80e7fb2001c5c366a105eb",
"sha256": "1287302207145fd4a72c593739c3c17a5e5fec6bda3b05073b933290bf80a4d0"
},
"downloads": -1,
"filename": "nbagent-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "83b9379f6a80e7fb2001c5c366a105eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5001,
"upload_time": "2023-09-22T23:55:51",
"upload_time_iso_8601": "2023-09-22T23:55:51.497382Z",
"url": "https://files.pythonhosted.org/packages/ba/4b/14ddf1e8b12ee9e2734cdcf4a220e627a3c15b96cfafda41d9cf1ae3a8b5/nbagent-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-22 23:55:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "luismedel",
"github_project": "nbagent",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "Flask",
"specs": [
[
"==",
"2.3.3"
]
]
},
{
"name": "Flask-Cors",
"specs": [
[
"==",
"4.0.0"
]
]
}
],
"lcname": "nbagent"
}
