Merge pull request #116 from korjavin/main

Dockerfiles for backend/frontend + github actions + docker-compose

Author: markokraemer

.github/workflows/docker-build.yml

@@ -0,0 +1,46 @@
+name: Build and Push Docker Images
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Backend image
+        uses: docker/build-push-action@v5
+        with:
+          context: ./backend
+          file: ./backend/Dockerfile
+          push: true
+          tags: ghcr.io/${{ github.repository }}/suna-backend:latest
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Build and push Frontend image
+        uses: docker/build-push-action@v5
+        with:
+          context: ./frontend
+          file: ./frontend/Dockerfile
+          push: true
+          tags: ghcr.io/${{ github.repository }}/suna-frontend:latest
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

README.md

@@ -94,7 +94,7 @@ You'll need the following components:
 
 ### Prerequisites
 
-1. **Supabase**: 
+1. **Supabase**:
    - Create a new [Supabase project](https://supabase.com/dashboard/projects)
    - Save your project's API URL, anon key, and service role key for later use
    - Install the [Supabase CLI](https://supabase.com/docs/guides/cli/getting-started)
@@ -105,9 +105,12 @@ You'll need the following components:
      - [Mac](https://formulae.brew.sh/formula/redis): `brew install redis`
      - [Linux](https://redis.io/docs/getting-started/installation/install-redis-on-linux/): Follow distribution-specific instructions
      - [Windows](https://redis.io/docs/getting-started/installation/install-redis-on-windows/): Use WSL2 or Docker
-   - Save your Redis connection details for later use
+   - Docker Compose (included in our setup):
+     - If you're using our Docker Compose setup, Redis is included and configured automatically
+     - No additional installation is needed
+   - Save your Redis connection details for later use (not needed if using Docker Compose)
 
-3. **Daytona**: 
+3. **Daytona**:
    - Create an account on [Daytona](https://app.daytona.io/)
    - Generate an API key from your account settings
    - Go to [Images](https://app.daytona.io/dashboard/images)
@@ -123,6 +126,7 @@ You'll need the following components:
    - For enhanced search capabilities, obtain an [Tavily API key](https://tavily.com/)
    - For web scraping capabilities, obtain a [Firecrawl API key](https://firecrawl.dev/)
 
+
 6. **RapidAPI API Key** (Optional):
    - To enable API services like LinkedIn, and others, you'll need a RapidAPI key
    - Each service requires individual activation in your RapidAPI account:
@@ -201,8 +205,13 @@ cp .env.example .env.local  # Create from example if available, or use the follo
 ```
 NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
 NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
-NEXT_PUBLIC_BACKEND_URL="http://localhost:8000/api"
+NEXT_PUBLIC_BACKEND_URL="http://localhost:8000/api"  # Use this for local development
 NEXT_PUBLIC_URL="http://localhost:3000"
+```
+
+   Note: If you're using Docker Compose, use the container name instead of localhost:
+```
+NEXT_PUBLIC_BACKEND_URL="http://backend:8000/api"  # Use this when running with Docker Compose
 ```
 
 5. **Install dependencies**:
@@ -230,6 +239,34 @@ cd backend
 python api.py
 ```
 
+5-6. **Docker Compose Alternative**:
+
+Before running with Docker Compose, make sure your environment files are properly configured:
+- In `backend/.env`, set all the required environment variables as described above
+  - For Redis configuration, use `REDIS_HOST=redis` instead of localhost
+  - The Docker Compose setup will automatically set these Redis environment variables:
+    ```
+    REDIS_HOST=redis
+    REDIS_PORT=6379
+    REDIS_PASSWORD=
+    REDIS_SSL=False
+    ```
+- In `frontend/.env.local`, make sure to set `NEXT_PUBLIC_BACKEND_URL="http://backend:8000/api"` to use the container name
+
+Then run:
+```bash
+export GITHUB_REPOSITORY="your-github-username/repo-name"
+docker compose -f docker-compose.ghcr.yaml up
+```
+
+If you're building the images locally instead of using pre-built ones:
+```bash
+docker compose up
+```
+
+The Docker Compose setup includes a Redis service that will be used by the backend automatically.
+
+
 7. **Access Suna**:
    - Open your browser and navigate to `http://localhost:3000`
    - Sign up for an account using the Supabase authentication

backend/Dockerfile

@@ -1,24 +1,27 @@
 FROM python:3.11-slim
 
 WORKDIR /app
+RUN pip install --no-cache-dir gunicorn
 
 COPY requirements.txt .
 RUN pip install --no-cache-dir -r requirements.txt
-RUN pip install --no-cache-dir gunicorn
+
 
 # Copy the .env file first
-COPY .env .
+# COPY .env . # ATTENTION. We shouldn't copy secrets to the image
+
 
 # Copy the backend code
 COPY . .
 
 # Set environment variable
 ENV PYTHONPATH=/app
 
+
 ENV ENV_MODE="production"
 
 # Expose the port the app runs on
 EXPOSE 8000
 
 # 24 workers
-CMD ["gunicorn", "api:app", "--workers", "24", "--worker-class", "uvicorn.workers.UvicornWorker", "--bind", "0.0.0.0:8000", "--timeout", "600", "--graceful-timeout", "300", "--keep-alive", "250", "--max-requests", "0", "--max-requests-jitter", "0", "--forwarded-allow-ips", "*", "--worker-connections", "5000", "--worker-tmp-dir", "/dev/shm", "--preload"]
+CMD ["gunicorn", "api:app", "--workers", "24", "--worker-class", "uvicorn.workers.UvicornWorker", "--bind", "0.0.0.0:8000", "--timeout", "600", "--graceful-timeout", "300", "--keep-alive", "250", "--max-requests", "0", "--max-requests-jitter", "0", "--forwarded-allow-ips", "*", "--worker-connections", "5000", "--worker-tmp-dir", "/dev/shm", "--preload"]

docker-compose.ghcr.yaml

@@ -0,0 +1,46 @@
+version: '3.8'
+
+services:
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis-data:/data
+    command: redis-server --save 60 1 --loglevel warning
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 3
+
+  backend:
+    image: ghcr.io/${GITHUB_REPOSITORY}/suna-backend:latest
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./backend/.env:/app/.env:ro
+    environment:
+      - ENV_MODE=local
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - REDIS_PASSWORD=
+      - REDIS_SSL=False
+    depends_on:
+      redis:
+        condition: service_healthy
+
+  frontend:
+    image: ghcr.io/${GITHUB_REPOSITORY}/suna-frontend:latest
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./frontend/.env.local:/app/.env.local:ro
+    environment:
+      - NODE_ENV=production
+    command: ["npm", "run", "dev"]
+    depends_on:
+      - backend
+
+volumes:
+  redis-data:

docker-compose.yaml

@@ -0,0 +1,50 @@
+version: '3.8'
+
+services:
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis-data:/data
+    command: redis-server --save 60 1 --loglevel warning
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 3
+
+  backend:
+    build:
+      context: ./backend
+      dockerfile: Dockerfile
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./backend/.env:/app/.env:ro
+    environment:
+      - ENV_MODE=local
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - REDIS_PASSWORD=
+      - REDIS_SSL=False
+    depends_on:
+      redis:
+        condition: service_healthy
+
+  frontend:
+    build:
+      context: ./frontend
+      dockerfile: Dockerfile
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./frontend/.env.local:/app/.env.local:ro
+    environment:
+      - NODE_ENV=production
+    command: ["npm", "run", "start"]
+    depends_on:
+      - backend
+
+volumes:
+  redis-data:

frontend/Dockerfile

@@ -0,0 +1,16 @@
+FROM node:20-slim
+
+WORKDIR /app
+
+# Copy package files first for better layer caching
+COPY package*.json ./
+RUN npm install
+
+# Copy the frontend code
+COPY . .
+
+
+EXPOSE 3000
+
+# Default command is dev, but can be overridden in docker-compose
+CMD ["npm", "run", "dev"]