Skip to content

README.docker.md

Latest commit

 

History

History
174 lines (131 loc) · 3.83 KB

README.docker.md

File metadata and controls

174 lines (131 loc) · 3.83 KB

Docker Setup Guide

This guide covers how to run the GitHub Process Manager using Docker.

Prerequisites

Quick Start

1. Configure Environment Variables

Copy the .env.template to .env and update with your API keys:

cp .env.template .env

Edit .env and add:

  • GEMINI_API_KEY - Your Google Gemini API key
  • GITHUB_TOKEN - Your GitHub personal access token (optional)
  • GITHUB_REPO_URL - Your GitHub repository URL (optional)

2. Build and Run with Docker Compose

Development Mode (with hot reload):

docker-compose up -d

Production Mode:

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

3. Access the Application

Open your browser and navigate to:

Docker Commands

View Logs

docker-compose logs -f app

Stop the Application

docker-compose down

Rebuild After Code Changes

docker-compose up -d --build

Access Container Shell

docker-compose exec app /bin/bash

Clean Up Everything (including volumes)

docker-compose down -v

VS Code Dev Container

Prerequisites

Setup

  1. Open the project folder in VS Code
  2. Press F1 and select "Remote-Containers: Reopen in Container"
  3. VS Code will build the container and set up the development environment
  4. All dependencies will be installed automatically

Features

The dev container includes:

  • Python 3.11 environment
  • All project dependencies pre-installed
  • VS Code extensions for Python development
  • Git and GitHub CLI
  • Auto-formatting and linting configured

Volume Persistence

Docker Compose uses named volumes to persist data:

  • chroma_data: Vector database storage
  • uploads_data: Uploaded documents
  • reports_data: Generated Word documents

These volumes persist even when containers are stopped or removed.

Troubleshooting

Port Already in Use

If port 5000 is already in use, edit docker-compose.yml:

ports:
  - "8080:5000"  # Change 8080 to any available port

Permission Issues

If you encounter permission issues with volumes:

docker-compose exec app chown -R $(id -u):$(id -g) /app/chroma_db /app/uploads /app/generated_reports

Container Won't Start

Check logs for errors:

docker-compose logs app

Clean Slate

Remove all containers, volumes, and images:

docker-compose down -v
docker rmi github-process-manager_app
docker-compose up -d --build

Production Deployment

For production deployment:

  1. Use docker-compose.prod.yml
  2. Set FLASK_DEBUG=False in .env
  3. Use a reverse proxy (nginx/traefik) for HTTPS
  4. Set up proper secret management
  5. Configure resource limits

Example with resource limits:

services:
  app:
    # ... other config
    deploy:
      resources:
        limits:
          cpus: '1'
          memory: 1G
        reservations:
          cpus: '0.5'
          memory: 512M

Security Notes

  • Never commit your .env file
  • Use Docker secrets in production for sensitive data
  • Keep the Docker image updated
  • Run containers as non-root user in production
  • Use read-only filesystem where possible

Building for Different Architectures

Build for ARM64 (e.g., Apple Silicon, Raspberry Pi):

docker buildx build --platform linux/arm64 -t github-process-manager:arm64 .

Build multi-architecture image:

docker buildx build --platform linux/amd64,linux/arm64 -t github-process-manager:latest .