mirror of
https://github.com/thegeeklab/wait-for.git
synced 2024-11-10 15:00:41 +00:00
68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
# wait-for
|
|
|
|
Poor-mans docker service synchronizer
|
|
|
|
[](https://drone.thegeeklab.de/thegeeklab/wait-for)
|
|
[](https://hub.docker.com/r/thegeeklab/wait-for)
|
|
[](https://quay.io/repository/thegeeklab/wait-for)
|
|
[](https://github.com/thegeeklab/wait-for/graphs/contributors)
|
|
[](https://github.com/thegeeklab/wait-for)
|
|
[](https://github.com/thegeeklab/wait-for/blob/main/LICENSE)
|
|
|
|
wait-for is a script designed to synchronize services like docker containers. It is [sh](https://en.wikipedia.org/wiki/Bourne_shell) and [alpine](https://alpinelinux.org/) compatible and was forked from [eficode/wait-for](https://github.com/eficode/wait-for).
|
|
|
|
When using this tool, you only need to pick the `wait-for` file as part of your project.
|
|
|
|
## Usage
|
|
|
|
```Shell
|
|
$ 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 [google.com](https://google.com) is available:
|
|
|
|
```Shell
|
|
$ ./wait-for google.com:80 -- echo "Google site is up"
|
|
|
|
Google site is up
|
|
```
|
|
|
|
To wait for database container to become available:
|
|
|
|
```Yaml
|
|
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](https://github.com/thegeeklab/wait-for/graphs/contributors). If you would like to contribute,
|
|
please see the [instructions](https://github.com/thegeeklab/wait-for/blob/main/CONTRIBUTING.md).
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/wait-for/blob/main/LICENSE) file for details.
|