Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xagent.run/llms.txt

Use this file to discover all available pages before exploring further.

​
Installation

Xagent supports multiple deployment options depending on your needs.

​
Docker Compose (Recommended)

The fastest way to get started. 
git clone https://github.com/xorbitsai/xagent.git
cd xagent
cp example.env .env
docker compose up -d
Access: http://localhost:80

​
Manual Installation

For more control over your deployment.

​
Requirements

  • Python 3.10+
  • PostgreSQL 14+
  • Redis 6+

​
Backend Setup

# Install dependencies
pip install -r requirements.txt

# Configure environment
cp example.env .env
# Edit .env with your settings

# Run database migrations
alembic upgrade head

# Start backend server
python -m uvicorn main:app --reload

​
Frontend Setup

cd frontend
npm install
npm run dev

​
Configuration

See Configuration for detailed setup options.

​
Production Deployment

For production deployments, see:

​
System Requirements

​
Minimum

  • CPU: 4 cores
  • RAM: 8 GB
  • Disk: 20 GB

​
Recommended

  • CPU: 8+ cores
  • RAM: 16+ GB
  • Disk: 50+ GB SSD

​
Next Steps