ducktors/docker-wait-for-dependencies

Docker Wait for Deps

一个简单的容器，用于在Docker Compose环境中等待声明的其他服务通过TCP协议可访问后再继续执行。支持linux/amd64和linux/arm64架构。

核心功能与特性

• 等待指定TCP端点（如数据库、缓存服务）完全可访问
• 支持自定义检查间隔时间（默认2秒）
• 支持自定义超时时间（默认300秒）
• 兼容多架构（amd64/arm64）

使用场景

适用于Docker Compose环境中，需要确保依赖服务（如MongoDB、Redis等）完全就绪后再启动主应用服务的场景，避免因依赖服务未准备好导致的应用启动失败。

使用方法与配置说明

示例Docker Compose配置

以下是一个包含依赖服务等待的docker-compose.yml示例：

yaml
version: '2'
services:
  mongo:
    image: mongo:6
    container_name: mongo
    ports:
      - 27017:27017
    networks:
      - my-network

  redis:
    container_name: redis
    image: redis:6
    ports:
      - 6379:6379
    networks:
      - my-network

  server:
    container_name: server
    image: server
    ports:
      - 3000:3000
    networks:
      - my-network

  start_dependencies:
    image: ducktors/docker-wait-for-dependencies
    depends_on:
      - mongo
      - redis
    container_name: wait-for-dependencies
    command: mongo:27017 redis:6379  # 指定需要等待的服务端点
    networks:
      - my-network

确保依赖就绪后启动主服务

执行以下命令，确保mongo和redis就绪后再启动server服务：

bash
# 等待依赖服务就绪
$ docker-compose run --rm start_dependencies

# 启动主服务
$ docker-compose up server

环境变量配置

自定义检查间隔时间

默认情况下，两次检查之间间隔2秒。可通过SLEEP_LENGTH环境变量修改：

yaml
start_dependencies:
  image: ducktors/docker-wait-for-dependencies
  environment:
    - SLEEP_LENGTH=0.5  # 设置为0.5秒间隔

自定义超时时间

默认超时时间为300秒（5分钟），超时后将停止等待。可通过TIMEOUT_LENGTH环境变量修改：

yaml
start_dependencies:
  image: ducktors/docker-wait-for-dependencies
  environment:
    - SLEEP_LENGTH=1      # 1秒检查间隔
    - TIMEOUT_LENGTH=60   # 60秒超时时间