1bf25525d8
All checks were successful
CI / Tests (push) Has been skipped
CI / Format (pull_request) Successful in 3s
CI / Clippy (pull_request) Successful in 3m59s
CI / Security Audit (pull_request) Has been skipped
CI / Tests (pull_request) Has been skipped
CI / Format (push) Successful in 3s
CI / Clippy (push) Successful in 3m56s
CI / Security Audit (push) Has been skipped
CI / Deploy Agent (pull_request) Has been skipped
CI / Deploy Dashboard (pull_request) Has been skipped
CI / Deploy Docs (pull_request) Has been skipped
CI / Deploy MCP (pull_request) Has been skipped
CI / Deploy Agent (push) Has been skipped
CI / Deploy Dashboard (push) Has been skipped
CI / Deploy Docs (push) Has been skipped
CI / Deploy MCP (push) Has been skipped
CI / Detect Changes (pull_request) Has been skipped
CI / Detect Changes (push) Has been skipped
New feature page covering architecture, available tools, local/HTTP usage, Docker deployment, Coolify setup, dashboard management, and example queries. Updated environment variable reference and configuration guide with MCP_PORT. Added sidebar nav entry. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
94 lines
1.6 KiB
Markdown
94 lines
1.6 KiB
Markdown
# Environment Variables
|
|
|
|
Complete reference for all environment variables. See [Configuration](/guide/configuration) for detailed descriptions of each variable.
|
|
|
|
## Required
|
|
|
|
```bash
|
|
# MongoDB connection
|
|
MONGODB_URI=mongodb://root:example@localhost:27017/compliance_scanner?authSource=admin
|
|
```
|
|
|
|
## Agent
|
|
|
|
```bash
|
|
AGENT_PORT=3001
|
|
SCAN_SCHEDULE=0 0 */6 * * *
|
|
CVE_MONITOR_SCHEDULE=0 0 0 * * *
|
|
GIT_CLONE_BASE_PATH=/tmp/compliance-scanner/repos
|
|
MONGODB_DATABASE=compliance_scanner
|
|
```
|
|
|
|
## Dashboard
|
|
|
|
```bash
|
|
DASHBOARD_PORT=8080
|
|
AGENT_API_URL=http://localhost:3001
|
|
```
|
|
|
|
## LLM / AI
|
|
|
|
```bash
|
|
LITELLM_URL=http://localhost:4000
|
|
LITELLM_API_KEY=
|
|
LITELLM_MODEL=gpt-4o
|
|
LITELLM_EMBED_MODEL=text-embedding-3-small
|
|
```
|
|
|
|
## Git Providers
|
|
|
|
```bash
|
|
# GitHub
|
|
GITHUB_TOKEN=
|
|
GITHUB_WEBHOOK_SECRET=
|
|
|
|
# GitLab
|
|
GITLAB_URL=https://gitlab.com
|
|
GITLAB_TOKEN=
|
|
GITLAB_WEBHOOK_SECRET=
|
|
```
|
|
|
|
## Issue Trackers
|
|
|
|
```bash
|
|
# Jira
|
|
JIRA_URL=
|
|
JIRA_EMAIL=
|
|
JIRA_API_TOKEN=
|
|
JIRA_PROJECT_KEY=
|
|
```
|
|
|
|
## External Services
|
|
|
|
```bash
|
|
SEARXNG_URL=http://localhost:8888
|
|
NVD_API_KEY=
|
|
```
|
|
|
|
## Authentication
|
|
|
|
```bash
|
|
KEYCLOAK_URL=http://localhost:8080
|
|
KEYCLOAK_REALM=compliance
|
|
KEYCLOAK_CLIENT_ID=compliance-dashboard
|
|
REDIRECT_URI=http://localhost:8080/auth/callback
|
|
APP_URL=http://localhost:8080
|
|
```
|
|
|
|
## MCP Server
|
|
|
|
```bash
|
|
MONGODB_URI=mongodb://root:example@localhost:27017/compliance_scanner?authSource=admin
|
|
MONGODB_DATABASE=compliance_scanner
|
|
# Set to enable HTTP transport (omit for stdio)
|
|
MCP_PORT=8090
|
|
```
|
|
|
|
## Observability
|
|
|
|
```bash
|
|
# Set to enable OpenTelemetry export (omit to disable)
|
|
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
|
|
OTEL_SERVICE_NAME=compliance-agent
|
|
```
|