Hugging Face's logo

AbdulElahGwaith
/
AI-Infra-Guard

Model card Files
xet
Community
AI-Infra-Guard / common /websocket /static /aigdocs /docs /getting-started_en.md
AbdulElahGwaith's picture
AbdulElahGwaith
Upload folder using huggingface_hub
ffb6330 verified
preview code
|
raw
history blame contribute delete
3.07 kB

Getting Started

This section will guide you on how to quickly deploy and use A.I.G.

System Requirements

  • Docker 20.10 or higher
  • At least 4GB of available RAM
  • At least 10GB of available disk space

Method 1: One-Click Install Script （Recommended）

# This method will automatically install Docker and launch A.I.G with one command  
curl https://raw.githubusercontent.com/Tencent/AI-Infra-Guard/refs/heads/main/docker.sh | bash

Method 2: Run with pre-built images (Recommended)

git clone https://github.com/Tencent/AI-Infra-Guard.git
cd AI-Infra-Guard
# This method pulls pre-built images from Docker Hub for a faster start
docker-compose -f docker-compose.images.yml up -d

Method 3: Build from source and run

git clone https://github.com/Tencent/AI-Infra-Guard.git
cd AI-Infra-Guard
# This method builds a Docker image from local source code and starts the service
docker-compose up -d

Once the installation is complete, you can access the A.I.G Web UI by visiting http://localhost:8088 in your browser.

Directory Structure

Directory/File Description Mount Path
uploads/ Uploads directory /ai-infra-guard/uploads
db/ Database file directory /ai-infra-guard/db
data/ Knowledge base data directory (Jailbreak Datasets, fingerprints, vulnerabilities) /ai-infra-guard/data
logs/ Application log directory /ai-infra-guard/logs

🔑 LLM API Requirement

A.I.G require an LLM API key. Configure your key in Settings before using these services.

image-20250814173229996

Fill in the Model Name, API Key, and Base URL, then click Save.

image-20250813113550192

Frequently Asked Questions

1.Port Conflict

# Modify the webserver port mapping
ports:
  - "8080:8088"  # Use port 8080

2.Permission Issues

# Ensure the data directory has read/write permissions
sudo chown -R $USER:$USER ./data

3.Service Startup Failure

# View detailed logs
docker-compose logs webserver
docker-compose logs agent

4.Stopping the Service

# Stop the service
docker-compose down
# Stop the service and remove data volumes (use with caution)
docker-compose down -v

Updating the Deployment

To upgrade to the latest version and clean up obsolete resources:

# Rebuild container images and restart services
docker-compose -f docker-compose.images.yml up -d --build
# Prune dangling Docker images (optional cleanup)
docker image prune -f