From 10df6ceabdb61396bb4c712daa004ebd135f1c3c Mon Sep 17 00:00:00 2001 From: Jocelyn Le Sage Date: Fri, 19 May 2023 13:08:59 -0400 Subject: [PATCH] Updated documentation about ports. --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 004ff32..47c683f 100644 --- a/README.md +++ b/README.md @@ -169,15 +169,21 @@ format: `:[:PERMISSIONS]`. ### Ports -Here is the list of ports used by the container. They can be mapped to the host -via the `-p` parameter (one per port mapping). Each mapping is defined in the -following format: `:`. The port number inside the -container cannot be changed, but you are free to use any port on the host side. +Here is the list of ports used by the container. -| Port | Mapping to host | Description | -|------|-----------------|-------------| -| 5800 | Optional | Port to access the application's GUI via the web interface. Mapping to the host is optional if access through the web interface is not wanted. For a container not using the default bridge network, the port can be changed with the `WEB_LISTENING_PORT` environment variable. | -| 5900 | Optional | Port to access the application's GUI via the VNC protocol. Mapping to the host is optional if access through the VNC protocol is not wanted. For a container not using the default bridge network, the port can be changed with the `VNC_LISTENING_PORT` environment variable. | +When using the default bridge network, ports can be mapped to the host via the +`-p` parameter (one per port mapping). Each mapping is defined with the +following format: `:`. The port number used inside +the container might not be changeable, but you are free to use any port on the +host side. + +See the [Docker Container Networking](https://docs.docker.com/config/containers/container-networking) +documentation for more details. + +| Port | Protocol | Mapping to host | Description | +|------|----------|-----------------|-------------| +| 5800 | TCP | Optional | Port to access the application's GUI via the web interface. Mapping to the host is optional if access through the web interface is not wanted. For a container not using the default bridge network, the port can be changed with the `WEB_LISTENING_PORT` environment variable. | +| 5900 | TCP | Optional | Port to access the application's GUI via the VNC protocol. Mapping to the host is optional if access through the VNC protocol is not wanted. For a container not using the default bridge network, the port can be changed with the `VNC_LISTENING_PORT` environment variable. | ### Changing Parameters of a Running Container