Skip to content
Coordinator DB
View as Markdown
View as Markdown

Install CoordinatorDB ​

Install CoordinatorDB from the latest GitHub release using a terminal with curl and sh.

Install ​

Run the installer:

sh
curl -fsSL https://github.com/coordinator-db/coordinator-db/releases/latest/download/install.sh | sh

Start the server ​

From the directory containing the coordinator executable and the supplied config.xml and users.xml files, start the server:

sh
./coordinator serve

The supplied users.xml explicitly configures user default with an empty password. The default native address is 127.0.0.1:7400. The supplied config.xml also enables HTTP on port 7401. The default database is data.db beside the executable.

Verify the connection ​

Open another terminal in the same directory and run:

sh
./coordinator client --database data --query "SELECT 1 AS connected FORMAT csv"
text
1

Configuration paths ​

The server requires existing config.xml and users.xml files; it does not generate them. --config-file PATH selects another configuration, and --db PATH selects another database file independently of the configuration directory.

The supplied credentials are suitable for this local example. Edit the configured users for the access you intend to provide; credentials changes require a server restart.

Continue with creating a table. See configuration files for listener, credential and path options.