grachevko/wait-for-it
1
0
Fork 0
Code Pull Requests 1 Actions Releases Activity

Merge pull request #89 from private-forks/clean_docs

Browse Source 
README: fix markdown formatting
This commit is contained in:
Douglas Gibbons
2020-08-22 09:35:37 -07:00
committed by GitHub
parent c096cface5 782bcf693e
commit 3995c046f8
1 changed files with 21 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,10 +1,13 @@
## wait-for-it # wait-for-it
`wait-for-it.sh` is a pure bash script that will wait on the availability of a host and TCP port. It is useful for synchronizing the spin-up of interdependent services, such as linked docker containers. Since it is a pure bash script, it does not have any external dependencies. `wait-for-it.sh` is a pure bash script that will wait on the availability of a
host and TCP port. It is useful for synchronizing the spin-up of
interdependent services, such as linked docker containers. Since it is a pure
bash script, it does not have any external dependencies.
## Usage ## Usage
``` ```text
wait-for-it.sh host:port [-s] [-t timeout] [-- command args] wait-for-it.sh host:port [-s] [-t timeout] [-- command args]
-h HOST | --host=HOST Host or IP under test -h HOST | --host=HOST Host or IP under test
-p PORT | --port=PORT TCP port under test -p PORT | --port=PORT TCP port under test
@ -18,36 +21,43 @@ wait-for-it.sh host:port [-s] [-t timeout] [-- command args]
## Examples ## Examples
For example, let's test to see if we can access port 80 on www.google.com, and if it is available, echo the message `google is up`. For example, let's test to see if we can access port 80 on `www.google.com`,
and if it is available, echo the message `google is up`.
``` ```text
$ ./wait-for-it.sh www.google.com:80 -- echo "google is up" $ ./wait-for-it.sh www.google.com:80 -- echo "google is up"
wait-for-it.sh: waiting 15 seconds for www.google.com:80 wait-for-it.sh: waiting 15 seconds for www.google.com:80
wait-for-it.sh: www.google.com:80 is available after 0 seconds wait-for-it.sh: www.google.com:80 is available after 0 seconds
google is up google is up
``` ```
You can set your own timeout with the `-t` or `--timeout=` option. Setting the timeout value to 0 will disable the timeout: You can set your own timeout with the `-t` or `--timeout=` option. Setting
the timeout value to 0 will disable the timeout:
``` ```text
$ ./wait-for-it.sh -t 0 www.google.com:80 -- echo "google is up" $ ./wait-for-it.sh -t 0 www.google.com:80 -- echo "google is up"
wait-for-it.sh: waiting for www.google.com:80 without a timeout wait-for-it.sh: waiting for www.google.com:80 without a timeout
wait-for-it.sh: www.google.com:80 is available after 0 seconds wait-for-it.sh: www.google.com:80 is available after 0 seconds
google is up google is up
``` ```
The subcommand will be executed regardless if the service is up or not. If you wish to execute the subcommand only if the service is up, add the `--strict` argument. In this example, we will test port 81 on www.google.com which will fail: The subcommand will be executed regardless if the service is up or not. If you
wish to execute the subcommand only if the service is up, add the `--strict`
argument. In this example, we will test port 81 on `www.google.com` which will
fail:
``` ```text
$ ./wait-for-it.sh www.google.com:81 --timeout=1 --strict -- echo "google is up" $ ./wait-for-it.sh www.google.com:81 --timeout=1 --strict -- echo "google is up"
wait-for-it.sh: waiting 1 seconds for www.google.com:81 wait-for-it.sh: waiting 1 seconds for www.google.com:81
wait-for-it.sh: timeout occurred after waiting 1 seconds for www.google.com:81 wait-for-it.sh: timeout occurred after waiting 1 seconds for www.google.com:81
wait-for-it.sh: strict mode, refusing to execute subprocess wait-for-it.sh: strict mode, refusing to execute subprocess
``` ```
If you don't want to execute a subcommand, leave off the `--` argument. This way, you can test the exit condition of `wait-for-it.sh` in your own scripts, and determine how to proceed: If you don't want to execute a subcommand, leave off the `--` argument. This
way, you can test the exit condition of `wait-for-it.sh` in your own scripts,
and determine how to proceed:
``` ```text
$ ./wait-for-it.sh www.google.com:80 $ ./wait-for-it.sh www.google.com:80
wait-for-it.sh: waiting 15 seconds for www.google.com:80 wait-for-it.sh: waiting 15 seconds for www.google.com:80
wait-for-it.sh: www.google.com:80 is available after 0 seconds wait-for-it.sh: www.google.com:80 is available after 0 seconds