AxioDB Control
A simple desktop way to connect to AxioDB, browse your collections, run queries, and manage documents. Follow the three steps below to get started.
One important thing to know
AxioDB Control is the client application. It connects to an AxioDB server that is already running. The server must expose the HTTP Control API on port 27018.
Quick start
Get connected in three steps
Start with the normal path. You can find platform details and alternate commands further down this page.
Install AxioDB Control
Download the installer for your computer from GitHub Releases. Open the downloaded file and follow the installer steps.
Windows
NSIS installer (.exe)
macOS
App bundle (.zip)
Linux
.deb or AppImage
Start the HTTP server
Choose the mode you need. The HTTP server always uses port 27018; there is noPort option inAxioDB.
GUI + HTTP API
1import { AxioDB } from "axiodb";2
3// Starts the web GUI and the HTTP API on port 27018.4const db = new AxioDB({ GUI: true });5
6// Use db.createDB(), db.getDB(), or another database operation here.7// AxioDB waits for its startup work before handling that operation.HTTP API only
1import { AxioDB } from "axiodb";2
3// Starts the HTTP API on port 27018 without serving the web GUI.4const db = new AxioDB({ GUI: false, HTTP: true });GUI: true enables both the browser dashboard and the HTTP API.
HTTP: true, GUI: false enables the HTTP API for another client or application without serving the dashboard.
The server listens on 0.0.0.0:27018, so another machine can reach it using the server's IP address if the network firewall allows it. The built-in authentication still protects API actions.
Add the server in the app
Open AxioDB Control, create a connection, and enter:
Host
localhost (or server IP)
Port
27018
Login
admin / admin first time
Click Test connection, then select the database you want to work with.
After you connect
What can you do?
The main workspace is designed around the tasks you do most often.
Browse your data
Open databases and collections, then view documents in an easy card layout.
Run queries
Filter documents with JSON queries and inspect the results without using a terminal.
Edit documents
Copy, edit, or delete documents directly from the document viewer.
Create backups
Export a database as a .tar.gz archive from the database menu.
See connection health
The app checks the server regularly and shows connection status and latency while you work.
Keep your server safe
Do not expose port 27018 to the public internet without proper network protection. Use authentication, a firewall, and a private network or VPN for remote connections.
Need a different setup?
Keep the beginner path above as your reference. These sections cover less common setups and implementation details.
Install with a command
Use these commands when you prefer a terminal or are setting up a machine remotely.
Linux / macOS
1curl -fsSL https://raw.githubusercontent.com/nexoral/AxioDB/main/cli/Scripts/install.sh | CHOICE=2 bashWindows PowerShell
1$env:CHOICE=2; irm https://raw.githubusercontent.com/nexoral/AxioDB/main/cli/Scripts/install.ps1 | iexConfigure with environment variables
This Docker example starts both the web GUI and HTTP API. The AxioDB Docker runner reads these environment variables.
1docker run -d -p 27018:27018 \2 -e AXIODB_GUI=true -e AXIODB_HTTP=true \3 theankansaha/axiodbFor HTTP-only Docker mode, use AXIODB_GUI=false with AXIODB_HTTP=true for instead. When using the built-in HTTP server directly from Node.js, set GUI and HTTP in theAxioDB options object. The default seeded login is admin/admin; change it immediately after the first login.
Supported versions and local settings
Supported desktop systems
Linux (Ubuntu 20.04+, Debian 11+, Fedora, and Arch), Windows 10/11 and Windows Server 2019+, and macOS 12 Monterey or later. Linux supports x86_64 and arm64; Windows supports x86_64; macOS supports Intel and Apple Silicon.
Where connection profiles are saved
AxioDB Control stores connection profiles and preferences in Electron's local user-data directory. They are kept on the computer running the GUI and are not stored in your AxioDB database.
See also: Installation · Docker · Security
