diff --git a/cli/testdata/coder_server_--help.golden b/cli/testdata/coder_server_--help.golden index c9e4818ed9..bd78da21e6 100644 --- a/cli/testdata/coder_server_--help.golden +++ b/cli/testdata/coder_server_--help.golden @@ -391,7 +391,9 @@ NETWORKING OPTIONS: --host-prefix-cookie bool, $CODER_HOST_PREFIX_COOKIE (default: false) Recommended to be enabled. Enables `__Host-` prefix for cookies to - guarantee they are only set by the right domain. + guarantee they are only set by the right domain. This change is + disruptive to any workspaces built before release 1.31, requiring a + workspace restart. NETWORKING / DERP OPTIONS: Most Coder deployments never have to think about DERP because all connections diff --git a/cli/testdata/server-config.yaml.golden b/cli/testdata/server-config.yaml.golden index fa7057c60b..2477c5bcaf 100644 --- a/cli/testdata/server-config.yaml.golden +++ b/cli/testdata/server-config.yaml.golden @@ -182,7 +182,8 @@ networking: # (default: lax, type: enum[lax\|none]) sameSiteAuthCookie: lax # Recommended to be enabled. Enables `__Host-` prefix for cookies to guarantee - # they are only set by the right domain. + # they are only set by the right domain. This change is disruptive to any + # workspaces built before release 1.31, requiring a workspace restart. # (default: false, type: bool) hostPrefixCookie: false # Whether Coder only allows connections to workspaces via the browser. diff --git a/codersdk/deployment.go b/codersdk/deployment.go index a586c6cf56..f249b5b060 100644 --- a/codersdk/deployment.go +++ b/codersdk/deployment.go @@ -2912,7 +2912,7 @@ func (c *DeploymentValues) Options() serpent.OptionSet { }, { Name: "__Host Prefix Cookies", - Description: "Recommended to be enabled. Enables `__Host-` prefix for cookies to guarantee they are only set by the right domain.", + Description: "Recommended to be enabled. Enables `__Host-` prefix for cookies to guarantee they are only set by the right domain. This change is disruptive to any workspaces built before release 1.31, requiring a workspace restart.", Flag: "host-prefix-cookie", Env: "CODER_HOST_PREFIX_COOKIE", Value: serpent.BoolOf(&c.HTTPCookies.EnableHostPrefix), diff --git a/docs/reference/cli/server.md b/docs/reference/cli/server.md index 85a314b16a..dee0b48423 100644 --- a/docs/reference/cli/server.md +++ b/docs/reference/cli/server.md @@ -1067,7 +1067,7 @@ Controls the 'SameSite' property is set on browser session cookies. | YAML | networking.hostPrefixCookie | | Default | false | -Recommended to be enabled. Enables `__Host-` prefix for cookies to guarantee they are only set by the right domain. +Recommended to be enabled. Enables `__Host-` prefix for cookies to guarantee they are only set by the right domain. This change is disruptive to any workspaces built before release 1.31, requiring a workspace restart. ### --terms-of-service-url diff --git a/enterprise/cli/testdata/coder_server_--help.golden b/enterprise/cli/testdata/coder_server_--help.golden index a253c074a0..cb9d69c65a 100644 --- a/enterprise/cli/testdata/coder_server_--help.golden +++ b/enterprise/cli/testdata/coder_server_--help.golden @@ -392,7 +392,9 @@ NETWORKING OPTIONS: --host-prefix-cookie bool, $CODER_HOST_PREFIX_COOKIE (default: false) Recommended to be enabled. Enables `__Host-` prefix for cookies to - guarantee they are only set by the right domain. + guarantee they are only set by the right domain. This change is + disruptive to any workspaces built before release 1.31, requiring a + workspace restart. NETWORKING / DERP OPTIONS: Most Coder deployments never have to think about DERP because all connections