https://github.com/justinpchang/nullboard-agent-express
Local backup agent for Nullboard (MacOS/Linux compat)
https://github.com/justinpchang/nullboard-agent-express
kanban minimalist nullboard
Last synced: 5 months ago
JSON representation
Local backup agent for Nullboard (MacOS/Linux compat)
- Host: GitHub
- URL: https://github.com/justinpchang/nullboard-agent-express
- Owner: justinpchang
- License: bsd-2-clause
- Created: 2023-08-07T19:24:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-08T16:26:06.000Z (over 1 year ago)
- Last Synced: 2024-11-16T12:07:24.863Z (6 months ago)
- Topics: kanban, minimalist, nullboard
- Language: JavaScript
- Homepage:
- Size: 47.9 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - justinpchang/nullboard-agent-express - Local backup agent for Nullboard (MacOS/Linux compat) (others)
README
## Nullboard Agent Express Port
[](https://badge.fury.io/js/nullboard-agent-express)
This is a repo with the source code for a port of [Nullboard Agent (C++, Windows only)](https://github.com/apankrat/nullboard-agent) written in Express.js. See that repo for more details about Nullboard backups or the Nullboard project in general.
## Installation:
#### Running on-demand:
Using `npx` you can run the script without installing it first:
npx nullboard-agent
#### Globally via `npm`:
npm install --global nullboard-agent
This will install `nullboard-agent` globally so that it may be run from the command line anywhere.
#### Globally via Homebrew:
brew tap justinpchang/nullboard-agent
## Usage:
#### Starting the server and getting your token:
```
nullboard-agent [command] [options]
```
Possible commands:
- `token` to retrive the token that the server is using
- `server` to start the agent server
Possible options:
- `-p` or `--port` signifies port to use. Use `-p 0` to look for an open port. Defaults to 10001.
Agent uses `/opt/nullboard-agent` as the backup directory.
#### Connecting to Nullboard:
- Navigate to Nullboard
- Open the Auto-backup menu from the top-right
- Select Local backup
- Add your token (retrieved from running `nullboard-agent token`) to the Access token field
- Click `Check...` and ensure that the connection is established
- Click `Save`
## License:
The 2-clause BSD license.
## Feedback and contributions:
This repo is maintained by @justinpchang, separate from the Nullboard project. Please open issues relating to the Nullboard Agent Express Port in this repository. Please direct all other Nullboard-related feedback to the appropriate repository ([Nullboard](https://github.com/apankrat/nullboard), [Nullboard Agent (C++)](https://github.com/apankrat/nullboard-agent)).