Skip to main content

Installation Guide

Vectense Platform offers flexible deployment options to meet your organizational needs, from self-hosted installations to guided cloud deployments.

Installation Options​

Self-Hosted Installation​

Deploy Vectense Platform on your own infrastructure for maximum control and data privacy.

  • Install Self-Hosted - Complete self-hosted deployment guide
  • System requirements and prerequisites
  • Docker deployment options
  • Network and security configuration

Quick Start with Setup Assistant​

Get started quickly with the built-in setup assistant that guides you through the initial configuration.

  • Setup Assistant - Step-by-step guided setup
  • Automatic dependency checks
  • License configuration
  • Initial user creation

Workspace Creation​

Set up your first workspace to organize your AI projects and workflows.

  • Create a Workspace - Workspace setup guide
  • Team collaboration setup
  • Access control configuration
  • Resource allocation

Prerequisites​

Before installing Vectense Platform, ensure your system meets these requirements:

System Requirements​

  • Operating System: Linux, macOS, or Windows with Docker support
  • Memory: Minimum 4GB RAM, recommended 8GB+ for production
  • Storage: 10GB+ available disk space
  • Network: Internet access for AI model providers (optional for self-hosted models)

Required Software​

  • Docker & Docker Compose: For containerized deployment
  • Node.js 18+: For development and custom integrations
  • Modern Web Browser: Chrome, Firefox, Safari, or Edge

Network Requirements​

  • Inbound Ports:
    • 3000 (Web Interface)
    • 3001 (API Service)
  • Outbound Access: For AI model APIs (if using cloud providers)

Quick Start​

For the fastest setup experience:

  1. Download: Get the latest Vectense Platform release
  2. Deploy: Use Docker Compose for single-command deployment
  3. Setup: Run the setup assistant in your browser
  4. Configure: Create your first workspace and connect AI models
# Quick deployment with Docker Compose
git clone https://github.com/your-org/vectense-platform
cd vectense-platform
docker-compose up -d

# Access setup assistant
open http://localhost:3000/setup

Installation Paths​

Choose the installation path that best fits your needs:

Path 1: Evaluation and Testing​

Perfect for trying out Vectense Platform or small team deployments.

Path 2: Production Deployment​

For enterprise production environments with full customization.

Path 3: Development Setup​

For developers extending or customizing Vectense Platform.

  • Development environment setup
  • Source code compilation
  • Integration development tools

Post-Installation​

After completing the installation:

  1. License Setup: Configure your license
  2. User Management: Set up user accounts and roles
  3. Model Configuration: Connect AI model providers
  4. Knowledge Setup: Create your first knowledge base
  5. Workflow Creation: Build your first automation

Troubleshooting​

Common installation issues and solutions:

Port Conflicts​

If default ports are already in use:

# Use custom ports
VECTENSE_WEB_PORT=3030 VECTENSE_API_PORT=3031 docker-compose up -d

Memory Issues​

For systems with limited memory:

# Adjust memory limits in docker-compose.yml
services:
  service:
    deploy:
      resources:
        limits:
          memory: 2G

Network Access​

For restricted network environments:

  • Configure proxy settings in environment variables
  • Set up firewall rules for required ports
  • Use offline AI models with Ollama

Support​

If you encounter issues during installation:

  • Documentation: Check the specific installation guide for your chosen method
  • Community: Join our community forum for help and discussions
  • Support: Contact enterprise support for licensed installations
  • Issues: Report bugs or request features on GitHub

Continue with your chosen installation method: