From f6c1feb26f143dbae5fc6cb9acbe6e156bc70d61 Mon Sep 17 00:00:00 2001 From: Shivam Shukla Date: Tue, 7 Jul 2026 00:54:00 +0530 Subject: [PATCH] docs: clarify CMD_PORT is used for URL generation with CMD_PATH The docs claimed that host and port are completely ignored when a UNIX domain socket path is configured. However, the port is still used for URL generation when urlAddPort is enabled. Closes #6515 Signed-off-by: Shivam Shukla --- docs/content/configuration.md | 2 +- docs/content/guides/reverse-proxy.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/configuration.md b/docs/content/configuration.md index 4a8cdf76..8830c633 100644 --- a/docs/content/configuration.md +++ b/docs/content/configuration.md @@ -81,7 +81,7 @@ these are rarely used for various reasons. | `urlPath` | `CMD_URL_PATH` | **`null`**, `hedgedoc` | If HedgeDoc is run from a subdirectory like `www.example.com/` | | `host` | `CMD_HOST` | **`0.0.0.0`**, `localhost` | interface/ip to listen on | | `port` | `CMD_PORT` | **`3000`**, `80` | port to listen on | -| `path` | `CMD_PATH` | **no default**, `/var/run/hedgedoc.sock` | path to UNIX domain socket to listen on (if specified, `host` or `CMD_HOST` and `port` or `CMD_PORT` are ignored) | +| `path` | `CMD_PATH` | **no default**, `/var/run/hedgedoc.sock` | path to UNIX domain socket to listen on (if specified, `host` or `CMD_HOST` and `port` or `CMD_PORT` are ignored for listening; however, `port` or `CMD_PORT` is still used for URL generation when `urlAddPort` is enabled) | | `protocolUseSSL` | `CMD_PROTOCOL_USESSL` | **`false`** or `true` | set to use SSL protocol for resources path (only applied when domain is set) | | `useSSL` | | **`false`** or `true` | set to use SSL server (if `true`, will auto turn on `protocolUseSSL`) | | `urlAddPort` | `CMD_URL_ADDPORT` | **`false`** or `true` | set to add port on callback URL (ports `80` or `443` won't be applied) (only applied when domain is set) | diff --git a/docs/content/guides/reverse-proxy.md b/docs/content/guides/reverse-proxy.md index 16eebba1..17a8094d 100644 --- a/docs/content/guides/reverse-proxy.md +++ b/docs/content/guides/reverse-proxy.md @@ -19,7 +19,7 @@ This documentation will cover HTTPS setup, with comments for HTTP setup. | `domain` | `CMD_DOMAIN` | The full domain where your instance will be available | `hedgedoc.example.com` | | `host` | `CMD_HOST` | An ip or domain name that is only available to HedgeDoc and your reverse proxy | `localhost` | | `port` | `CMD_PORT` | An available port number on that IP | `3000` | -| `path` | `CMD_PATH` | path to UNIX domain socket to listen on (if specified, `host` or `CMD_HOST` and `port` or `CMD_PORT` are ignored) | `/var/run/hedgedoc.sock` | +| `path` | `CMD_PATH` | path to UNIX domain socket to listen on (if specified, `host` or `CMD_HOST` and `port` or `CMD_PORT` are ignored for listening; however, `port` or `CMD_PORT` is still used for URL generation when `urlAddPort` is enabled) | `/var/run/hedgedoc.sock` | | `protocolUseSSL` | `CMD_PROTOCOL_USESSL` | `true` if you want to serve your instance over SSL (HTTPS), `false` if you want to use plain HTTP | `true` | | `useSSL` | | `false`, the communications between HedgeDoc and the proxy are unencrypted | `false` | | `urlAddPort` | `CMD_URL_ADDPORT` | `false`, HedgeDoc should not append its port to the URLs it links | `false` |