Docker Image README Template
{A short description of the image, same as the Github Repo description.}
{Badges should all be in one row without carriage returns. Replace the {name} with your docker image name.}
{Longer description of what the image provides.}
For more documentation on how Outrigger images are constructed and how to work with them, please see the documentation.
{Keep this as-is, but replace {name} with your Docker image name.}
You can see all images available to pull from Docker Hub via the Tags page. Docker tag names that begin with a "change type" word such as task, bug, or feature are available for testing and may be removed at any time.
{An example of running the container. Most Outrigger-based projects use docker-compose, so that kind of example is preferred but a docker run is also very helpful.}
docker run ...
{List of packages and tools, H3 section breakouts for more detail}
Outrigger images use Environment Variables and confd to "templatize" a number of Docker environment configurations. These templates are processed on startup with environment variables passed in via the docker run command-line or via your docker-compose manifest file. Here are the "tunable" configurations offered by this image.
{Each environment variable might have 1-2 sentences of description. If it needs longer than that, it should probably have a sub-section within Features to elaborate.}
-
NODE_VERSION: [4|5|6] Defaults to 4.x. Selects the major version of Node to make available to all tools via nvm. The latest minor release as of the image build will be used. -
PHP_XDEBUG: ["true"|"false"] Specify whether the PHP Xdebug extension should be enabled.
{This section should be considered instead as a new documentation page on docs.outrigger.sh, but if for some reason it's simple enough or not timely to do so, add a short section here with the necessary details.}
Please email [email protected] with security concerns.
