From bb0505dabbfb9b65c2bbb4d6d4fd87f4758a1a66 Mon Sep 17 00:00:00 2001 From: Ni Rui Date: Tue, 19 Dec 2023 16:12:38 +0800 Subject: [PATCH] Add mentioning for `--publish 127.0.0.1:8182:8182` and it's use case --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 3fc0327..2a3ac8a 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,14 @@ $ docker run --detach \ niruix/sshwifty:latest ``` +This will open port `8182` on the Docker host to accept traffic from all remote +clients, and serve these clients with Sshwifty instance running inside the +container. + +Operator can also use `--publish 127.0.0.1:8182:8182` to open Sshwifty to only +local clients, which is useful if the Sshwifty instance is intended to run +behind a reverse-proxy hosted on the same host. + When TLS is desired and you don't want to setup Docker Volumes, you can use `SSHWIFTY_DOCKER_TLSCERT` and `SSHWIFTY_DOCKER_TLSCERTKEY` environment variables to import credential files to the container and automatically apply them: