docs: the README says what PentAGI is, who it is for, how it differs and how to install it

The overview was generic; it now answers those four questions in the wording of pentagi.com. The README, config.md and the installation guide no longer list MCP among the server-side settings: the open-source edition has no MCP code, and Enterprise adds MCP servers. SearXNG is spelled as its project spells it. Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-11-07 11:55:59 -10:00 · 2026-10-10 03:53:25 +07:00
1 parent e7f3000832
commit 843dfeb4bf
@@ -57,7 +57,13 @@

 ## Overview

-PentAGI is an innovative tool for automated security testing that leverages cutting-edge artificial intelligence technologies. The project is designed for information security professionals, researchers, and enthusiasts who need a powerful and flexible solution for conducting penetration tests. PentAGI is developed by [VXControl](https://vxcontrol.com), a security engineering company based in Dubai.
+PentAGI is an open-source, self-hosted multi-agent system for autonomous penetration testing. You describe a target and a goal in plain language; a team of specialized AI agents plans the work, runs 20+ professional tools such as nmap, Metasploit and sqlmap inside an isolated Docker sandbox, remembers what it learned and hands you a report.
+
+- **Who it is for.** Security engineers, penetration testers, researchers and red teams who want an autonomous assistant on their own infrastructure, for authorized testing only.
+- **What sets it apart.** It runs on your own servers with the model of your choice: 10+ cloud LLM providers, your own OpenAI-compatible gateway, or local models through Ollama or vLLM. Results and successful approaches are kept in PostgreSQL with pgvector for later flows, an optional Neo4j knowledge graph tracks hosts, services and findings, execution monitoring and task planning help smaller open models, and REST and GraphQL APIs automate it. PentAGI Enterprise adds agent profiles, plugins and MCP servers, customer-ready reports and a real-time attack-chain view.
+- **How to install.** An interactive installer for Linux, macOS and Windows sets PentAGI up with Docker Compose — see [Quick Start](#quick-start).
+
+PentAGI is developed by [VXControl](https://vxcontrol.com), a security engineering company based in Dubai.

 You can watch the video **PentAGI overview**:
 [![PentAGI Overview Video](https://github.com/user-attachments/assets/0828dc3e-15f1-4a1d-858e-9696a146e478)](https://youtu.be/R70x5Ddzs1o)
@@ -70,7 +76,7 @@ You can watch the video **PentAGI overview**:
 - Smart Memory System. Long-term storage of research results and successful approaches for future use.
 - Optional Knowledge Graph Integration. Graphiti-powered knowledge graph using Neo4j for semantic relationship tracking and advanced context understanding.
 - Web Intelligence. Built-in browser via [scraper](https://hub.docker.com/r/vxcontrol/scraper) for gathering latest information from web sources.
- External Search Systems. Integration with advanced search APIs including [Tavily](https://tavily.com), [Firecrawl](https://www.firecrawl.dev), [Traversaal](https://traversaal.ai), [Perplexity](https://www.perplexity.ai), [DuckDuckGo](https://duckduckgo.com/), [Google Custom Search](https://programmablesearchengine.google.com/), [Sploitus Search](https://sploitus.com) and [Searxng](https://searxng.org) for comprehensive information gathering.
+- External Search Systems. Integration with advanced search APIs including [Tavily](https://tavily.com), [Firecrawl](https://www.firecrawl.dev), [Traversaal](https://traversaal.ai), [Perplexity](https://www.perplexity.ai), [DuckDuckGo](https://duckduckgo.com/), [Google Custom Search](https://programmablesearchengine.google.com/), [Sploitus Search](https://sploitus.com) and [SearXNG](https://searxng.org) for comprehensive information gathering.
 - Team of Specialists. Delegation system with specialized AI agents for research, development, and infrastructure tasks, enhanced with optional execution monitoring and intelligent task planning for optimal performance with smaller models.
 - Comprehensive Monitoring. Detailed logging and integration with Grafana/Prometheus for real-time system observation.
 - Detailed Reporting. Generation of thorough vulnerability reports with exploitation guides.
@@ -112,7 +118,7 @@ flowchart TB
    llm["🧠 llm-provider
    (OpenAI/Anthropic/Ollama/Bedrock/Gemini/Custom)"]
    search["🔍 search-systems
-    (Google/DuckDuckGo/Tavily/Firecrawl/Traversaal/Perplexity/Sploitus/Searxng)"]
+    (Google/DuckDuckGo/Tavily/Firecrawl/Traversaal/Perplexity/Sploitus/SearXNG)"]
    langfuse["📊 langfuse-ui
    (LLM Observability Dashboard)"]
    grafana["📈 grafana
@@ -641,7 +647,7 @@ The installer will:
 1. **System Checks**: Verify Docker, network connectivity, and system requirements
 2. **Environment Setup**: Create and configure `.env` file with optimal defaults
 3. **Provider Configuration**: Set up LLM providers (OpenAI, Anthropic, Gemini, Bedrock, Ollama, DeepSeek, GLM, Kimi, Qwen, MiniMax, Mistral, xAI, Custom)
-4. **Search Engines**: Configure DuckDuckGo, Google, Tavily, Firecrawl, Traversaal, Perplexity, Sploitus, Searxng, and the optional internal browser-analytics fallback engine
+4. **Search Engines**: Configure DuckDuckGo, Google, Tavily, Firecrawl, Traversaal, Perplexity, Sploitus, SearXNG, and the optional internal browser-analytics fallback engine
 5. **Security Hardening**: Generate secure credentials and configure SSL certificates
 6. **Deployment**: Start PentAGI with docker-compose

@@ -661,7 +667,6 @@ The following configuration areas still need to be set on the server through env
 - **LLM credentials and connection details**: API keys, endpoints, auth modes, and provider-specific connection settings for OpenAI, Anthropic, Bedrock, Ollama, custom providers, and similar backends; config-path settings apply only where supported, such as `OLLAMA_SERVER_CONFIG_PATH`, `LLM_SERVER_CONFIG_PATH`, and `BEDROCK_CONFIG_PATH`.
 - **Search provider credentials and options**: Settings such as `DUCKDUCKGO_*`, `GOOGLE_*`, `TAVILY_API_KEY`, `FIRECRAWL_API_*`, `TRAVERSAAL_API_KEY`, `PERPLEXITY_*`, `SEARXNG_*`, `SPLOITUS_ENABLED`, and the optional `WEB_SEARCH_INTERNAL_*` browser-analytics fallback settings.
 - **Third-party integrations**: Langfuse, Graphiti, and similar external services remain server-side configuration.
- **MCP server management**: MCP settings pages are not currently exposed as a live web-console feature.

 **For Production & Enhanced Security:**

@@ -797,7 +802,7 @@ PERPLEXITY_API_KEY=your_perplexity_key
 PERPLEXITY_MODEL=
 PERPLEXITY_CONTEXT_SIZE=medium

-# Searxng meta search engine (aggregates results from multiple sources)
+# SearXNG meta search engine (aggregates results from multiple sources)
 SEARXNG_URL=http://your-searxng-instance:8080
 SEARXNG_CATEGORIES=general
 SEARXNG_LANGUAGE=
@@ -3956,7 +3961,7 @@ go run cmd/ftester/main.go browser
 - **traversaal**: Search using Traversaal AI search engine
 - **perplexity**: Search using Perplexity AI
 - **sploitus**: Search for security exploits, vulnerabilities (CVEs), and pentesting tools
- **searxng**: Search using Searxng meta search engine (aggregates results from multiple engines)
+- **searxng**: Search using SearXNG meta search engine (aggregates results from multiple engines)
 - **internal** *(ftester-only debug function, not an agent tool)*: Opt-in browser-analytics fallback engine that discovers links, scrapes each page, and summarizes the result; requires `WEB_SEARCH_INTERNAL_ENABLED=true`, a configured scraper, and at least one available link engine

 ### Vector Database Functions
@@ -141,9 +141,8 @@ These web-console features do not replace the environment variables in this guid
 The environment variables documented below remain the source of truth for configuration that is not currently editable from the web console:

 - **LLM credentials and connection settings**: API keys, base URLs, auth modes, and provider-specific connection settings for OpenAI, Anthropic, Bedrock, Ollama, custom providers, and similar backends; config-path settings apply only where supported, such as `OLLAMA_SERVER_CONFIG_PATH`, `LLM_SERVER_CONFIG_PATH`, and `BEDROCK_CONFIG_PATH`.
- **Search provider credentials and options**: DuckDuckGo, Google, Tavily, Traversaal, Perplexity, Searxng, Sploitus, and related search configuration.
+- **Search provider credentials and options**: DuckDuckGo, Google, Tavily, Traversaal, Perplexity, SearXNG, Sploitus, and related search configuration.
 - **Third-party integrations**: Langfuse, Graphiti, and other external observability or knowledge services.
- **MCP server management**: MCP settings are not currently exposed as a live web-console feature.

 ## General Settings

@@ -92,7 +92,7 @@ Run the base `docker-compose.yml` first so the shared Docker networks exist, the
 3. Re-run `ctester` and `etester` if you changed any provider settings. For deeper checks of individual agent functions and tools, use `ftester` (see [Function Testing with ftester](https://github.com/vxcontrol/pentagi#function-testing-with-ftester)).
 4. Open `https://localhost:8443` (or your `PUBLIC_URL`) and sign in with the default `[email protected]` / `admin`, then change the password immediately.

-After the server is running, several areas are managed in the web console under Settings (Providers, Prompts, PentAGI API tokens), while LLM and search credentials, Langfuse, Graphiti, and MCP remain server-side configuration. See [Current Web Settings Coverage](https://github.com/vxcontrol/pentagi#current-web-settings-coverage) for the exact split.
+After the server is running, several areas are managed in the web console under Settings (Providers, Prompts, PentAGI API tokens), while LLM and search credentials, Langfuse and Graphiti remain server-side configuration. See [Current Web Settings Coverage](https://github.com/vxcontrol/pentagi#current-web-settings-coverage) for the exact split.

 ## First-run configuration checklist