SwarmCanvas Logo
SwarmCanvas

Getting Started with Ax

This guide will help you set up and run Ax in your environment. Choose between quick installation or manual installation based on your needs.

Prerequisites

  • •At least 4GB of available RAM
  • •10GB of free disk space
  • •An OpenAI API key

Quick Installation

The fastest way to get started with SwarmCanvas is using our installation script:

curl -sSL https://swarmcanvas.com/install.sh | sh

This script will:

  • Check for required port availability (8001, 5432)
  • Verify Docker installation
  • Install Docker if not present
  • Pull and set up SwarmCanvas containers
  • Start all required services

Manual Installation

1. System Requirements

  • Docker and Docker Compose
  • Python 3.10 or higher
  • Git

2. Clone the Repository

git clone https://github.com/swarmcanvas/swarmcanvas.git cd swarmcanvas

3. Start the Services

docker-compose up -d

This will start:

  • PostgreSQL database
  • SwarmCanvas server
  • SwarmCanvas UI
  • Required support services

4. Initial Setup

Create an admin account:

curl -X POST http://localhost:8001/swarmcanvas/auth/signup \
     -H "Content-Type: application/json" \
     -d '{"username": "admin", "password": "your_password"}'

Log in to get your access token:

curl -X POST http://localhost:8001/swarmcanvas/auth/signin \
     -d "username=admin&password=your_password"

Verification

Test your installation:

curl http://localhost:8001/swarmcanvas/health

Expected response:

{
    "status": "healthy",
    "version": "1.0.0"
}