Windows Installation

1. Open PowerShell as an administrator

2. Copy and paste the following script into your PowerShell window:

# Function to detect GPU type
function Detect-GPUType {
    $gpuInfo = Get-WmiObject Win32_VideoController | Where-Object { $_.AdapterCompatibility -match "NVIDIA|Advanced Micro Devices" }
    if ($gpuInfo.AdapterCompatibility -match "NVIDIA") {
        return "nvidia"
    } elseif ($gpuInfo.AdapterCompatibility -match "Advanced Micro Devices") {
        return "amd"
    } else {
        Write-Host "No compatible NVIDIA or AMD GPU detected. Exiting."
        exit 1
    }
}

# Detect GPU type
$gpuType = Detect-GPUType

# Set environment variables based on GPU type
$env:DOCKER_IMAGE = if ($gpuType -eq "nvidia") { "marcoastramind/pulsar-nvidia" } else { "marcoastramind/pulsar-amd" }
$env:GPU_RUNTIME = $gpuType

# Create necessary directories
$pulsarDir = "$env:USERPROFILE\pulsar"
$hfCacheDir = "$env:USERPROFILE\.cache\huggingface"
$dirs = @(
    "$pulsarDir\configs",
    "$pulsarDir\static",
    "$pulsarDir\db_revision",
    $hfCacheDir
)
foreach ($dir in $dirs) {
    if (!(Test-Path $dir)) {
        New-Item -ItemType Directory -Path $dir -Force | Out-Null
        Write-Host "Created directory: $dir"
    } else {
        Write-Host "Directory already exists: $dir"
    }
}
Set-Location -Path $pulsarDir

# Create .env file
$envFile = "$pulsarDir\.env"
if (!(Test-Path $envFile)) {
    $securePassword = Read-Host "Enter a secure password for the database" -AsSecureString
    $password = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePassword))
    $primaryUse = Read-Host "Enter your expected use type (1:general, 2:roleplay, 3:roleplay 18+)"
    $hfToken = Read-Host "Enter your HuggingFace token (press Enter to skip)"
    $shouldSendTokenOnline = Read-Host "Allow sending your read token to your online profile? This is mandatory for adding private and gated models/loras (y/n)"
    $ngrokToken = Read-Host "Enter your Ngrok token (press Enter to skip)"
    $isAdultContent = if ($primaryUse -eq "3") { "true" } else { "false" }
    $shouldSendOnline = if ($shouldSendTokenOnline -ieq "y") {"true"} else {"false"}
    $primaryUseText = switch ($primaryUse) {
        "1" { "general" }
        "2" { "roleplay" }
        "3" { "roleplay" }
        default { "general" }
    }

    $envContent = @"
PULSAR_DB_PASSWORD=$password
PULSAR_HF_TOKEN=$hfToken
PULSAR_SHOULD_SEND_PRIVATE_TOKEN=$shouldSendOnline
PULSAR_NGROK_TOKEN=$ngrokToken
PULSAR_DB_USER=astramind
POSTGRES_DB_NAME=pulsar
PULSAR_DB_NAME=postgres:5432/pulsar
PRIMARY_USE=$primaryUseText
IS_ADULT_CONTENT=$isAdultContent
DOCKER_IMAGE=$env:DOCKER_IMAGE
GPU_RUNTIME=$env:GPU_RUNTIME
GPU_DEVICES=
GPU_GROUPS=
"@
    $envContent | Out-File -FilePath $envFile -Encoding utf8
    Write-Host "Created .env file: $envFile"
} else {
    Write-Host ".env file already exists: $envFile"
}

# Create docker-compose.yml file
$composeFile = "$pulsarDir\docker-compose.yml"
$composeContent = @"
version: '3'
services:
  postgres:
    ports:
      - "5432:5432"
    image: postgres:latest
    environment:
      POSTGRES_DB: `${PULSAR_DB_NAME}
      POSTGRES_USER: `${PULSAR_DB_USER}
      POSTGRES_PASSWORD: `${PULSAR_DB_PASSWORD}
    volumes:
      - pgdata:/var/lib/postgresql/data
      - ./init-db.sql:/docker-entrypoint-initdb.d/init-db.sql
    healthcheck:
      test: [ "CMD-SHELL", "pg_isready -U astramind -d pulsar" ]
      interval: 10s
      timeout: 5s
      retries: 5
  pulsar:
    ports:
      - "40000:40000"
    image: `${DOCKER_IMAGE}
    volumes:
      - `${USERPROFILE}\pulsar\configs:/home/user/Pulsar/configs:rw
      - `${USERPROFILE}\pulsar\static:/home/user/Pulsar/static/item_images:rw
      - `${USERPROFILE}\pulsar\.env:/home/user/Pulsar/.env:rw
      - `${USERPROFILE}\.cache\huggingface:/home/user/.cache/huggingface:rw
      - `${USERPROFILE}\pulsar\db_revision:/home/user/Pulsar/app/db/migration/alembic_/versions:rw
    depends_on:
      postgres:
        condition: service_healthy
    deploy:
      resources:
        reservations:
          devices:
            - driver: `${GPU_RUNTIME}
              count: all
              capabilities: [gpu]
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:40000/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 120s          
"@

if ($gpuType -eq "amd") {
    $composeContent += @"

    devices:
      - /dev/kfd
      - /dev/dri
    group_add:
      - video
"@
}

$composeContent += @"

volumes:
  pgdata:
"@

$composeContent | Out-File -FilePath $composeFile -Encoding utf8
Write-Host "Created docker-compose.yml file: $composeFile"

# Create init-db.sql file
$initDbFile = "$pulsarDir\init-db.sql"
$initDbContent = @"
-- Create user if not exists
DO
$$
BEGIN
  IF NOT EXISTS (SELECT FROM pg_catalog.pg_roles WHERE rolname = 'astramind') THEN
    CREATE USER astramind WITH PASSWORD '`${PULSAR_DB_PASSWORD}';
  END IF;
END
$$;
-- Create database if not exists
SELECT 'CREATE DATABASE pulsar'
WHERE NOT EXISTS (SELECT FROM pg_database WHERE datname = 'pulsar');
-- Grant privileges
GRANT ALL PRIVILEGES ON DATABASE pulsar TO astramind;
"@
$initDbContent | Out-File -FilePath $initDbFile -Encoding utf8
Write-Host "Created init-db.sql file: $initDbFile"

Write-Host "Setup complete. To start Pulsar AI, run 'docker-compose up -d' in the $pulsarDir directory."

3. Running Pulsar

cd $env:USERPROFILE\pulsar

docker-compose up -d

docker-compose logs -f

docker-compose down