Skip to main content

Prerequisites

System Requirements (Local Setup)​

Minimum Requirements​

  • RAM: 8 GB (4 GB available for Docker)
  • Storage: 10 GB free disk space
  • CPU: 2 cores (x86_64 or ARM64)
  • OS:
    • macOS 10.15+ (Catalina or newer)
    • Windows 10/11 with WSL2
    • Linux with kernel 3.10+

Software Requirements​

To run IntraCord AI locally, make sure you have the following installed:

  • Docker (version 20.10 or later)
  • curl - usually preinstalled on macOS/Linux

Docker Resource Allocation​

For Docker Desktop users, ensure Docker has adequate resources:

  1. Open Docker Desktop settings
  2. Navigate to Resources
  3. Allocate at least:
    • Memory: 4 GB (8 GB recommended)
    • CPUs: 2 (4 recommended)
    • Disk: 10 GB

Required Ports​

Ensure these ports are available:

  • 3010 - Web UI
  • 8000 - API Server
  • 5432 - PostgreSQL
  • 6379 - Redis
  • 9000 - MinIO (S3-compatible storage)
  • 9001 - MinIO Console

Checking Port Availability​

Check if a port is in use (replace 3010 with the port number):

lsof -i :3010
netstat -tulpn | grep 3010
netstat -ano | findstr :3010

Docker Registry Options​

IntraCord images are available from two registries:

  • GitHub Container Registry (Default): ghcr.io/IntraCord-hq - Recommended for most users
  • Docker Hub: IntraCordai - Alternative registry

To use a specific registry, set the REGISTRY environment variable when running the startup script:

# Using GitHub Container Registry (recommended)
REGISTRY=ghcr.io/IntraCord-hq ./start_docker.sh

# Using Docker Hub
REGISTRY=IntraCordai ./start_docker.sh
# Using GitHub Container Registry (recommended)
$env:REGISTRY = 'ghcr.io/IntraCord-hq'; .\start_docker.ps1

# Using Docker Hub
$env:REGISTRY = 'IntraCordai'; .\start_docker.ps1