DocumentationNeuronAgent Documentation
Documentation Branch: You are viewing documentation for the main branch (3.0.0-devel). Select a branch to view its documentation:
NeuronAgent Installation
Docker Installation
The fastest way to get NeuronAgent running is with Docker Compose. This method includes NeuronAgent with NeuronDB integration.
Start NeuronAgent with Docker Compose
# Clone repository
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb
# Start NeuronAgent with NeuronDB
docker compose up -d neuronagent neurondb
# Verify services
docker compose ps
# Check health endpoint
curl -sS http://localhost:8080/healthThis starts:
- NeuronAgent (REST API) on port 8080
- NeuronDB (PostgreSQL with extension) on port 5433
- WebSocket support for real-time streaming
- Background workers for memory promotion and async tasks
Source Build
For production deployments or custom builds, install from source. This requires Go 1.21+, PostgreSQL 16-18 with NeuronDB extension, and build dependencies.
Build from source (Ubuntu/Debian)
# Install dependencies
sudo apt-get install -y postgresql-17 postgresql-server-dev-17 build-essential golang-go
# Clone repository
git clone https://github.com/neurondb-ai/neurondb.git
cd neurondb
# Build NeuronAgent
cd NeuronAgent
go build -o neuronagent ./cmd/server
# Run NeuronAgent
./neuronagent --config configs/config.yaml.exampleConfiguration
Configure NeuronAgent to connect to your NeuronDB instance. See the Configuration Guide for detailed instructions.
Verification
Verify NeuronAgent is running correctly:
Check health endpoint
curl -sS http://localhost:8080/health
# Expected output: {"status":"ok"}