https://github.com/maxcnunes/waitforit

Wait until an address become available.
https://github.com/maxcnunes/waitforit

Last synced: 18 days ago
JSON representation

Wait until an address become available.

• Host: GitHub
• URL: https://github.com/maxcnunes/waitforit
• Owner: maxcnunes
• License: mit
• Created: 2014-11-19T04:20:54.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-05-14T16:11:28.000Z (over 2 years ago)
• Last Synced: 2024-10-18T07:23:17.780Z (27 days ago)
• Language: Go
• Homepage:
• Size: 52.7 KB
• Stars: 172
• Watchers: 7
• Forks: 26
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# wait for it

[![Build Status](https://travis-ci.org/maxcnunes/waitforit.svg?branch=master)](https://travis-ci.org/maxcnunes/waitforit)

[![Coverage Status](https://coveralls.io/repos/github/maxcnunes/waitforit/badge.svg?branch=master)](https://coveralls.io/github/maxcnunes/waitforit?branch=master)

Wait until an address become available.

![](http://24.media.tumblr.com/tumblr_m3x648wxbj1ru99qvo1_500.png)

### Download

[Releases](https://github.com/maxcnunes/waitforit/releases)

### Options

- `-address`: Address (e.g. http://google.com, tcp://mysql-ip:port, ssh://ip:port) - *former **full-connection***

- `-proto`: Protocol to use during the connection

- `-host`: Host to connect

- `-port`: Port to connect (default 80)

- `-status`: Expected status that address should return (e.g. 200)

- `-timeout`: Seconds to wait until the address become available

- `-retry`: Milliseconds to wait between retries (default 500)

- `-insecure`: Allows waitforit to perform \"insecure\" SSL connections

- `-debug`: Enable debug

- `-v`: Show the current version

- `-file`: Path to the JSON file with the configs

- `-header`: List of headers sent in the http(s) ping request

- `-- `: Execute a post command once the address became available

### Example

#### Running

```bash

waitforit -host=google.com -port=90 -timeout=20 -debug

waitforit -address=tcp://google.com:90 -timeout=20 -debug

waitforit -address=http://google.com -timeout=20 -debug

waitforit -address=http://google.com:90 -timeout=20 -retry=500 -debug

waitforit -address=http://google.com -timeout=20 -debug -- printf "Google Works\!"

waitforit -address=http://google.com -header "Authorization: Basic Zm9vOmJhcg==" -header "X-ID: 111" -debug

```

#### Using with config file

Create a JSON file describing the hosts you would like to wait for.

Example JSON:

```json

{

  "configs": [

    {

      "host": "google.com",

      "port": 80,

      "timeout": 20,

      "retry": 500,

      "headers": {

        "Authorization": "Basic Zm9vOmJhcg==",

        "X-ID": "111"

      }

    },

    {

      "address": "http://google.com:80",

      "timeout": 40

    }

  ]

}

```

```bash

waitforit -file=./config.json

```

#### Installing with a Dockerfile

##### Using curl

```

FROM node:6.5.0

ENV WAITFORIT_VERSION="v2.4.1"

RUN curl -o /usr/local/bin/waitforit -sSL https://github.com/maxcnunes/waitforit/releases/download/$WAITFORIT_VERSION/waitforit-linux_amd64 && \

    chmod +x /usr/local/bin/waitforit

```

##### Using wget

```

FROM node:6.5.0

ENV WAITFORIT_VERSION="v2.4.1"

RUN wget -q -O /usr/local/bin/waitforit https://github.com/maxcnunes/waitforit/releases/download/$WAITFORIT_VERSION/waitforit-linux_amd64 \

    && chmod +x /usr/local/bin/waitforit

```

##### Using COPY (from local file system)

```

FROM node:6.5.0

COPY waitforit-linux_amd64 /usr/local/bin/waitforit

RUN chmod +x /usr/local/bin/waitforit

```

## Development

```bash

make run

```

Running with `Docker` and `Compose`:

```bash

docker-compose run --rm local

```

```bash

docker-compose run --rm local go run src/waitforit/main.go -h

```

## Test

```bash

make test

```

## Build

```bash

make build

```