Skip to main content

Docker Setup

Complete guide for deploying UIP - Urban Intelligence Platform using Docker and Docker Compose.

πŸ“¦ Overview​

Docker Compose provides a streamlined way to deploy the entire UIP stack with a single command. This includes:

  • Backend API Server (FastAPI)
  • Frontend Web Application (React + Vite)
  • Neo4j Graph Database
  • MongoDB Document Database
  • Redis Cache
  • NGSI-LD Context Broker (Stellio)
  • Apache Jena Fuseki (RDF Triplestore)

πŸš€ Quick Start​

1. Clone the Repository​

git clone https://github.com/UIP-Urban-Intelligence-Platform/UIP-Urban_Intelligence_Platform.git
cd UIP-Urban_Intelligence_Platform

2. Start All Services​

docker-compose up -d

3. Verify Services​

docker-compose ps

Expected output:

NAME                STATUS       PORTS
uip-backend         Up           0.0.0.0:8001->8001/tcp
uip-frontend        Up           0.0.0.0:5173->5173/tcp
uip-neo4j           Up           0.0.0.0:7474->7474/tcp, 0.0.0.0:7687->7687/tcp
uip-mongo           Up           0.0.0.0:27017->27017/tcp
uip-redis           Up           0.0.0.0:6379->6379/tcp

πŸ”§ Configuration​

Environment Variables​

Create a .env file in the project root:

# Application
APP_ENV=production
DEBUG=false

# API Configuration
API_HOST=0.0.0.0
API_PORT=8001

# Database URLs
MONGO_URI=mongodb://mongo:27017/hcmc_traffic
NEO4J_URI=bolt://neo4j:7687
NEO4J_USER=neo4j
NEO4J_PASSWORD=your_secure_password

# Redis
REDIS_URL=redis://redis:6379

# Context Broker
STELLIO_URL=http://stellio:8080
FUSEKI_URL=http://fuseki:3030

Docker Compose Override​

For development, create docker-compose.override.yml:

version: '3.8'

services:
  backend:
    volumes:
      - ./src:/app/src:ro
    environment:
      - DEBUG=true
    command: ["uvicorn", "src.api.main:app", "--reload", "--host", "0.0.0.0", "--port", "8001"]
  
  frontend:
    volumes:
      - ./apps/traffic-web-app/frontend/src:/app/src:ro
    command: ["npm", "run", "dev", "--", "--host"]

πŸ“Š Service Details​

Backend API (Port 8001)​

# Access API documentation
http://localhost:8001/docs

# Health check
curl http://localhost:8001/health

Frontend (Port 5173)​

# Access web application
http://localhost:5173

Neo4j Browser (Port 7474)​

# Access Neo4j browser
http://localhost:7474

# Default credentials
Username: neo4j
Password: (set in .env)

MongoDB (Port 27017)​

# Connect with mongosh
mongosh mongodb://localhost:27017/hcmc_traffic

Redis (Port 6379)​

# Connect with redis-cli
redis-cli -h localhost -p 6379

πŸ”„ Common Operations​

View Logs​

# All services
docker-compose logs -f

# Specific service
docker-compose logs -f backend

# Last 100 lines
docker-compose logs --tail=100 backend

Restart Services​

# Restart all
docker-compose restart

# Restart specific service
docker-compose restart backend

Stop and Remove​

# Stop all services
docker-compose down

# Stop and remove volumes (WARNING: deletes data)
docker-compose down -v

Rebuild Images​

# Rebuild all images
docker-compose build

# Rebuild without cache
docker-compose build --no-cache

# Rebuild and restart
docker-compose up -d --build

πŸ› Troubleshooting​

Service Not Starting​

# Check service status
docker-compose ps

# View error logs
docker-compose logs <service-name>

# Check resource usage
docker stats

Port Already in Use​

# Find process using port
netstat -ano | findstr :8001

# Kill process (Windows)
taskkill /PID <PID> /F

# Kill process (Linux/macOS)
lsof -i :8001
kill -9 <PID>

Database Connection Issues​

# Check network
docker network ls
docker network inspect uip-network

# Verify container connectivity
docker-compose exec backend ping mongo

Low Disk Space​

# Clean unused images and volumes
docker system prune -a
docker volume prune

πŸ“ˆ Production Deployment​

For production, consider:

  1. Use environment-specific compose files:

    docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d

  2. Set secure passwords

  3. Enable HTTPS with reverse proxy (nginx/traefik)

  4. Configure resource limits

  5. Set up monitoring (Prometheus + Grafana)

  6. Implement backup strategies

πŸ“– Next Steps​

Need help? Check our GitHub Issues.