From 4bdb00c385d9cad3d78ff5ef056742622e46738e Mon Sep 17 00:00:00 2001 From: confor Date: Mon, 14 Apr 2025 01:34:52 -0400 Subject: [PATCH] Document new server changes --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 022aae4..d805ec7 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,8 @@ bore server That's all it takes! After the server starts running at a given address, you can then update the `bore local` command with option `--to
` to forward a local port to this remote server. +It's possible to specify different IP addresses for the control server and for the tunnels. This setup is useful for cases where you might want the control server to be on a private network while allowing tunnel connections over a public interface, or vice versa. + The full options for the `bore server` command are shown below. ```shell @@ -93,10 +95,13 @@ Runs the remote proxy server Usage: bore server [OPTIONS] Options: - --min-port Minimum accepted TCP port number [default: 1024, env: BORE_MIN_PORT] - --max-port Maximum accepted TCP port number [default: 65535, env: BORE_MAX_PORT] - -s, --secret Optional secret for authentication [env: BORE_SECRET] - -h, --help Print help information + --min-port Minimum accepted TCP port number [env: BORE_MIN_PORT=] [default: 1024] + --max-port Maximum accepted TCP port number [env: BORE_MAX_PORT=] [default: 65535] + -s, --secret Optional secret for authentication [env: BORE_SECRET] + --control-addr IP address for the control server. Bore clients must reach this address [default: 0.0.0.0] + --tunnels-addr IP address where tunnels will listen on [default: 0.0.0.0] + -h, --help Print help + ``` ## Protocol