Add VitePress documentation site with complete user guides
Covers getting started, repositories, scanning, findings, configuration, SBOM, code graph, impact analysis, DAST, AI chat, issue tracker integration, Docker deployment, environment variables, Keycloak auth, and OpenTelemetry. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
84
docs/deployment/environment.md
Normal file
84
docs/deployment/environment.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# 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
|
||||
```
|
||||
|
||||
## Observability
|
||||
|
||||
```bash
|
||||
# Set to enable OpenTelemetry export (omit to disable)
|
||||
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
|
||||
OTEL_SERVICE_NAME=compliance-agent
|
||||
```
|
||||
Reference in New Issue
Block a user