Interactive Installer Setup

Overview

PentAGI provides an interactive installer with a terminal-based UI that guides you through system checks, LLM provider setup, search engine configuration, and security hardening. This is the recommended installation method for both development and production environments.

The installer requires Docker and Docker Compose to be installed on your system. It will verify prerequisites before proceeding with the installation.

System Requirements

Docker and Docker Compose
Minimum 2 vCPU
Minimum 4GB RAM
20GB free disk space
Internet access for downloading images and updates

Supported Platforms

The installer is available for multiple platforms and architectures:

Quick Installation

Create installation directory

mkdir -p pentagi && cd pentagi

Download the installer

For Linux amd64:

wget -O installer.zip https://pentagi.com/downloads/linux/amd64/installer-latest.zip

For other platforms, use the appropriate download link from the supported platforms section above.

Extract the installer

unzip installer.zip

Run the interactive installer

./installer

Prerequisites & Permissions

The installer requires appropriate privileges to interact with the Docker API for proper operation. By default, it uses the Docker socket (/var/run/docker.sock).

Option 1: Run as Root (Recommended for Production)

sudo ./installer

This is the recommended approach for production deployments as it provides proper isolation and security controls.

Option 2: Docker Group Access (Development)

Adding a user to the docker group grants root-equivalent privileges. Only do this for trusted users in controlled environments.

Add your user to the docker group

sudo usermod -aG docker $USER

Activate the group

newgrp docker

Alternatively, log out and log back in for the changes to take effect.

Verify Docker access

docker ps

This command should run without requiring sudo.

Installation Process

The installer will guide you through the following steps:

1. System Checks

The installer verifies:

Docker installation and version
Docker Compose availability
Network connectivity
System resources (CPU, RAM, disk space)
Port availability (8443, 5432, 7687, etc.)

2. Environment Setup

The installer creates and configures a .env file with:

Optimal default settings
Secure random credentials
Database configurations
Network settings

3. Provider Configuration

Configure at least one LLM provider:

Provide your OpenAI API key:

OPEN_AI_KEY=your_openai_api_key

Supports GPT-4.1, o-series reasoning models, and cost-effective nano models.

Provide your Anthropic API key:

ANTHROPIC_API_KEY=your_anthropic_api_key

Supports Claude 4 series with advanced reasoning capabilities.

Provide your Gemini API key:

GEMINI_API_KEY=your_gemini_api_key

Supports Gemini 2.5 series with multimodal capabilities.

Provide AWS credentials:

BEDROCK_REGION=us-east-1
BEDROCK_ACCESS_KEY_ID=your_aws_access_key
BEDROCK_SECRET_ACCESS_KEY=your_aws_secret_key

Access to multiple foundation models from Anthropic, AI21, Meta, and Amazon.

Configure local LLM server:

OLLAMA_SERVER_URL=http://localhost:11434
OLLAMA_SERVER_MODEL=llama3.1:8b-instruct-q8_0

Zero-cost local inference with enhanced privacy.

Configure custom OpenAI-compatible API:

LLM_SERVER_URL=https://api.example.com/v1
LLM_SERVER_KEY=your_api_key
LLM_SERVER_MODEL=your_model_name

Supports OpenRouter, DeepSeek, DeepInfra, and other compatible APIs.

4. Search Engine Configuration

Optional but recommended for enhanced information gathering:

DuckDuckGo: Enabled by default, no API key required
Google Custom Search: Requires API key and CX key
Tavily: Advanced search API key
Traversaal: Search API key
Perplexity: AI-powered search key
Searxng: Self-hosted meta search engine URL

5. Security Hardening

The installer automatically:

Generates secure random passwords for PostgreSQL, Neo4j, Redis
Creates cookie signing salts
Configures encryption keys
Sets up admin credentials
Optionally configures SSL certificates

Make sure to save your admin credentials securely. The default credentials are:

Email: [email protected]
Password: admin (change this immediately after first login)

6. Deployment

The installer starts PentAGI using Docker Compose with:

Core services (backend, frontend, database)
Optional Langfuse for LLM observability
Optional Graphiti for knowledge graph
Optional monitoring stack (Grafana, Prometheus, Jaeger)

