summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-03-10 10:11:48 +0100
committerGitHub <noreply@github.com>2021-03-10 10:11:48 +0100
commit4d9227d22ce3df326f8c93c1e3619981ad9f5955 (patch)
treed5115339f668328858cc37bdb61b719171ad2a40
parentd98b55f03b43701bea2398123c761d02e7c61239 (diff)
parentdc0c72a48b50fd43594928172d88182fd81f3e8b (diff)
downloadpodman-4d9227d22ce3df326f8c93c1e3619981ad9f5955.tar.gz
podman-4d9227d22ce3df326f8c93c1e3619981ad9f5955.tar.bz2
podman-4d9227d22ce3df326f8c93c1e3619981ad9f5955.zip
Merge pull request #9678 from xcffl/doc-sock-in-container-privileged
[CI:DOCS] Add docs about how to access APIs inside containers
-rw-r--r--docs/source/markdown/podman-system-service.1.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md
index 54ce3f040..93f18adf1 100644
--- a/docs/source/markdown/podman-system-service.1.md
+++ b/docs/source/markdown/podman-system-service.1.md
@@ -13,6 +13,10 @@ If no endpoint is provided, defaults will be used. The default endpoint for a r
service is *unix:/run/podman/podman.sock* and rootless is *unix:/$XDG_RUNTIME_DIR/podman/podman.sock* (for
example *unix:/run/user/1000/podman/podman.sock*)
+To access the API service inside a container:
+- mount the socket as a volume
+- run the container with `--security-opt label:disable`
+
The REST API provided by **podman system service** is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer.
Documentation for the latter is available at *https://docs.podman.io/en/latest/_static/api.html*.
Both APIs are versioned, but the server will not reject requests with an unsupported version set.