A developer-focused entry in TopGit's GitHub warehouse: jwilder/dockerize, 5.2k stars, Developer Tools, Go. Utility to simplify running applications in docker containers
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Utility to simplify running applications in docker containers.
dockerize is a utility to simplify running applications in docker containers. It allows you to:
generate application configuration files at container startup time from templates and container environment variables
Tail multiple log files to stdout and/or stderr
Wait for other services to be available using TCP, HTTP(S), unix before starting the main process.
The typical use case for dockerize is when you have an application that has one or more configuration files and you would like to control some of the values using environment variables.
For example, a Python application using Sqlalchemy might not be able to use environment variables directly.
It may require that the database URL be read from a python settings file with a variable named
SQLALCHEMY_DATABASE_URI. dockerize allows you to set an environment variable such as
DATABASE_URL and update the python file when the container starts.
In addition, it can also delay the starting of the python application until the database container is running and listening on the TCP port.
Another use case is when the application logs to specific files on the filesystem and not stdout
or stderr. This makes it difficult to troubleshoot the container using the docker logs command.
For example, nginx will log to /var/log/nginx/access.log and
/var/log/nginx/error.log by default. While you can sometimes work around this, it's tedious to find a solution for every application. dockerize allows you to specify which logs files should be tailed and where they should be sent.
See A Simple Way To Dockerize Applications
Installation
Download the latest version in your container:
linux/amd64
linux/armel
linux/arm64
linux/armhf
alpine/amd64
darwin/amd64
darwin/arm64
Docker Base Image
The jwilder/dockerize image is a base image based on gcr.io/distroless/static. dockerize is installed in the $PATH and can be used directly.
FROM jwilder/dockerize
...
ENTRYPOINT dockerize ...
dockerize works by wrapping the call to your application using the ENTRYPOINT or CMD directives.
This would generate /etc/nginx/nginx.conf from the template located at /etc/nginx/nginx.tmpl and
send /var/log/nginx/access.log to STDOUT and /var/log/nginx/error.log to STDERR after running
nginx, only after waiting for the web host to respond on tcp 8000:
Templates can be generated to STDOUT by not specifying a dest:
$ dockerize -template template1.tmpl
Template may also be a directory. In this case all files within this directory are processed as template and stored with the same name in the destination directory.
If the destination directory is omitted, the output is sent to STDOUT. The files in the source directory are processed in sorted order (as returned by os.ReadDir).
$ dockerize -template src_dir:dest_dir
If the destination file already exists, dockerize will overwrite it. The -no-overwrite flag overrides this behaviour.
If your file uses {{ and }} as part of it's syntax, you can change the template escape characters using the -delims. Both delimiters must be non-empty.
Some options only have an effect alongside another option. dockerize rejects an option that is given without its companion at startup, with an error naming both flags, instead of silently ignoring it:
Option
Needs
-poll
-stdout or -stderr
-no-overwrite
-template
-delims
-template
-timeout
-wait
-wait-retry-interval
-wait
-wait-http-header
-wait
This is a behaviour change: a command line that passes one of these options without its companion now exits with status 1 instead of running. Remove the inert option, or add the companion it needs.
Waiting for other dependencies
It is common when using tools like Docker Compose to depend on services in other linked containers, however oftentimes relying on links is not enough - whilst the container itself may have started, the service(s) within it may not yet be ready - resulting in shell script hacks to work around race conditions.
Dockerize gives you the ability to wait for services on a specified protocol (file, tcp, tcp4, tcp6, http, https and unix) before starting your application:
Each -wait URL must use one of these forms, and dockerize rejects anything else at startup, before it waits on anything:
Scheme
Accepted form
Example
tcp, tcp4, tcp6
scheme://host:port (host and port are both required)
tcp://db:5432, tcp6://[::1]:8080
http, https
scheme://host[:port][/path] (host is required)
http://web:80/health
file
file:///abs/path (absolute path, no host)
file:///tmp/generated-file
unix
unix:///abs/path (absolute socket path, no host)
unix:///var/run/docker.sock
Relative paths are not accepted: file://rel/path is rejected, because rel would be read as a host. Use file:///abs/path instead.
Timeout
You can optionally specify how long to wait for the services to become available by using the -timeout # argument (Default: 10 seconds). If the timeout is reached and the service is still not available, the process exits with status code 1. The value must be positive when -wait is used: 0 or a negative duration is rejected with an error.
By default dockerize waits 1s between connection attempts. Use -wait-retry-interval to change this, for example to retry less often against a slow service. The value must be positive: 0 or a negative duration is rejected with an error.
See this issue for a deeper discussion, and why support isn't and won't be available in the Docker ecosystem itself.
Using Templates
Templates use Golang text/template. You can access environment
variables within a template with .Env.
{{ .Env.PATH }} is my path
There are a few built-in functions as well:
default $var $default - Returns a default value for one that does not exist. {{ default .Env.VERSION "0.1.2" }}
contains $map $key - Returns true if the map contains the key. {{ if contains .Env "HOME" }}
exists $path - Determines if a file path exists or not. {{ exists "/etc/default/myapp" }}
split $string $sep - Splits a string into an array using a separator string. Alias for strings.Split. {{ split .Env.PATH ":" }}
replace $string $old $new $count - Replaces all occurrences of a string within another string. Alias for strings.Replace. Use -1 for $count to replace all occurrences. {{ replace .Env.PATH ":" ";" -1 }}
parseUrl $url - Parses a URL into it's protocol, scheme, host, etc. parts. Alias for url.Parse
atoi $value - Parses a string $value into an int. {{ if (gt (atoi .Env.NUM_THREADS) 1) }}
isTrue $value - Parses a string $value to a boolean value. {{ if isTrue .Env.ENABLED }}
lower $value - Lowercase a string.
upper $value - Uppercase a string.
jsonQuery $json $query - Returns the result of a selection query against a json document.
loop - Create for loops.
jsonQuery
Objects and fields are accessed by name. Array elements are accessed by index in square brackets (e.g. [1]). Nested elements are separated by dots (.).
the template expression jsonQuery .Env.SERVICES "services\\.[1]\\.port" returns 9000. The dots between path elements are escaped (\\.) because the query parser splits on \.; an unescaped . is not treated as a separator.
loop
loop allows for creating for loop within a template. It takes 1 to 3 arguments.
# Loop from 0...10
{{ range loop 10 }}
i = {{ . }}
{{ end }}
# Loop from 5...10
{{ range $i := loop 5 10 }}
i = {{ $i }}
{{ end }}
# Loop from 5...10 by 2
{{ range $i := loop 5 10 2 }}
i = {{ $i }}
{{ end }}
No homepage URL was recorded for jwilder/dockerize in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How does jwilder/dockerize compare to other Developer Tools projects?
jwilder/dockerize is tracked by TopGit in the Developer Tools category, with 5.2k GitHub stars and written in Go. Browse the Developer Tools topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does jwilder/dockerize have?
jwilder/dockerize has 5.2k GitHub stars — refresh the page for the live number, or check github.com/jwilder/dockerize. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is jwilder/dockerize open source?
Yes — jwilder/dockerize ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/jwilder/dockerize.
What else is in the Developer Tools space?
jwilder/dockerize is tracked by TopGit under the Developer Tools category, alongside 2 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is jwilder/dockerize?
jwilder/dockerize (jwilder/dockerize) is a Go project on GitHub. From the project's own README: Utility to simplify running applications in docker containers
Where do I read more about jwilder/dockerize?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/jwilder/dockerize is the definitive source.
Read full README in the tab above.
Still deciding about dockerize?
One click hands the question to an AI along with this page — see what it says about dockerize.