Skip to content

Instantly share code, notes, and snippets.

@PurpleBooth

PurpleBooth/Template-README-for-containers.md

Last active November 10, 2024 19:55
Show Gist options
  • Save PurpleBooth/ea518ae68a49029bae95 to your computer and use it in GitHub Desktop.
Save PurpleBooth/ea518ae68a49029bae95 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Template-README-for-containers.md

Docker Container Name

A one paragraph description about the container.

Getting Started

These instructions will cover usage information and for the docker container

Prerequisities

In order to run this container you'll need docker installed.

Usage

Container Parameters

List the different parameters available to your container

docker run give.example.org/of/your/container:v0.2.1 parameters

One example per permutation

docker run give.example.org/of/your/container:v0.2.1

Show how to get a shell started in your container too

docker run give.example.org/of/your/container:v0.2.1 bash

Environment Variables

  • VARIABLE_ONE - A Description
  • ANOTHER_VAR - More Description
  • YOU_GET_THE_IDEA - And another

Volumes

  • /your/file/location - File location

Useful File Locations

  • /some/special/script.sh - List special scripts

  • /magic/dir - And also directories

Built With

  • List the software v0.1.3
  • And the version numbers v2.0.0
  • That are in this container v0.3.2

Find Us

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

  • People you want to thank
  • If you took a bunch of code from somewhere list it here
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment