The Guidebook

NoSQLBench comes with its own internal documentation. The intent is to make documentation and new UI features live together in an interactive way going forward.

A static view of the guidebook is kept online, and updated automatically with each release of NoSQLBench.

If you want to run the guidebook app locally, use these instructions:

Guidebook on localhost:

This runs the NoSQLBench in docserver mode at http://localhost:12345/ by default:

nb docserver

This is by far the most secure mode. If you want to access it in this mode from a remote system like your desktop, you can port forward via ssh, with an option like -L12345:localhost:12345 for openssh, for example.

Guidebook on a routable address:

If you want to access NoSQLBench documentation directly from a different system, like your desktop, then you can run it with one of these forms:

# with a specific listener address (a local interface)
nb docserver http://192.168.128.123:12345/

# or bind to all local addresses
nb docserver http://0.0.0.0:12345/

In either of these forms, you'll be able to access the guidebook app from any external system, barring any interference from firewalls. This is obviously the least secure. For now, there isn't much functionality to expose besides docs. However, you'll want to protect access to this system if/when you every drive workloads interactively this way.

The guidebook is the first UI-based application to be bundled with NoSQLBench. Stay tuned for more news on what's next!