bitabase-manager

bitabase - Manager

This is a very early attempt at an accounts management service.

Getting Started

From the CLI

Running the following:

npm install --global bitabase-manager
bitabase-manager --help

Will output the below:

📦 Bitabase-Manager - v2.2.1
The scalable, sharded database engine.
https://docs.bitabase.com

The following commands and arguments are available when starting Bitabase

Commands:
  start                                    Start the bitabase manager stack
    --bind-host                            Hostname to bind server to (default: 0.0.0.0)
    --bind-port                            Port to bind server to (default: 8001)
    --rqlite-addr                          Path to contact rqlite
    --secret                               The internal request secret
    --allow-cross-origin-domain            Allow a domain to bypass cross origin domain controls
    --password-hash-iterations             The iterations for the password hashing algorithm to use (default: 372791)

No command specified

You can start a bitabase server by running:

bitabase-manager start

From NodeJS

const bitabaseServer = require('bitabase-manager/server');

const server = bitabaseManager({
  bindHost: '0.0.0.0'
});

server.start();

Endpoints

	Method	Path	Description
User Users are entities that can login to the manager api
1.1	POST	/v1/users	Create a new user
Sessions Sessions are created by users when they login
2.1	POST	/v1/sessions	Create a new session by logging in
2.2	GET	/v1/sessions/current	Get the user from the current session
Databases Databases are owned by one or more users and can store multiple collections
3.1	GET	/v1/databases	List all databases
3.2	POST	/v1/databases	Create a new database
Collections Collections are owned by a database and store records
4.1	GET	/v1/databases/:databaseName/collections	List all collections in a database
4.2	POST	/v1/databases/:databaseName/collections	Create a new collection in a database

License

This project is licensed under the terms of the AGPL-3.0 license.