brammp/gittemp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Anthony Lapenna
2016-08-23 19:01:49 +12:00
parent 40ff6d4913
commit 591e19fbef
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -19,18 +19,18 @@ It must consist of an array with every template definition consisting of one ele
A template element must be a *JSON* object with the following mandatory fields: A template element must be a *JSON* object with the following mandatory fields:
* title: Title of the template * `title`: Title of the template
* description: Description of the template * `description`: Description of the template
* logo: URL for the template logo * `logo`: URL for the template logo
* image: the Docker image associated to the template * `image`: the Docker image associated to the template
The following fields are optional: The following fields are optional:
* env: An array describing the environment variables required by the template. * `env`: An array describing the environment variables required by the template.
For each variable, an input will be created in the UI. For each variable, an input will be created in the UI.
* volumes: An array describing the associated volumes of the template. * `volumes`: An array describing the associated volumes of the template.
For each volume, a Docker volume will be created and associated when starting the template. For each volume, a Docker volume will be created and associated when starting the template.
* ports: An array describing the ports exposed by template. * `ports`: An array describing the ports exposed by template.
Each port will be automatically bound on the host by Docker when starting the container. Each port will be automatically bound on the host by Docker when starting the container.
**Example**: **Example**: