|
| 1 | +# PentAGI Environment Variables |
| 2 | + |
| 3 | +## For communication with PentAGI Cloud API |
| 4 | +INSTALLATION_ID= |
| 5 | +LICENSE_KEY= |
| 6 | + |
| 7 | +## Allow to interact with user while executing tasks |
| 8 | +ASK_USER= |
| 9 | + |
| 10 | +## LLM Providers |
| 11 | +OPEN_AI_KEY= |
| 12 | +OPEN_AI_SERVER_URL=https://api.openai.com/v1 |
| 13 | + |
| 14 | +ANTHROPIC_API_KEY= |
| 15 | +ANTHROPIC_SERVER_URL=https://api.anthropic.com/v1 |
| 16 | + |
| 17 | +## Google AI (Gemini) LLM provider |
| 18 | +GEMINI_API_KEY= |
| 19 | +GEMINI_SERVER_URL=https://generativelanguage.googleapis.com |
| 20 | + |
| 21 | +## AWS Bedrock LLM provider |
| 22 | +BEDROCK_REGION=us-east-1 |
| 23 | +BEDROCK_DEFAULT_AUTH= |
| 24 | +BEDROCK_BEARER_TOKEN= |
| 25 | +BEDROCK_ACCESS_KEY_ID= |
| 26 | +BEDROCK_SECRET_ACCESS_KEY= |
| 27 | +BEDROCK_SESSION_TOKEN= |
| 28 | +BEDROCK_SERVER_URL= |
| 29 | + |
| 30 | +## DeepSeek LLM provider |
| 31 | +DEEPSEEK_API_KEY= |
| 32 | +DEEPSEEK_SERVER_URL=https://api.deepseek.com |
| 33 | +DEEPSEEK_PROVIDER= |
| 34 | + |
| 35 | +## GLM (Zhipu AI) LLM provider |
| 36 | +GLM_API_KEY= |
| 37 | +GLM_SERVER_URL=https://api.z.ai/api/paas/v4 |
| 38 | +GLM_PROVIDER= |
| 39 | + |
| 40 | +## Kimi (Moonshot) LLM provider |
| 41 | +KIMI_API_KEY= |
| 42 | +KIMI_SERVER_URL=https://api.moonshot.ai/v1 |
| 43 | +KIMI_PROVIDER= |
| 44 | + |
| 45 | +## Qwen (Alibaba Cloud DashScope) LLM provider |
| 46 | +QWEN_API_KEY= |
| 47 | +QWEN_SERVER_URL=https://dashscope-us.aliyuncs.com/compatible-mode/v1 |
| 48 | +QWEN_PROVIDER= |
| 49 | + |
| 50 | +## Custom LLM provider |
| 51 | +LLM_SERVER_URL= |
| 52 | +LLM_SERVER_KEY= |
| 53 | +LLM_SERVER_MODEL= |
| 54 | +LLM_SERVER_PROVIDER= |
| 55 | +LLM_SERVER_CONFIG_PATH= |
| 56 | +LLM_SERVER_LEGACY_REASONING= |
| 57 | +LLM_SERVER_PRESERVE_REASONING= |
| 58 | + |
| 59 | +## Ollama LLM provider (Local Server or Cloud) |
| 60 | +# Local: http://ollama-server:11434, Cloud: https://ollama.com |
| 61 | +OLLAMA_SERVER_URL= |
| 62 | +# Required for Ollama Cloud (https://ollama.com/settings/keys), leave empty for local |
| 63 | +OLLAMA_SERVER_API_KEY= |
| 64 | +OLLAMA_SERVER_MODEL= |
| 65 | +OLLAMA_SERVER_CONFIG_PATH= |
| 66 | +OLLAMA_SERVER_PULL_MODELS_TIMEOUT= |
| 67 | +OLLAMA_SERVER_PULL_MODELS_ENABLED= |
| 68 | +OLLAMA_SERVER_LOAD_MODELS_ENABLED= |
| 69 | + |
| 70 | +## Embedding |
| 71 | +EMBEDDING_URL= |
| 72 | +EMBEDDING_KEY= |
| 73 | +EMBEDDING_MODEL= |
| 74 | +EMBEDDING_PROVIDER= |
| 75 | +EMBEDDING_BATCH_SIZE= |
| 76 | +EMBEDDING_STRIP_NEW_LINES= |
| 77 | + |
| 78 | +## Summarizer |
| 79 | +SUMMARIZER_PRESERVE_LAST= |
| 80 | +SUMMARIZER_USE_QA= |
| 81 | +SUMMARIZER_SUM_MSG_HUMAN_IN_QA= |
| 82 | +SUMMARIZER_LAST_SEC_BYTES= |
| 83 | +SUMMARIZER_MAX_BP_BYTES= |
| 84 | +SUMMARIZER_MAX_QA_SECTIONS= |
| 85 | +SUMMARIZER_MAX_QA_BYTES= |
| 86 | +SUMMARIZER_KEEP_QA_SECTIONS= |
| 87 | + |
| 88 | +## Assistant |
| 89 | +ASSISTANT_USE_AGENTS= |
| 90 | +ASSISTANT_SUMMARIZER_PRESERVE_LAST= |
| 91 | +ASSISTANT_SUMMARIZER_LAST_SEC_BYTES= |
| 92 | +ASSISTANT_SUMMARIZER_MAX_BP_BYTES= |
| 93 | +ASSISTANT_SUMMARIZER_MAX_QA_SECTIONS= |
| 94 | +ASSISTANT_SUMMARIZER_MAX_QA_BYTES= |
| 95 | +ASSISTANT_SUMMARIZER_KEEP_QA_SECTIONS= |
| 96 | + |
| 97 | +## Execution Monitor Detector |
| 98 | +EXECUTION_MONITOR_ENABLED= |
| 99 | +EXECUTION_MONITOR_SAME_TOOL_LIMIT= |
| 100 | +EXECUTION_MONITOR_TOTAL_TOOL_LIMIT= |
| 101 | + |
| 102 | +## Agent execution tool calls limit |
| 103 | +MAX_GENERAL_AGENT_TOOL_CALLS= |
| 104 | +MAX_LIMITED_AGENT_TOOL_CALLS= |
| 105 | + |
| 106 | +## Agent planning step for pentester, coder, installer |
| 107 | +AGENT_PLANNING_STEP_ENABLED= |
| 108 | + |
| 109 | +## HTTP proxy to use it in isolation environment |
| 110 | +PROXY_URL= |
| 111 | + |
| 112 | +## SSL/TLS Certificate Configuration |
| 113 | +EXTERNAL_SSL_CA_PATH= |
| 114 | +EXTERNAL_SSL_INSECURE= |
| 115 | + |
| 116 | +## HTTP client timeout in seconds for external API calls (LLM providers, search tools, etc.) |
| 117 | +## Default: 600 (10 minutes). Set to 0 to use the default. |
| 118 | +HTTP_CLIENT_TIMEOUT= |
| 119 | + |
| 120 | +## Scraper URLs and settings |
| 121 | +## For Docker (default): |
| 122 | +SCRAPER_PUBLIC_URL= |
| 123 | +SCRAPER_PRIVATE_URL=https://someuser:somepass@scraper/ |
| 124 | +## For Podman rootless, use: SCRAPER_PRIVATE_URL=http://someuser:somepass@scraper:3000/ |
| 125 | +## See README.md "Running PentAGI with Podman" section for details |
| 126 | +LOCAL_SCRAPER_USERNAME=someuser |
| 127 | +LOCAL_SCRAPER_PASSWORD=somepass |
| 128 | +LOCAL_SCRAPER_MAX_CONCURRENT_SESSIONS=10 |
| 129 | + |
| 130 | +## PentAGI server settings (docker-compose.yml) |
| 131 | +PENTAGI_LISTEN_IP= |
| 132 | +PENTAGI_LISTEN_PORT= |
| 133 | +PENTAGI_DATA_DIR= |
| 134 | +PENTAGI_SSL_DIR= |
| 135 | +PENTAGI_OLLAMA_DIR= |
| 136 | +PENTAGI_DOCKER_SOCKET= |
| 137 | +PENTAGI_DOCKER_CERT_PATH= |
| 138 | +PENTAGI_LLM_SERVER_CONFIG_PATH= |
| 139 | +PENTAGI_OLLAMA_SERVER_CONFIG_PATH= |
| 140 | + |
| 141 | +## PentAGI security settings |
| 142 | +PUBLIC_URL=https://localhost:8443 |
| 143 | +CORS_ORIGINS=https://localhost:8443 |
| 144 | +COOKIE_SIGNING_SALT=salt # change this to improve security |
| 145 | + |
| 146 | +## PentAGI internal server settings (inside the container) |
| 147 | +STATIC_DIR= |
| 148 | +STATIC_URL= |
| 149 | +SERVER_PORT=8443 |
| 150 | +SERVER_HOST=0.0.0.0 |
| 151 | +SERVER_SSL_CRT= |
| 152 | +SERVER_SSL_KEY= |
| 153 | +SERVER_USE_SSL=true |
| 154 | + |
| 155 | +## OAuth google |
| 156 | +OAUTH_GOOGLE_CLIENT_ID= |
| 157 | +OAUTH_GOOGLE_CLIENT_SECRET= |
| 158 | + |
| 159 | +## OAuth github |
| 160 | +OAUTH_GITHUB_CLIENT_ID= |
| 161 | +OAUTH_GITHUB_CLIENT_SECRET= |
| 162 | + |
| 163 | +## DuckDuckGo search engine |
| 164 | +DUCKDUCKGO_ENABLED= |
| 165 | +DUCKDUCKGO_REGION= |
| 166 | +DUCKDUCKGO_SAFESEARCH= |
| 167 | +DUCKDUCKGO_TIME_RANGE= |
| 168 | + |
| 169 | +## Sploitus search engine API |
| 170 | +SPLOITUS_ENABLED= |
| 171 | + |
| 172 | +## Google search engine API |
| 173 | +GOOGLE_API_KEY= |
| 174 | +GOOGLE_CX_KEY= |
| 175 | +GOOGLE_LR_KEY= |
| 176 | + |
| 177 | +## Traversaal search engine API |
| 178 | +TRAVERSAAL_API_KEY= |
| 179 | + |
| 180 | +## Tavily search engine API |
| 181 | +TAVILY_API_KEY= |
| 182 | + |
| 183 | +## Perplexity search engine API |
| 184 | +PERPLEXITY_API_KEY= |
| 185 | +PERPLEXITY_MODEL= |
| 186 | +PERPLEXITY_CONTEXT_SIZE= |
| 187 | + |
| 188 | +## SEARXNG search engine API |
| 189 | +SEARXNG_URL= |
| 190 | +SEARXNG_CATEGORIES=general |
| 191 | +SEARXNG_LANGUAGE= |
| 192 | +SEARXNG_SAFESEARCH=0 |
| 193 | +SEARXNG_TIME_RANGE= |
| 194 | +SEARXNG_TIMEOUT= |
| 195 | + |
| 196 | +## Langfuse observability settings |
| 197 | +LANGFUSE_BASE_URL= |
| 198 | +LANGFUSE_PROJECT_ID= |
| 199 | +LANGFUSE_PUBLIC_KEY= |
| 200 | +LANGFUSE_SECRET_KEY= |
| 201 | + |
| 202 | +## OpenTelemetry observability settings |
| 203 | +OTEL_HOST= |
| 204 | + |
| 205 | +## Docker client settings to run primary terminal container |
| 206 | +DOCKER_HOST= |
| 207 | +DOCKER_TLS_VERIFY= |
| 208 | +DOCKER_CERT_PATH= |
| 209 | + |
| 210 | +## Docker settings inside primary terminal container |
| 211 | +DOCKER_INSIDE=true # enable to use docker socket |
| 212 | +DOCKER_NET_ADMIN=true # enable to use net_admin capability |
| 213 | +DOCKER_SOCKET=/var/run/docker.sock # path on host machine |
| 214 | +DOCKER_NETWORK= |
| 215 | +DOCKER_WORK_DIR= |
| 216 | +DOCKER_PUBLIC_IP=0.0.0.0 # public ip of host machine |
| 217 | +DOCKER_DEFAULT_IMAGE= |
| 218 | +DOCKER_DEFAULT_IMAGE_FOR_PENTEST= |
| 219 | + |
| 220 | +# Postgres (pgvector) settings |
| 221 | +PENTAGI_POSTGRES_USER=postgres |
| 222 | +PENTAGI_POSTGRES_PASSWORD=postgres # change this to improve security |
| 223 | +PENTAGI_POSTGRES_DB=pentagidb |
| 224 | + |
| 225 | +## Graphiti knowledge graph settings |
| 226 | +## Set GRAPHITI_ENABLED=true and GRAPHITI_URL=http://graphiti:8000 to enable embedded Graphiti |
| 227 | +GRAPHITI_ENABLED=false |
| 228 | +GRAPHITI_TIMEOUT=30 |
| 229 | +GRAPHITI_URL= |
| 230 | +GRAPHITI_MODEL_NAME= |
| 231 | + |
| 232 | +# Neo4j settings (used by Graphiti stack) |
| 233 | +NEO4J_USER=neo4j |
| 234 | +NEO4J_DATABASE=neo4j |
| 235 | +NEO4J_PASSWORD=devpassword # change this to improve security |
| 236 | +NEO4J_URI=bolt://neo4j:7687 |
| 237 | + |
| 238 | +## PentAGI image settings |
| 239 | +PENTAGI_IMAGE= |
| 240 | + |
| 241 | +## Scraper network settings |
| 242 | +## Default ports: SCRAPER_LISTEN_IP=127.0.0.1, SCRAPER_LISTEN_PORT=9443 |
| 243 | +## Note: These settings don't need to change for Podman rootless |
| 244 | +SCRAPER_LISTEN_IP= |
| 245 | +SCRAPER_LISTEN_PORT= |
| 246 | + |
| 247 | +## Postgres network settings |
| 248 | +PGVECTOR_LISTEN_IP= |
| 249 | +PGVECTOR_LISTEN_PORT= |
| 250 | + |
| 251 | +## Postgres Exporter network settings |
| 252 | +POSTGRES_EXPORTER_LISTEN_IP= |
| 253 | +POSTGRES_EXPORTER_LISTEN_PORT= |
| 254 | + |
| 255 | + |
| 256 | +# Langfuse Environment Variables |
| 257 | + |
| 258 | +## Langfuse server settings |
| 259 | +LANGFUSE_LISTEN_IP= |
| 260 | +LANGFUSE_LISTEN_PORT= |
| 261 | +LANGFUSE_NEXTAUTH_URL= |
| 262 | + |
| 263 | +## Langfuse Postgres |
| 264 | +LANGFUSE_POSTGRES_USER=postgres |
| 265 | +LANGFUSE_POSTGRES_PASSWORD=postgres # change this to improve security |
| 266 | +LANGFUSE_POSTGRES_DB=langfuse |
| 267 | + |
| 268 | +## Langfuse Clickhouse |
| 269 | +LANGFUSE_CLICKHOUSE_USER=clickhouse |
| 270 | +LANGFUSE_CLICKHOUSE_PASSWORD=clickhouse # change this to improve security |
| 271 | +LANGFUSE_CLICKHOUSE_URL=http://langfuse-clickhouse:8123 |
| 272 | +LANGFUSE_CLICKHOUSE_MIGRATION_URL=clickhouse://langfuse-clickhouse:9000 |
| 273 | +LANGFUSE_CLICKHOUSE_CLUSTER_ENABLED=false |
| 274 | + |
| 275 | +## Langfuse S3 |
| 276 | +LANGFUSE_S3_BUCKET=langfuse |
| 277 | +LANGFUSE_S3_REGION=auto |
| 278 | +LANGFUSE_S3_ACCESS_KEY_ID=accesskey # change this to improve security |
| 279 | +LANGFUSE_S3_SECRET_ACCESS_KEY=secretkey # change this to improve security |
| 280 | +LANGFUSE_S3_ENDPOINT=http://langfuse-minio:9000 |
| 281 | +LANGFUSE_S3_FORCE_PATH_STYLE=true |
| 282 | +LANGFUSE_S3_EVENT_UPLOAD_PREFIX=events/ |
| 283 | +LANGFUSE_S3_MEDIA_UPLOAD_PREFIX=media/ |
| 284 | +LANGFUSE_S3_BATCH_EXPORT_ENABLED=true |
| 285 | + |
| 286 | +## Langfuse Redis |
| 287 | +LANGFUSE_REDIS_HOST=langfuse-redis |
| 288 | +LANGFUSE_REDIS_PORT=6379 |
| 289 | +LANGFUSE_REDIS_AUTH=redispassword # change this to improve security |
| 290 | +LANGFUSE_REDIS_TLS_ENABLED=false |
| 291 | +LANGFUSE_REDIS_TLS_CA= |
| 292 | +LANGFUSE_REDIS_TLS_CERT= |
| 293 | +LANGFUSE_REDIS_TLS_KEY= |
| 294 | + |
| 295 | +## Langfuse web app security settings |
| 296 | +LANGFUSE_SALT=salt # change this to improve security |
| 297 | +LANGFUSE_ENCRYPTION_KEY=0000000000000000000000000000000000000000000000000000000000000000 # change this to improve security |
| 298 | + |
| 299 | +## Langfuse web app nextauth settings |
| 300 | +LANGFUSE_NEXTAUTH_URL=http://localhost:4000 |
| 301 | +LANGFUSE_NEXTAUTH_SECRET=secret # change this to improve security |
| 302 | + |
| 303 | +## Langfuse extra settings |
| 304 | +LANGFUSE_ENABLE_EXPERIMENTAL_FEATURES=true |
| 305 | +LANGFUSE_TELEMETRY_ENABLED=false |
| 306 | +LANGFUSE_LOG_LEVEL=info |
| 307 | + |
| 308 | +## Langfuse init settings |
| 309 | +LANGFUSE_INIT_ORG_ID=ocm47619l0000872mcd2dlbqwb |
| 310 | +LANGFUSE_INIT_ORG_NAME=PentAGI Org |
| 311 | +LANGFUSE_INIT_PROJECT_ID=cm47619l0000872mcd2dlbqwb |
| 312 | +LANGFUSE_INIT_PROJECT_NAME=PentAGI |
| 313 | +LANGFUSE_INIT_PROJECT_PUBLIC_KEY=pk-lf-00000000-0000-0000-0000-000000000000 # change this to improve security |
| 314 | +LANGFUSE_INIT_PROJECT_SECRET_KEY=sk-lf-00000000-0000-0000-0000-000000000000 # change this to improve security |
| 315 | +LANGFUSE_INIT_USER_EMAIL=admin@pentagi.com |
| 316 | +LANGFUSE_INIT_USER_NAME=admin |
| 317 | +LANGFUSE_INIT_USER_PASSWORD=password # change this to improve security |
| 318 | + |
| 319 | +## Langfuse SDK sync settings |
| 320 | +LANGFUSE_SDK_CI_SYNC_PROCESSING_ENABLED=false |
| 321 | +LANGFUSE_READ_FROM_POSTGRES_ONLY=false |
| 322 | +LANGFUSE_READ_FROM_CLICKHOUSE_ONLY=true |
| 323 | +LANGFUSE_RETURN_FROM_CLICKHOUSE=true |
| 324 | + |
| 325 | +## Langfuse ingestion tuning |
| 326 | +LANGFUSE_INGESTION_QUEUE_DELAY_MS= |
| 327 | +LANGFUSE_INGESTION_CLICKHOUSE_WRITE_INTERVAL_MS= |
| 328 | +LANGFUSE_INGESTION_CLICKHOUSE_WRITE_BATCH_SIZE= |
| 329 | +LANGFUSE_INGESTION_CLICKHOUSE_MAX_ATTEMPTS= |
| 330 | + |
| 331 | +## Langfuse email |
| 332 | +LANGFUSE_EMAIL_FROM_ADDRESS= |
| 333 | +LANGFUSE_SMTP_CONNECTION_URL= |
| 334 | + |
| 335 | +## Langfuse optional Azure blob |
| 336 | +LANGFUSE_USE_AZURE_BLOB=false |
| 337 | + |
| 338 | +## Langfuse license settings |
| 339 | +LANGFUSE_EE_LICENSE_KEY= |
| 340 | + |
| 341 | +## Langfuse OpenTelemetry settings |
| 342 | +LANGFUSE_OTEL_EXPORTER_OTLP_ENDPOINT= |
| 343 | +LANGFUSE_OTEL_SERVICE_NAME= |
| 344 | + |
| 345 | +## Langfuse custom oauth2 settings |
| 346 | +LANGFUSE_AUTH_CUSTOM_CLIENT_ID= |
| 347 | +LANGFUSE_AUTH_CUSTOM_CLIENT_SECRET= |
| 348 | +LANGFUSE_AUTH_CUSTOM_ISSUER= |
| 349 | +LANGFUSE_AUTH_CUSTOM_NAME=PentAGI |
| 350 | +LANGFUSE_AUTH_CUSTOM_SCOPE=openid email profile |
| 351 | +LANGFUSE_AUTH_CUSTOM_CLIENT_AUTH_METHOD=client_secret_post |
| 352 | +LANGFUSE_AUTH_CUSTOM_ALLOW_ACCOUNT_LINKING=true |
| 353 | + |
| 354 | +## Langfuse auth settings |
| 355 | +LANGFUSE_AUTH_DISABLE_SIGNUP=false # disable signup if PentAGI OAuth2 is used |
| 356 | +LANGFUSE_AUTH_SESSION_MAX_AGE=240 |
| 357 | + |
| 358 | +## Langfuse allowed organization creators |
| 359 | +LANGFUSE_ALLOWED_ORGANIZATION_CREATORS=admin@pentagi.com |
| 360 | + |
| 361 | +## Langfuse default settings for new users |
| 362 | +LANGFUSE_DEFAULT_ORG_ID=ocm47619l0000872mcd2dlbqwb |
| 363 | +LANGFUSE_DEFAULT_PROJECT_ID=cm47619l0000872mcd2dlbqwb |
| 364 | +LANGFUSE_DEFAULT_ORG_ROLE=VIEWER |
| 365 | +LANGFUSE_DEFAULT_PROJECT_ROLE=VIEWER |
| 366 | + |
| 367 | + |
| 368 | +# Observability Environment Variables |
| 369 | + |
| 370 | +## Observability server settings |
| 371 | +GRAFANA_LISTEN_IP= |
| 372 | +GRAFANA_LISTEN_PORT= |
| 373 | + |
| 374 | +## OpenTelemetry server settings |
| 375 | +OTEL_GRPC_LISTEN_IP= |
| 376 | +OTEL_GRPC_LISTEN_PORT= |
| 377 | +OTEL_HTTP_LISTEN_IP= |
| 378 | +OTEL_HTTP_LISTEN_PORT= |
0 commit comments