Specify a local address when exposing ports with Docker (#20891)

* Specify a local address when exposing ports with Docker

cf. https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose

Signed-off-by: Richard Gibson <richard.gibson@gmail.com>

* Provide and explain docker run examples with and without confinement to localhost

Signed-off-by: Richard Gibson <richard.gibson@gmail.com>

* Update README.md

Co-authored-by: Richard Gibson <richard.gibson@gmail.com>

---------

Signed-off-by: Richard Gibson <richard.gibson@gmail.com>
Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Richard Gibson 2024-11-01 08:59:16 -04:00 committed by GitHub
parent a27dfa1825
commit b8fd98ab3c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -41,7 +41,15 @@ The Docker image can be used to serve element-web as a web server. The easiest w
it is to use the prebuilt image: it is to use the prebuilt image:
```bash ```bash
docker run -p 80:80 vectorim/element-web docker run --rm -p 127.0.0.1:80:80 vectorim/element-web
```
A server can also be made available to clients outside the local host by omitting the
explicit local address as described in
[docker run documentation](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose):
```bash
docker run --rm -p 80:80 vectorim/element-web
``` ```
To supply your own custom `config.json`, map a volume to `/app/config.json`. For example, To supply your own custom `config.json`, map a volume to `/app/config.json`. For example,
@ -49,7 +57,7 @@ if your custom config was located at `/etc/element-web/config.json` then your Do
would be: would be:
```bash ```bash
docker run -p 80:80 -v /etc/element-web/config.json:/app/config.json vectorim/element-web docker run --rm -p 127.0.0.1:80:80 -v /etc/element-web/config.json:/app/config.json vectorim/element-web
``` ```
To build the image yourself: To build the image yourself: