nafies1/redep

🐳 Docker配置与使用指南

本指南提供了使用Docker运行redep服务器的全面说明。该Docker镜像基于Alpine Linux，在体积和安全性上均经过优化。

🚀 快速开始

1. 拉取镜像

bash
docker pull nafies1/redep:latest

2. 运行服务器

运行服务器需要提供密钥并挂载Docker套接字（以便redep能在主机上执行Docker命令）。

Linux / macOS (Bash)

bash
docker run -d \
  --name redep-server \
  --restart always \
  -p 3000:3000 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v $(pwd)/workspace:/app/workspace \
  -e SECRET_KEY=your-super-secret-key \
  -e WORKING_DIR=/app/workspace \
  -e DEPLOYMENT_COMMAND="docker compose up -d" \
  nafies1/redep:latest

Windows (PowerShell)

powershell
docker run -d `
  --name redep-server `
  --restart always `
  -p 3000:3000 `
  -v /var/run/docker.sock:/var/run/docker.sock `
  -v ${PWD}/workspace:/app/workspace `
  -e SECRET_KEY=your-super-secret-key `
  -e WORKING_DIR=/app/workspace `
  -e DEPLOYMENT_COMMAND="docker compose up -d" `
  nafies1/redep:latest

Windows (命令提示符)

cmd
docker run -d ^
  --name redep-server ^
  --restart always ^
  -p 3000:3000 ^
  -v /var/run/docker.sock:/var/run/docker.sock ^
  -v %cd%/workspace:/app/workspace ^
  -e SECRET_KEY=your-super-secret-key ^
  -e WORKING_DIR=/app/workspace ^
  -e DEPLOYMENT_COMMAND="docker compose up -d" ^
  nafies1/redep:latest

---

⚙️ 配置参考

环境变量

卷挂载

---

📦 Docker Compose示例

基础配置

创建docker-compose.redep.yml文件：

yaml
services:
  redep-server:
    image: nafies1/redep:latest
    container_name: redep-server
    restart: always
    ports:
      - '3000:3000'
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./my-project:/app/workspace
    environment:
      - SECRET_KEY=change-me-to-something-secure
      - WORKING_DIR=/app/workspace
      - DEPLOYMENT_COMMAND=docker compose pull && docker compose up -d

运行命令：

bash
docker compose -f docker-compose.redep.yml up -d

高级配置（Traefik + Watchtower）

yaml
services:
  redep-server:
    image: nafies1/redep:latest
    networks:
      - web
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./workspace:/app/workspace
    environment:
      - SECRET_KEY=${REDEP_SECRET}
      - WORKING_DIR=/app/workspace
      - DEPLOYMENT_COMMAND=docker compose up -d --build
    labels:
      - 'traefik.enable=true'
      - 'traefik.http.routers.redep.rule=Host(`deploy.example.com`)'

networks:
  web:
    external: true

---

🛠️ 故障排除

1. "Docker command not found"或权限拒绝

• 症状：部署日志显示docker: not found或permission denied。
• 原因：容器无法访问主机的Docker套接字。
• 解决：确保添加了-v /var/run/docker.sock:/var/run/docker.sock参数。部分系统可能需要添加--group-add $(getent group docker | cut -d: -f3)或user: root（非必要时不推荐使用root）。

2. "Connection Refused"

• 症状：客户端显示xhr poll error。
• 原因：服务器未运行或端口映射错误。
• 解决：检查docker ps确认服务器状态，确保-p 3000:3000与内部SERVER_PORT一致。

3. "Directory not found"

• 症状：出现关于WORKING_DIR的错误。
• 解决：确保WORKING_DIR路径在容器内存在，挂载卷会自动创建该目录。

---

🔒 安全最佳实践

1. 最小权限：容器默认以root身份运行以方便访问Docker套接字。为提高安全性，可使用非root用户并将其添加到docker组（需自定义镜像扩展）。
2. 网络隔离：不要直接将3000端口暴露到公网，建议使用反向代理（Nginx、Traefik）配置SSL/TLS并启用IP白名单。
3. 密钥管理：不要将SECRET_KEY提交到版本控制，使用.env文件（排除在git外）或Docker Secrets。
4. 套接字暴露：挂载/var/run/docker.sock会赋予容器主机的完全控制权，确保仅执行可信的DEPLOYMENT_COMMAND。

---

🚀 性能调优

• 基础镜像：使用node:20-alpine确保轻量级（<100MB）。
• 内存限制：服务器资源占用低，可限制内存使用：

  bash
  --memory="256m" --cpus="0.5"
  

• 层缓存：Dockerfile使用多阶段构建，依赖项缓存于独立层，代码变更后重建镜像速度更快。

📋 版本兼容性

🔗 附加资源

• https://docs.docker.com/
• https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md