From d4a0003122f94229723a9139db7da90600170dc3 Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 12 Sep 2022 15:35:28 -0600 Subject: Man pages: Refactor common options: --publish Almost identical between podman-create, run, and pod-create. The "Notes" are different, so I left those duplicated between podman-create and run, and left the different one in pod-create. podman-container-restore also has --publish but it's unrelated. Signed-off-by: Ed Santiago --- docs/source/markdown/options/publish.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/source/markdown/options/publish.md (limited to 'docs/source/markdown/options') diff --git a/docs/source/markdown/options/publish.md b/docs/source/markdown/options/publish.md new file mode 100644 index 000000000..a0394b692 --- /dev/null +++ b/docs/source/markdown/options/publish.md @@ -0,0 +1,19 @@ +#### **--publish**, **-p**=*[[ip:][hostPort]:]containerPort[/protocol]* + +Publish a container's port, or range of ports,<<| within this pod>> to the host. + +Both *hostPort* and *containerPort* can be specified as a range of ports. +When specifying ranges for both, the number of container ports in the +range must match the number of host ports in the range. + +If host IP is set to 0.0.0.0 or not set at all, the port will be bound on all IPs on the host. + +By default, Podman will publish TCP ports. To publish a UDP port instead, give +`udp` as protocol. To publish both TCP and UDP ports, set `--publish` twice, +with `tcp`, and `udp` as protocols respectively. Rootful containers can also +publish ports using the `sctp` protocol. + +Host port does not have to be specified (e.g. `podman run -p 127.0.0.1::80`). +If it is not, the container port will be randomly assigned a port on the host. + +Use **podman port** to see the actual mapping: `podman port $CONTAINER $CONTAINERPORT`. -- cgit v1.2.3-54-g00ecf