Accessing PentAGI

After installation completes, access PentAGI at:

https://localhost:8443

Default credentials:

Email: [email protected]
Password: admin

Change the default password immediately after your first login for security.

Post-Installation Configuration

Configure Docker Environment

For distributed worker node setup:

Access the installer: ./installer
Navigate to Tools → Docker Environment
Configure Docker connection settings
Set up TLS certificates for secure remote access

See the Distributed Setup Guide for detailed two-node configuration.

Enable Optional Services

The installer can enable additional services:

Langfuse
Graphiti
Observability

LLM observability and analytics platform:

docker compose -f docker-compose.yml -f docker-compose-langfuse.yml up -d

Access at: http://localhost:4000

Knowledge graph for semantic memory:

docker compose -f docker-compose.yml -f docker-compose-graphiti.yml up -d

Requires OpenAI API key for entity extraction.

Full monitoring stack (Grafana, Jaeger, Loki):

docker compose -f docker-compose.yml -f docker-compose-observability.yml up -d

Access Grafana at: http://localhost:3000

Troubleshooting

Docker Connection Issues

Permission denied on docker.sock

The installer needs access to the Docker socket. Either:

Run with sudo: sudo ./installer
Add user to docker group (see Prerequisites section)

Port already in use

Check if another service is using required ports:

sudo netstat -tlnp | grep -E ':(8443|5432|7687)'

Stop conflicting services or modify port mappings in docker-compose.yml.

Docker daemon not running

Start the Docker service:

sudo systemctl start docker
sudo systemctl enable docker

Installation Failures

Network connectivity issues

The installer checks internet connectivity during setup. Ensure:

DNS resolution is working
Firewall allows outbound HTTPS traffic
Docker can pull images from Docker Hub

Insufficient resources

Verify system resources:

# Check available memory
free -h

# Check disk space
df -h

# Check CPU
nproc

Minimum requirements: 2 vCPU, 4GB RAM, 20GB disk space.

Next Steps

First Pentest

Run your first penetration test

Custom Assistants

Create custom AI assistants

Distributed Setup

Configure two-node deployment

Best Practices

Security and ethical guidelines

Setup Guides

Usage Guides

Advanced

Interactive Installer Setup

Overview

System Requirements

Supported Platforms

Linux

Windows

macOS

Quick Installation

Prerequisites & Permissions

Option 1: Run as Root (Recommended for Production)

Option 2: Docker Group Access (Development)

Installation Process

1. System Checks

2. Environment Setup

3. Provider Configuration

4. Search Engine Configuration

5. Security Hardening

6. Deployment

Accessing PentAGI

Post-Installation Configuration

Configure Docker Environment

Enable Optional Services

Troubleshooting

Docker Connection Issues

Installation Failures

Next Steps

First Pentest

Custom Assistants

Distributed Setup

Best Practices

Build docs developers (and LLMs) love

Setup Guides

Usage Guides

Advanced

​Overview

​System Requirements

​Supported Platforms

​Linux

​Windows

​macOS

​Quick Installation

​Prerequisites & Permissions

​Option 1: Run as Root (Recommended for Production)

​Option 2: Docker Group Access (Development)

​Installation Process

​1. System Checks

​2. Environment Setup

​3. Provider Configuration

​4. Search Engine Configuration

​5. Security Hardening

​6. Deployment

​Accessing PentAGI

​Post-Installation Configuration

​Configure Docker Environment

​Enable Optional Services

​Troubleshooting

​Docker Connection Issues

​Installation Failures

​Next Steps

First Pentest

Custom Assistants

Distributed Setup

Best Practices

Build docs developers (and LLMs) love

Overview

System Requirements

Supported Platforms

Linux

Windows

macOS

Quick Installation

Prerequisites & Permissions

Option 1: Run as Root (Recommended for Production)

Option 2: Docker Group Access (Development)

Installation Process

1. System Checks

2. Environment Setup

3. Provider Configuration

4. Search Engine Configuration

5. Security Hardening

6. Deployment

Accessing PentAGI

Post-Installation Configuration

Configure Docker Environment

Enable Optional Services

Troubleshooting

Docker Connection Issues

Installation Failures

Next Steps