Spaces:
Runtime error
Download docker/README.md from Safe-Harbor/LLMGuardian: direct link, hf CLI and curl.
- Browser
- Download file 3.32 kB
-
https://huggingface.co/spaces/Safe-Harbor/LLMGuardian/resolve/main/docker/README.md
- Command line
-
hf download hf://spaces/Safe-Harbor/LLMGuardian/docker/README.md
-
curl -L -o README.md https://huggingface.co/spaces/Safe-Harbor/LLMGuardian/resolve/main/docker/README.md
A newer version of the Gradio SDK is available: 6.32.0
Docker Configuration
This directory contains Docker configuration for LLMGuardian.
Quick Start
Using Pre-built Images from GitHub Container Registry
Pull and run the latest image:
docker pull ghcr.io/dewitt4/llmguardian:latest
docker run -p 8000:8000 -p 8501:8501 ghcr.io/dewitt4/llmguardian:latest
Building Locally
Build the Docker image:
docker build -f docker/dockerfile -t llmguardian:local .
Run the container:
docker run -p 8000:8000 -p 8501:8501 llmguardian:local
Available Tags
latest- Latest stable release from main branchv*.*.*- Specific version tags (e.g., v1.0.0)main- Latest commit on main branchdevelop- Latest commit on develop branch
Environment Variables
Configure the container using environment variables:
docker run -p 8000:8000 \
-e SECURITY_RISK_THRESHOLD=8 \
-e LOG_LEVEL=DEBUG \
-e API_SERVER_PORT=8000 \
ghcr.io/dewitt4/llmguardian:latest
See .env.example in the root directory for all available environment variables.
Exposed Ports
8000- API Server8501- Dashboard (Streamlit)
Volume Mounts
Mount volumes for persistent data:
docker run -p 8000:8000 \
-v $(pwd)/logs:/app/logs \
-v $(pwd)/data:/app/data \
ghcr.io/dewitt4/llmguardian:latest
Docker Compose (Example)
Create a docker-compose.yml file:
version: '3.8'
services:
llmguardian-api:
image: ghcr.io/dewitt4/llmguardian:latest
ports:
- "8000:8000"
environment:
- LOG_LEVEL=INFO
- SECURITY_RISK_THRESHOLD=7
volumes:
- ./logs:/app/logs
- ./data:/app/data
restart: unless-stopped
llmguardian-dashboard:
image: ghcr.io/dewitt4/llmguardian:latest
command: ["streamlit", "run", "src/llmguardian/dashboard/app.py"]
ports:
- "8501:8501"
environment:
- DASHBOARD_PORT=8501
- DASHBOARD_HOST=0.0.0.0
depends_on:
- llmguardian-api
restart: unless-stopped
Run with:
docker-compose up -d
Health Check
The container includes a health check endpoint:
curl http://localhost:8000/health
Security Scanning
All published images are automatically scanned with Trivy for vulnerabilities. Check the Security tab for scan results.
Multi-Architecture Support
Images are built for both AMD64 and ARM64 architectures:
# Automatically pulls the correct architecture
docker pull ghcr.io/dewitt4/llmguardian:latest
Troubleshooting
Permission Issues
If you encounter permission issues with volume mounts:
docker run --user $(id -u):$(id -g) \
-v $(pwd)/logs:/app/logs \
ghcr.io/dewitt4/llmguardian:latest
View Logs
docker logs <container-id>
Interactive Shell
docker run -it --entrypoint /bin/bash ghcr.io/dewitt4/llmguardian:latest
CI/CD Integration
Images are automatically built and published via GitHub Actions:
- On push to main: Builds and publishes
latesttag - On version tags: Builds and publishes version-specific tags
- On pull requests: Builds image but doesn't publish
- Daily security scans: Automated Trivy scans
See .github/workflows/docker-publish.yml for workflow details.