docker

Author: jparkerweb

.dockerignore

@@ -0,0 +1,40 @@
+# Dependencies
+node_modules
+webui/node_modules
+
+# Models (mounted as volume)
+models
+
+# Git
+.git
+.gitignore
+.github
+
+# IDE
+.vscode
+*.swp
+*.swo
+*~
+
+# Environment
+.env
+.env.local
+.env.*.local
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Build
+dist
+build
+
+# Other
+.aider*
+memory.json
+.gemini

Dockerfile

@@ -0,0 +1,49 @@
+# syntax=docker/dockerfile:1
+
+# Build stage
+FROM node:20-slim AS builder
+
+# Set working directory
+WORKDIR /app
+
+# Copy package files
+COPY package*.json ./
+COPY webui/package*.json ./webui/
+
+# Install dependencies
+RUN npm ci --omit=dev && \
+    cd webui && \
+    npm ci --omit=dev
+
+# Production stage
+FROM node:20-slim
+
+# Install required system dependencies for ONNX Runtime
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+    ca-certificates \
+    wget \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set working directory
+WORKDIR /app
+
+# Copy dependencies from builder
+COPY --from=builder /app/node_modules ./node_modules
+COPY --from=builder /app/webui/node_modules ./webui/node_modules
+
+# Copy application code
+COPY . .
+
+# Create models directory with proper permissions
+RUN mkdir -p models && \
+    chown -R node:node /app
+
+# Switch to non-root user
+USER node
+
+# Expose port for Web UI
+EXPOSE 3000
+
+# Default command runs the Web UI server
+CMD ["node", "webui/server.js"]

README.md

@@ -33,6 +33,63 @@ _how it works_
 npm install semantic-chunking
 ```
 
+## Docker Usage
+
+The easiest way to run semantic-chunking is using Docker Compose:
+
+### Docker Compose (Recommended)
+
+```bash
+# Start the Web UI server
+npm run docker:compose:up
+
+# Access the Web UI at http://localhost:3000
+
+# Stop the server
+npm run docker:compose:down
+```
+
+The `docker-compose.yml` configuration includes:
+- Port mapping: `3000:3000` for the Web UI
+- Volume mapping: `./models` directory is mounted to persist downloaded embedding models between container restarts
+- Health checks and auto-restart policies
+
+### Alternative Docker Commands
+
+```bash
+# Build the Docker image
+npm run docker:build
+
+# Run the container with models volume
+npm run docker:run
+
+# Or use docker-compose directly
+docker-compose up -d
+```
+
+### Using the Library in Docker
+
+To use the chunking functions directly (not just the Web UI):
+
+```bash
+# Execute chunkit example inside the container
+docker-compose exec semantic-chunking node example/example-chunkit.js
+
+# Execute cramit example
+docker-compose exec semantic-chunking node example/example-cramit.js
+
+# Execute sentenceit example
+docker-compose exec semantic-chunking node example/example-sentenceit.js
+```
+
+### About the Models Volume
+
+The `./models` directory is mounted as a volume to persist downloaded ONNX embedding models. Models are automatically downloaded on first use and can range from 23MB to 548MB depending on which model you choose. Persisting this directory means:
+- Models are downloaded only once
+- Faster container restarts
+- Models survive container updates
+- You can pre-download models using `npm run download-models` before running Docker
+
 ## Usage
 
 Basic usage:

docker-compose.yml

@@ -0,0 +1,22 @@
+version: '3.8'
+
+services:
+  semantic-chunking:
+    build: .
+    image: semantic-chunking:latest
+    container_name: semantic-chunking
+    ports:
+      - "3000:3000"
+    volumes:
+      # Persist downloaded models between container restarts
+      - ./models:/app/models
+    environment:
+      - NODE_ENV=production
+      - PORT=3000
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:3000/"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 40s