neodatax-agent
v1.1.0
Published
NeoDataX Connector Agent — connects your local database to NeoDataX AI securely via outbound WebSocket
Downloads
197
Maintainers
Readme
NeoDataX Connector Agent
Connect your local/private database to NeoDataX AI securely — without exposing any ports.
Features
- Zero inbound ports — agent connects outbound via WebSocket
- DB credentials stay local — never sent to the cloud
- Token-based auth — one-time token from NeoDataX dashboard
- GUI + CLI mode — double-click or command-line
- Multi-DB support — PostgreSQL, MySQL, SQL Server
Quick Start
Option 1: npx (no install needed)
npx neodatax-agentThis opens a browser-based GUI where you can enter your connection details.
Option 2: Global install
npm install -g neodatax-agent
neodatax-agentOption 3: CLI mode (for scripts/automation)
npx neodatax-agent \
--token nda_xxxxxxxxxxxxxxxx \
--server wss://neo.neodatax.ai \
--db-type postgresql \
--db-host localhost \
--db-port 5432 \
--db-name mydb \
--db-user myuser \
--db-pass mypassHow It Works
- Create an Agent connection in NeoDataX AI → Database → Connect → Agent mode
- Copy the token provided
- Run the agent on the machine with database access
- Enter the token and database credentials in the agent GUI
- Done! NeoDataX AI can now query your database through the secure tunnel
┌─────────────┐ outbound WSS ┌──────────────┐
│ Your Server │ ───────────────────→ │ NeoDataX AI │
│ + Agent │ ← SQL queries → │ Cloud │
│ + Database │ (encrypted) │ │
└─────────────┘ └──────────────┘Supported Databases
| Database | Port | Driver | |------------|------|---------| | PostgreSQL | 5432 | pg | | MySQL | 3306 | mysql2 | | SQL Server | 1433 | mssql |
Security
- All communication is via outbound WebSocket (WSS/TLS in production)
- Database credentials are never transmitted — they stay on your machine
- The agent only executes queries forwarded by NeoDataX AI
- Token-based authentication ensures only authorized connections
License
MIT
