centersl/portainer-docs
1
0
Fork 0
mirror of https://github.com/portainer/portainer-docs.git synced 2026-03-27 12:58:32 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #13 from portainer/docs11-env-type

Browse Source 
docs(templates): document the type field for the environment variables
This commit is contained in:
Anthony Lapenna
2017-02-10 15:39:06 +13:00
committed by GitHub
parent b758531c96 539d811d5d
commit 3281bb73dd
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/templates.rst
View File

@@ -70,6 +70,14 @@ A JSON array describing the environment variables required by the template. Each
An input will be generated in the templates view for each element in the array.
Depending on the value in `type` field, the view
will display a different input. For example, when using the value `container` for the `type` field, the UI will display a dropdown with all
the running containers. The container hostname will then be inserted as a value in the environment variable.
Supported types:
* `container`
This field is **optional**.
Element format:
@@ -79,6 +87,7 @@ Element format:
{
"name": "the name of the environment variable, as supported in the container image (mandatory)",
"label": "label for the input in the UI (mandatory)",
"type": "only container is available at the moment (optional)",
"set": "pre-defined value for the variable, will not generate an input in the UI (optional)"
}