thegeeklab/wait-for

wait-for

简易服务同步工具

![Build Status]([] ![Quay.io]([]

镜像概述和主要用途

wait-for 是一个用于同步服务（如容器）的脚本，兼容 sh 和 alpine 系统，从 https://github.com/eficode/wait-for 分叉而来。使用该工具时，只需将 wait-for 文件纳入项目即可。

核心功能和特性

• 服务同步：等待指定服务（主机:端口）就绪
• 安静模式：可选择不输出状态消息
• 超时控制：支持设置超时时间（秒），0 表示无超时
• 命令执行：服务就绪后可执行指定命令及参数

使用场景和适用范围

适用于需要协调依赖服务启动顺序的场景，例如：

• 等待数据库容器就绪后启动后端应用
• 检查外部服务（如 API、网站）是否可用
• 在容器化部署中确保服务按依赖顺序启动

使用方法和配置说明

命令行参数

Shell
$ wait-for --help
usage: wait-for host:port [-t timeout] [-- command args]

同步服务（如容器）并等待就绪。

可选参数：
  -q | --quiet                              不输出任何状态消息
  -t WAITFOR_TIMEOUT | --timeout=timeout    超时时间（秒），0 表示无超时
  -- COMMAND ARGS                           测试完成后执行带参数的命令

依赖项

• 已安装 Netcat 或 Bash（以使用 /dev/tcp）

示例

检查网站可用性

检查 google.com 是否可用：

Shell
$ ./wait-for google.com:80 -- echo "Google 网站已可用"

Google 网站已可用

等待数据库容器就绪

在 Docker Compose 中，等待数据库容器就绪后启动后端服务：

Yaml
version: '2'

services:
  db:
    image: postgres:9.4

  backend:
    build: backend
    command: sh -c './wait-for db:5432 -- npm start'
    depends_on:
      - db

贡献者

特别感谢所有 https://github.com/thegeeklab/wait-for/graphs/contributors%E3%80%82%E5%A6%82%E6%82%A8%E6%83%B3%E5%8F%82%E4%B8%8E%E8%B4%A1%E7%8C%AE%EF%BC%8C%E8%AF%B7%E5%8F%82%E9%98%85 https://github.com/thegeeklab/wait-for/blob/main/CONTRIBUTING.md%E3%80%82

许可证

本项目采用 MIT 许可证 - 详见 https://github.com/thegeeklab/wait-for/blob/main/LICENSE 文件。