From bd34973588dda7483270d0b61ecc95caf288d16d Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Fri, 19 Jan 2024 09:35:22 +0100 Subject: [PATCH 1/4] feat: expose support links as env variables --- codersdk/deployment.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/codersdk/deployment.go b/codersdk/deployment.go index baa49d58ed92a..820d02bc27a82 100644 --- a/codersdk/deployment.go +++ b/codersdk/deployment.go @@ -1793,11 +1793,10 @@ Write out the current server config as YAML to stdout.`, { Name: "Support Links", Description: "Support links to display in the top right drop down menu.", + Env: "CODER_SUPPORT_LINKS", YAML: "supportLinks", Value: &c.Support.Links, - // The support links are hidden until they are defined in the - // YAML. - Hidden: true, + Hidden: false, }, { // Env handling is done in cli.ReadGitAuthFromEnvironment From bb1041016bf6d4e4f3c39ebc427a8da9f5377b09 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Fri, 19 Jan 2024 09:56:54 +0100 Subject: [PATCH 2/4] golden --- cli/testdata/coder_server_--help.golden | 3 +++ enterprise/cli/testdata/coder_server_--help.golden | 3 +++ 2 files changed, 6 insertions(+) diff --git a/cli/testdata/coder_server_--help.golden b/cli/testdata/coder_server_--help.golden index 950f1b4d9ceea..a974af15b433a 100644 --- a/cli/testdata/coder_server_--help.golden +++ b/cli/testdata/coder_server_--help.golden @@ -54,6 +54,9 @@ OPTIONS: The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". + struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS + Support links to display in the top right drop down menu. + --update-check bool, $CODER_UPDATE_CHECK (default: false) Periodically check for new releases of Coder and inform the owner. The check is performed once per day. diff --git a/enterprise/cli/testdata/coder_server_--help.golden b/enterprise/cli/testdata/coder_server_--help.golden index 190feeffa9945..24a0ed7f081e0 100644 --- a/enterprise/cli/testdata/coder_server_--help.golden +++ b/enterprise/cli/testdata/coder_server_--help.golden @@ -55,6 +55,9 @@ OPTIONS: The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". + struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS + Support links to display in the top right drop down menu. + --update-check bool, $CODER_UPDATE_CHECK (default: false) Periodically check for new releases of Coder and inform the owner. The check is performed once per day. From ec30d1e723b2eff75a47ad310e2330914c106585 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Fri, 19 Jan 2024 10:04:40 +0100 Subject: [PATCH 3/4] table --- cli/testdata/coder_server_--help.golden | 2 +- codersdk/deployment.go | 1 + docs/cli/server.md | 10 ++++++++++ enterprise/cli/testdata/coder_server_--help.golden | 2 +- 4 files changed, 13 insertions(+), 2 deletions(-) diff --git a/cli/testdata/coder_server_--help.golden b/cli/testdata/coder_server_--help.golden index a974af15b433a..23f7bba488bee 100644 --- a/cli/testdata/coder_server_--help.golden +++ b/cli/testdata/coder_server_--help.golden @@ -54,7 +54,7 @@ OPTIONS: The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". - struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS + --support-links struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS Support links to display in the top right drop down menu. --update-check bool, $CODER_UPDATE_CHECK (default: false) diff --git a/codersdk/deployment.go b/codersdk/deployment.go index 820d02bc27a82..191a1cb93d991 100644 --- a/codersdk/deployment.go +++ b/codersdk/deployment.go @@ -1794,6 +1794,7 @@ Write out the current server config as YAML to stdout.`, Name: "Support Links", Description: "Support links to display in the top right drop down menu.", Env: "CODER_SUPPORT_LINKS", + Flag: "support-links", YAML: "supportLinks", Value: &c.Support.Links, Hidden: false, diff --git a/docs/cli/server.md b/docs/cli/server.md index ca8062a411ca5..77f6d600e372c 100644 --- a/docs/cli/server.md +++ b/docs/cli/server.md @@ -918,6 +918,16 @@ Controls if the 'Strict-Transport-Security' header is set on all static file res Two optional fields can be set in the Strict-Transport-Security header; 'includeSubDomains' and 'preload'. The 'strict-transport-security' flag must be set to a non-zero value for these options to be used. +### --support-links + +| | | +| ----------- | ------------------------------------------ | +| Type | struct[[]codersdk.LinkConfig] | +| Environment | $CODER_SUPPORT_LINKS | +| YAML | supportLinks | + +Support links to display in the top right drop down menu. + ### --tls-address | | | diff --git a/enterprise/cli/testdata/coder_server_--help.golden b/enterprise/cli/testdata/coder_server_--help.golden index 24a0ed7f081e0..e2b27dc6d9234 100644 --- a/enterprise/cli/testdata/coder_server_--help.golden +++ b/enterprise/cli/testdata/coder_server_--help.golden @@ -55,7 +55,7 @@ OPTIONS: The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". - struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS + --support-links struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS Support links to display in the top right drop down menu. --update-check bool, $CODER_UPDATE_CHECK (default: false) From 450a7e6c747d20f08dfc80ed27d6642c588f2951 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Fri, 19 Jan 2024 10:16:45 +0100 Subject: [PATCH 4/4] fix test --- codersdk/deployment_test.go | 5 ----- 1 file changed, 5 deletions(-) diff --git a/codersdk/deployment_test.go b/codersdk/deployment_test.go index ef84d64501d60..97cd2ce82bfce 100644 --- a/codersdk/deployment_test.go +++ b/codersdk/deployment_test.go @@ -65,11 +65,6 @@ func TestDeploymentValues_HighlyConfigurable(t *testing.T) { "External Token Encryption Keys": { yaml: true, }, - // These complex objects should be configured through YAML. - "Support Links": { - flag: true, - env: true, - }, "External Auth Providers": { // Technically External Auth Providers can be provided through the env, // but bypassing clibase. See cli.ReadExternalAuthProvidersFromEnv. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy