From 90f07429849be497958498cfcf5347afc7d5cb16 Mon Sep 17 00:00:00 2001 From: Ian Campbell Date: Mon, 18 Feb 2019 14:23:30 +0000 Subject: [PATCH] Document the plugin field in the config file Signed-off-by: Ian Campbell --- docs/reference/commandline/cli.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/reference/commandline/cli.md b/docs/reference/commandline/cli.md index 1937458674..9c1049b493 100644 --- a/docs/reference/commandline/cli.md +++ b/docs/reference/commandline/cli.md @@ -223,6 +223,10 @@ Users can override your custom or the default key sequence on a per-container basis. To do this, the user specifies the `--detach-keys` flag with the `docker attach`, `docker exec`, `docker run` or `docker start` command. +The property `plugins` contains settings specific to CLI plugins. The +key is the plugin name, while the value is a further map of options, +which are specific to that plugin. + Following is a sample `config.json` file: ```json @@ -246,7 +250,16 @@ Following is a sample `config.json` file: "awesomereg.example.org": "hip-star", "unicorn.example.com": "vcbait" }, - "stackOrchestrator": "kubernetes" + "stackOrchestrator": "kubernetes", + "plugins": { + "plugin1": { + "option": "value" + }, + "plugin2": { + "anotheroption": "anothervalue", + "athirdoption": "athirdvalue" + } + } } {% endraw %} ```