Skip to content

Commit 3088f86

Browse files
authored
docs: Change serverNameOverride to not be testing only (#1286)
<!--- Note to EXTERNAL Contributors --> <!-- Thanks for opening a PR! If it is a significant code change, please **make sure there is an open issue** for this. We work best with you when we have accepted the idea first before you code. --> <!--- For ALL Contributors 👇 --> ## What was changed Change serverNameOverride to not be testing only ## Why? Using serverNameOverride is a legitimate use case in production cases ## Checklist <!--- add/delete as needed ---> 1. Closes <!-- add issue number here --> 2. How was this tested: <!--- Please describe how you tested your changes/how we can test them --> 3. Any docs updates needed? <!--- update README if applicable or point out where to update docs.temporal.io -->
1 parent ede666e commit 3088f86

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

packages/common/src/internal-non-workflow/tls-config.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
/** TLS configuration options. */
22
export interface TLSConfig {
33
/**
4-
* Overrides the target name used for SSL host name checking.
5-
* If this attribute is not specified, the name used for SSL host name checking will be the host from {@link ServerOptions.url}.
6-
* This _should_ be used for testing only.
4+
* Overrides the target name (SNI) used for TLS host name checking.
5+
* If this attribute is not specified, the name used for TLS host name checking will be the host from {@link ServerOptions.url}.
6+
* This can be useful when you have reverse proxy in front of temporal server, and you may want to override the SNI to
7+
* direct traffic to the appropriate backend server based on custom routing rules. Oppositely, connections could be refused
8+
* if the provided SNI does not match the expected host. Adding this override should be done with care.
79
*/
810
serverNameOverride?: string;
911
/**

0 commit comments

Comments
 (0)