Skip to content

DOCKER.md

Latest commit

 

History

History
101 lines (67 loc) · 2.12 KB

DOCKER.md

File metadata and controls

101 lines (67 loc) · 2.12 KB
Raw

Docker Setup Guide

This guide explains how to run the APC web tool using Docker.

Prerequisites

  • Docker Desktop or Docker Engine installed
  • Docker Compose (usually included with Docker Desktop)

Quick Start

From the apc directory, run:

cd apc
docker-compose up --build

The APC Tool will be available at: http://localhost:10000

Development Mode

The docker-compose configuration mounts local directories as volumes, so changes to your code will be reflected in the containers. However, you may need to restart the services:

docker-compose restart

Production Deployment

For production, modify the docker-compose.yml:

  1. Remove volume mounts
  2. Set FLASK_ENV=production
  3. Change restart: unless-stopped to restart: always
  4. Consider using a reverse proxy (nginx) in front

Production Build Example

# Build production images
docker build -f docker/backend.dockerfile -t apc-tool:latest ..

# Run without volumes
docker run -d -p 10000:10000 --name apc-tool apc-tool:latest

Useful Commands

# Stop the service
docker-compose down

# View logs
docker-compose logs -f

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

# Remove containers and volumes
docker-compose down -v

Troubleshooting

Port Already in Use

If you get a port conflict error:

# Change ports in docker-compose.yml
# For example, change "10000:10000" to "10001:10000"

Permission Issues

If you encounter permission issues with mounted volumes:

# On Linux/Mac, ensure proper permissions
chmod -R 755 .

R Package Issues

If R packages fail to install, you may need to update the Dockerfile with additional system dependencies or specific package versions.

Container Architecture

  • Base Image: rocker/r-ver:4.2.0 (includes R)
  • Python: 3.x (from apt)
  • Key Dependencies: Flask, rpy2, R packages (jsonlite, MASS)
  • Working Directory: /app

Custom Configuration

To modify R packages or Python dependencies, edit the respective Dockerfile:

  • APC: docker/backend.dockerfile
  • CrossTalk: docker/crosstalk.dockerfile Dockerfile:
  • `docker/backend