fix: accept legacy redirect HTTP environment variables (#10748)

mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00

> Can someone help me understand the differences between these env variables:
>
>    CODER_REDIRECT_TO_ACCESS_URL
>    CODER_TLS_REDIRECT_HTTP_TO_HTTPS
>    CODER_TLS_REDIRECT_HTTP

Oh man, what a mess. It looks like `CODER_TLS_REDIRECT_HTTP ` appears in our config docs. Maybe that was the initial name for the environment variable?

At some point, both the flag and the environment variable were `--tls-redirect-http-to-https` and `CODER_TLS_REDIRECT_HTTP_TO_HTTPS`.  `CODER_TLS_REDIRECT_HTTP` did nothing.

However, then we introduced `CODER_REDIRECT_TO_ACCESS_URL`, we put in some deprecation code that was maybe fat-fingered such that we accept the environment variable `CODER_TLS_REDIRECT_HTTP` but the flag `--tls-redirect-http-to-https`.  Our docs still refer to `CODER_TLS_REDIRECT_HTTP` at https://coder.com/docs/v2/latest/admin/configure#address

So, I think what we gotta do is still accept `CODER_TLS_REDIRECT_HTTP` since it was working and in an example doc, but also fix the deprecation code to accept `CODER_TLS_REDIRECT_HTTP_TO_HTTPS` environment variable.

This commit is contained in:

Spike Curtis

2023-11-17 15:09:29 +04:00

committed by

GitHub

parent fc249fab1e

commit 71f87d054f

5 changed files with 113 additions and 11 deletions

									
										docs/admin/configure.md
									
		+1
		-1
	
												View File
												
				@@ -29,7 +29,7 @@ export CODER_TLS_ENABLE=true

				export CODER_TLS_ADDRESS=0.0.0.0:443

				## Redirect from HTTP to HTTPS

				export CODER_TLS_REDIRECT_HTTP=true

				export CODER_REDIRECT_TO_ACCESS_URL=true

				# Start the Coder server

				coder server