DocumentationNeuronDesktop Documentation
Documentation Branch: You are viewing documentation for the main branch (3.0.0-devel). Select a branch to view its documentation:
NeuronDesktop Installation
Docker Installation
The fastest way to get NeuronDesktop running is with Docker Compose.
Start NeuronDesktop with Docker Compose
# Clone repository
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb
# Start NeuronDesktop with NeuronDB
docker compose up -d neurondesk-api neurondesk-frontend neurondb
# Verify services
docker compose ps
# Access web interface
# API: http://localhost:8081/
# UI: http://localhost:3000/This starts:
- NeuronDesktop API on port 8081
- NeuronDesktop Frontend (Web UI) on port 3000
- NeuronDB (PostgreSQL with extension) on port 5433
Source Build
For production deployments or custom builds, install from source. This requires Node.js 18+, Go 1.21+, and build dependencies.
Build from source (Ubuntu/Debian)
# Install dependencies
sudo apt-get install -y nodejs npm golang-go build-essential
# Clone repository
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb
# Build API
cd NeuronDesktop/api
go build -o neurondesk-api ./cmd/server
# Build Frontend
cd ../frontend
npm install
npm run build
# Run API
cd ../api
./neurondesk-api --config configs/config.yaml.example
# Run Frontend (in another terminal)
cd ../frontend
npm run startConfiguration
Configure NeuronDesktop to connect to your NeuronDB, NeuronAgent, and NeuronMCP instances. See the Profile Configuration Guide for details.
Verification
Verify NeuronDesktop is running correctly:
- Access web UI at
http://localhost:3000 - Check API health at
http://localhost:8081/health - Verify profile creation and component connections