Back to Skills

setup-compose-stack

pjt222
Updated 5 days ago
13 views
17
2
17
View on GitHub
Metaapidata

About

This Claude Skill configures Docker Compose stacks for multi-service applications like web apps with databases, caches, and workers. It handles key orchestration features including volumes, networks, health checks, and environment management. Use it when setting up development environments or creating reproducible multi-service deployments.

Quick Install

Claude Code

Recommended
Primary
npx skills add pjt222/agent-almanac -a claude-code
Plugin CommandAlternative
/plugin add https://github.com/pjt222/agent-almanac
Git CloneAlternative
git clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/setup-compose-stack

Copy and paste this command in Claude Code to install this skill

Documentation

設置 Compose 堆疊

為含資料庫、快取與工作者之多服務應用堆疊配置 Docker Compose。

適用時機

  • 執行含資料庫與/或快取之網頁應用
  • 設置含多服務之開發環境
  • 與 API 一同編排背景工作者
  • 跨團隊需可重現之多服務環境

輸入

  • 必要:應用服務(語言、連接埠、入口點)
  • 必要:所需支援服務(資料庫、快取、佇列等)
  • 選擇性:開發 vs 生產配置
  • 選擇性:自訂服務之既有 Dockerfile

步驟

步驟一:定義核心堆疊

services:
  app:
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - "3000:3000"
    environment:
      DATABASE_URL: postgres://appuser:apppass@postgres:5432/appdb
      REDIS_URL: redis://redis:6379
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_started
    restart: unless-stopped

  postgres:
    image: postgres:16
    environment:
      POSTGRES_DB: appdb
      POSTGRES_USER: appuser
      POSTGRES_PASSWORD: apppass
    volumes:
      - pgdata:/var/lib/postgresql/data
    ports:
      - "5432:5432"
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U appuser -d appdb"]
      interval: 5s
      timeout: 5s
      retries: 5

  redis:
    image: redis:7-alpine
    ports:
      - "6379:6379"
    volumes:
      - redisdata:/data

volumes:
  pgdata:
  redisdata:

預期: docker compose up 啟動所有服務,應用等待健康之資料庫。

步驟二:加入健康檢查

健康檢查啟用 depends_oncondition: service_healthy

services:
  postgres:
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U appuser -d appdb"]
      interval: 5s
      timeout: 5s
      retries: 5

  redis:
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 5s
      timeout: 3s
      retries: 5

  app:
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 10s

步驟三:配置網路

services:
  app:
    networks:
      - frontend
      - backend

  postgres:
    networks:
      - backend

  nginx:
    networks:
      - frontend
    ports:
      - "80:80"

networks:
  frontend:
    driver: bridge
  backend:
    driver: bridge

此將資料庫與直接外部存取隔離,而應用橋接兩網路。

步驟四:管理環境變數

建立 .env 文件(git 已忽略):

POSTGRES_PASSWORD=secure_password_here
APP_SECRET=your_secret_key

於 compose 中參照:

services:
  postgres:
    environment:
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
  app:
    env_file:
      - .env

建立 .env.example(已提交至 git):

POSTGRES_PASSWORD=changeme
APP_SECRET=changeme

步驟五:加入工作者服務

services:
  worker:
    build:
      context: .
      dockerfile: Dockerfile
    command: ["node", "src/worker.js"]
    environment:
      DATABASE_URL: postgres://appuser:apppass@postgres:5432/appdb
      REDIS_URL: redis://redis:6379
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_started
    restart: unless-stopped
    deploy:
      replicas: 2

步驟六:以設定檔處理選擇性服務

services:
  app:
    # always starts
    build: .

  mailhog:
    image: mailhog/mailhog
    ports:
      - "8025:8025"
    profiles:
      - dev

  adminer:
    image: adminer
    ports:
      - "8080:8080"
    profiles:
      - dev
# Start core services only
docker compose up

# Start with dev tools
docker compose --profile dev up

步驟七:為開發建立覆蓋

docker-compose.override.yml 自動合併:

services:
  app:
    build:
      target: dev
    volumes:
      - .:/app
      - /app/node_modules
    environment:
      NODE_ENV: development
      DEBUG: "app:*"
    command: ["npm", "run", "dev"]

步驟八:建構並執行

# Build all images
docker compose build

# Start in background
docker compose up -d

# View logs
docker compose logs -f app

# Check service status
docker compose ps

# Stop and remove
docker compose down

# Stop and remove volumes (full reset)
docker compose down -v

預期: 所有服務啟動、健康檢查通過、應用連接至資料庫與快取。

失敗時: 檢查 docker compose logs <service>。常見問題:連接埠衝突、缺環境變數、健康檢查超時。

驗證

  • docker compose up 無錯啟動所有服務
  • 資料庫與快取之健康檢查通過
  • 應用連接至所有依賴服務
  • 命名卷跨重啟持久資料
  • .env 已 git 忽略;.env.example 已提交
  • docker compose down 乾淨停止所有
  • 設定檔將開發工具與生產服務分隔

常見陷阱

  • 無健康檢查:無 condition: service_healthydepends_on 僅等待容器啟動,非就緒。
  • compose 中硬編碼之密碼:用 .env 文件或 Docker secrets。絕不提交密碼。
  • 卷掛載覆寫:掛載 .:/app 覆寫於映像中建之 node_modules。用匿名卷:/app/node_modules
  • 連接埠衝突:以 docker compose pslsof -i :<port> 檢查衝突。
  • version::Compose V2 忽略 version: 鍵。對現代設置省略之。
  • WSL 路徑問題:自 WSL 掛載 Windows 目錄時用 /mnt/c/... 路徑。

相關技能

  • setup-docker-compose - R 特定之 Docker Compose 配置
  • create-dockerfile - 撰寫 compose 參照之 Dockerfile
  • create-multistage-dockerfile - 為堆疊建構優化映像
  • configure-nginx - 對堆疊加入 Nginx 反向代理

GitHub Repository

pjt222/agent-almanac
Path: i18n/wenyan-lite/skills/setup-compose-stack
0
agentsagentskillsai-assisted-developmentclaude-codeskillsteams

Related Skills

content-collections

Meta

This skill provides a production-tested setup for Content Collections, a TypeScript-first tool that transforms Markdown/MDX files into type-safe data collections with Zod validation. Use it when building blogs, documentation sites, or content-heavy Vite + React applications to ensure type safety and automatic content validation. It covers everything from Vite plugin configuration and MDX compilation to deployment optimization and schema validation.

View skill

polymarket

Meta

This skill enables developers to build applications with the Polymarket prediction markets platform, including API integration for trading and market data. It also provides real-time data streaming via WebSocket to monitor live trades and market activity. Use it for implementing trading strategies or creating tools that process live market updates.

View skill

creating-opencode-plugins

Meta

This skill helps developers create OpenCode plugins that hook into 25+ event types like commands, files, and LSP operations. It provides the plugin structure, event API specifications, and implementation patterns for JavaScript/TypeScript modules. Use it when you need to intercept, monitor, or extend the OpenCode AI assistant's lifecycle with custom event-driven logic.

View skill

sglang

Meta

SGLang is a high-performance LLM serving framework that specializes in fast, structured generation for JSON, regex, and agentic workflows using its RadixAttention prefix caching. It delivers significantly faster inference, especially for tasks with repeated prefixes, making it ideal for complex, structured outputs and multi-turn conversations. Choose SGLang over alternatives like vLLM when you need constrained decoding or are building applications with extensive prefix sharing.

View skill