Skip to main content

​
Comparison of deployment methods

MethodSuitable scenarioData locationOnline time
Cloud SaaSQuick verification, small and medium-sized teamsZGI Cloud (encrypted storage)Ready to use
Docker ComposeDevelopment environment, small-scale productionCorporate intranet1 hour
KubernetesProduction high availabilityEnterprise intranet30 minutes
Privatized Enterprise EditionFinance, government affairs, medical complianceComplete self-control3 working days

​
System requirements (privatized deployment)

ComponentsMinimum ConfigurationRecommended Configuration
Operating SystemLinux (Ubuntu 20.04+)Ubuntu 22.04 LTS
Processor8 cores16 cores+
Memory16 GB32 GB+
Storage100 GB SSD500 GB SSD+
Docker20.10+Kubernetes 1.24+

​
Open Source Edition Deployment — Quick Start

The ZGI core framework is completely open source on GitHub, and anyone can start the complete service stack directly from the source code.

​
Warehouse structure

Use git submodule to organize multiple warehouses, and the top-level warehouse is responsible for product-level aggregation:
CatalogDescriptionWarehouse address
api/Backend service (Go)zgiai/zgi-api
web/Front-end application (React)zgiai/zgi-web
sandbox/Code execution sandboxzgiai/zgi-sandbox
plugin-runner/Plug-in execution servicezgiai/zgi-plugin-runner
docker/Shared middleware and deployment assets—
# Clone repository
git clone https://github.com/zgiai/zgi.git
cd zgi

# Start the complete Docker stack with one click
make dev-docker
make dev-docker will be automatically completed when run for the first time Initialize submodule → Copy missing env template → Regenerate root compose → Start full Docker stack. No manual work required.

​
Mainland China network acceleration

If the image build is slow or unstable, you can use the --china mode to inject the recommended image source configuration (the template file will not be rewritten): 
./dev/start-docker --china

​
Environment variable management

# Check differences between local env and template
make env-check

# Append missing items (does not overwrite existing values)
make env-sync

​
macOS/Linux — Source code development model

# Initialize development environment
make setup

# Start middleware (database, cache, etc.)
make dev-docker

# Start the backend and frontend separately
make dev-api
make dev-web

​
Windows Deployment

Minimum support for Windows is Docker Desktop + PowerShell. Source code development aids rely on Unix-like shells and are not available on Windows. 
# PowerShell
.\dev\start-docker.ps1

# PowerShell (domestic mirror)
.\dev\start-docker.ps1 -china

​
Default service address

ServicesAddressDescription
Web front-endhttp://localhost:13000Console interface
API Backendhttp://localhost:2678REST API
PostgreSQLlocalhost:15432Master database
Redislocalhost:16379Cache and message queue
Weaviatehttp://localhost:18080Vector database
Neo4j HTTPhttp://localhost:17474Knowledge Graph
Sandboxhttp://localhost:18194Code execution sandbox
Plugin Runnerhttp://localhost:15000Plug-in execution service

​
Kubernetes deployment

# Add ZGI Helm repository
helm repo add zgi https://charts.zgi.cn

# Install
helm install zgi zgi/zgi \
  --namespace zgi --create-namespace \
  --set global.storageClass=your-storage-class \
  --values values-production.yaml