wait-for/README.md

2.5 KiB

wait-for

Poor-mans docker service synchronizer

Build Status Docker Hub Quay.io GitHub contributors Source: GitHub License: MIT

wait-for is a script designed to synchronize services like docker containers. It is sh and alpine compatible. It was inspired by vishnubob/wait-for-it, but the core has been rewritten at Eficode by dsuni and mrako.

When using this tool, you only need to pick the wait-for file as part of your project.

Usage

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

Synchronize services like docker containers and wait for readiness.

optional arguments:
  -q | --quiet                              Do not output any status messages
  -t WAITFOR_TIMEOUT | --timeout=timeout    Timeout in seconds, zero for no timeout
  -- COMMAND ARGS                           Execute command with args after the test finishes

Dependencies

  • Installed Netcat

Examples

To check if eficode.com is available:

$ ./wait-for www.eficode.com:80 -- echo "Eficode site is up"

Eficode site is up

To wait for database container to become available:

version: '2'

services:
  db:
    image: postgres:9.4

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

Contributors

Special thanks goes to all contributors.

License

This project is licensed under the MIT License - see the LICENSE file for details.