summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Cassell <code@james.cassell.me>2019-05-01 09:07:17 -0400
committerJames Cassell <code@james.cassell.me>2019-05-01 20:56:57 -0400
commitcf982f148001bdcc05871908eb0763f16077edcf (patch)
tree7c470818bd15b103347716962194541d9a082792
parenteea77b5ae3e7fb8a60d438a79d3a4b30d35bb67c (diff)
downloadpodman-cf982f148001bdcc05871908eb0763f16077edcf.tar.gz
podman-cf982f148001bdcc05871908eb0763f16077edcf.tar.bz2
podman-cf982f148001bdcc05871908eb0763f16077edcf.zip
http-proxy: improve docs
Signed-off-by: James Cassell <code@james.cassell.me>
-rw-r--r--cmd/podman/common.go2
-rw-r--r--docs/podman-create.1.md12
-rw-r--r--docs/podman-run.1.md12
3 files changed, 23 insertions, 3 deletions
diff --git a/cmd/podman/common.go b/cmd/podman/common.go
index b02aa5990..8aca08248 100644
--- a/cmd/podman/common.go
+++ b/cmd/podman/common.go
@@ -315,7 +315,7 @@ func getCreateFlags(c *cliconfig.PodmanCommand) {
)
createFlags.Bool(
"http-proxy", true,
- "Set proxy environment variables in container based on the host proxy vars",
+ "Set proxy environment variables in the container based on the host proxy vars",
)
createFlags.String(
"image-volume", cliconfig.DefaultImageVolume,
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 884a8adcc..e097a753a 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -250,7 +250,17 @@ By default proxy environment variables are passed into the container if set
for the podman process. This can be disabled by setting the `--http-proxy`
option to `false`. The environment variables passed in include `http_proxy`,
`https_proxy`, `ftp_proxy`, `no_proxy`, and also the upper case versions of
-those.
+those. This option is only needed when the host system must use a proxy but
+the container should not use any proxy. Proxy environment variables specified
+for the container in any other way will override the values that would have
+been passed thru from the host. (Other ways to specify the proxy for the
+container include passing the values with the `--env` flag, or hardcoding the
+proxy environment at container build time.)
+
+For example, to disable passing these environment variables from host to
+container:
+
+`--http-proxy=false`
Defaults to `true`
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index a0c17652a..5bc32ad52 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -257,7 +257,17 @@ By default proxy environment variables are passed into the container if set
for the podman process. This can be disabled by setting the `--http-proxy`
option to `false`. The environment variables passed in include `http_proxy`,
`https_proxy`, `ftp_proxy`, `no_proxy`, and also the upper case versions of
-those.
+those. This option is only needed when the host system must use a proxy but
+the container should not use any proxy. Proxy environment variables specified
+for the container in any other way will override the values that would have
+been passed thru from the host. (Other ways to specify the proxy for the
+container include passing the values with the `--env` flag, or hardcoding the
+proxy environment at container build time.)
+
+For example, to disable passing these environment variables from host to
+container:
+
+`--http-proxy=false`
Defaults to `true`