diff --git a/admin/access-url.md b/admin/access-url.md index 6f7c00d4c..294375a96 100644 --- a/admin/access-url.md +++ b/admin/access-url.md @@ -25,7 +25,7 @@ shown. to the external IP address you obtained in the previous step. > If your custom domain uses the HTTPS protocol, make sure that you have -> [SSL certificates](../guides/ssl-certificates/index.md) for use with your +> [TLS certificates](../guides/tls-certificates/index.md) for use with your > Coder deployment. Otherwise, you can skip this step. ## Step 2: Update the Helm chart and redeploy Coder diff --git a/admin/workspace-management/ssh-access.md b/admin/workspace-management/ssh-access.md index d3266fb1c..311e1d2cb 100644 --- a/admin/workspace-management/ssh-access.md +++ b/admin/workspace-management/ssh-access.md @@ -60,17 +60,17 @@ X11UseLocalhost no ``` > X11 forwarding will fail with `X11 forwarding request failed on channel 0` if -`xauth` is not installed. +> `xauth` is not installed. ### SSH environment variables -OpenSSH handles environment variables differently than most container -processes. Environment variable overrides for OpenSSH sessions are set by +OpenSSH handles environment variables differently than most container processes. +Environment variable overrides for OpenSSH sessions are set by `~/.ssh/environment` and `/etc/environment`. Note that these values will override those specified in the Dockerfile `ENV` directives. -At workspace startup, Coder injects the image defined environment variables -into `~/.ssh/environment`, as well as a set of Coder-defined defaults. +At workspace startup, Coder injects the image defined environment variables into +`~/.ssh/environment`, as well as a set of Coder-defined defaults. The following snippet shows an example of what this file may look like for a new workspace. @@ -118,5 +118,5 @@ ssh: ``` > **For Cloudflare users:** Cloudflare's **proxied** mode does _not_ support -> SSH. If you're using Cloudflare for SSL, add your certificates to your cluster +> SSH. If you're using Cloudflare for TLS, add your certificates to your cluster > and use the **DNS only** mode to allow SSH. diff --git a/admin/workspace-providers/deployment.md b/admin/workspace-providers/deployment.md index 9fc6bbd11..acc711237 100644 --- a/admin/workspace-providers/deployment.md +++ b/admin/workspace-providers/deployment.md @@ -122,7 +122,7 @@ when communicating with the Coder deployment. for more details. For installations using HTTPS, you must - [ensure the deployment has a valid certificate](../../guides/ssl-certificates/index.md). + [ensure the deployment has a valid certificate](../../guides/tls-certificates/index.md). If you're unfamiliar with the helm configuration values file, see our doc on [updating a helm chart](../../guides/admin/helm-charts.md) diff --git a/assets/guides/ssl-certificates/cloudflare-1.png b/assets/guides/tls-certificates/cloudflare-1.png similarity index 100% rename from assets/guides/ssl-certificates/cloudflare-1.png rename to assets/guides/tls-certificates/cloudflare-1.png diff --git a/guides/ssl-certificates/index.md b/guides/ssl-certificates/index.md deleted file mode 100644 index 587edb25d..000000000 --- a/guides/ssl-certificates/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: SSL certificates -description: Learn how to use cert-manager to set up SSL certificates. ---- - - diff --git a/guides/ssl-certificates/azureDNS.md b/guides/tls-certificates/azureDNS.md similarity index 99% rename from guides/ssl-certificates/azureDNS.md rename to guides/tls-certificates/azureDNS.md index fc67479d5..eab4d4edc 100644 --- a/guides/ssl-certificates/azureDNS.md +++ b/guides/tls-certificates/azureDNS.md @@ -1,7 +1,7 @@ --- title: Azure DNS description: - Learn how to use cert-manager to set up SSL certificates using Azure DNS for + Learn how to use cert-manager to set up TLS certificates using Azure DNS for DNS01 challenges. --- diff --git a/guides/ssl-certificates/cloudDNS.md b/guides/tls-certificates/cloudDNS.md similarity index 98% rename from guides/ssl-certificates/cloudDNS.md rename to guides/tls-certificates/cloudDNS.md index 55e5602c8..c8336cdbe 100644 --- a/guides/ssl-certificates/cloudDNS.md +++ b/guides/tls-certificates/cloudDNS.md @@ -1,7 +1,7 @@ --- title: Google Cloud DNS description: - Learn how to use cert-manager to set up SSL certificates using Google Cloud + Learn how to use cert-manager to set up TLS certificates using Google Cloud DNS for DNS01 challenges. --- diff --git a/guides/ssl-certificates/cloudflare.md b/guides/tls-certificates/cloudflare.md similarity index 99% rename from guides/ssl-certificates/cloudflare.md rename to guides/tls-certificates/cloudflare.md index 9f4cda47c..43830de65 100644 --- a/guides/ssl-certificates/cloudflare.md +++ b/guides/tls-certificates/cloudflare.md @@ -76,7 +76,7 @@ Create a token with the following settings: You can also add more zones (or give the token access to all zones in your account), and set an expiry date. -![Create Custom Token](../../assets/guides/ssl-certificates/cloudflare-1.png) +![Create Custom Token](../../assets/guides/tls-certificates/cloudflare-1.png) Click **Continue to summary**, then **Create Token**. Be sure to copy and save the token displayed because Cloudflare will not display it again. diff --git a/guides/tls-certificates/index.md b/guides/tls-certificates/index.md new file mode 100644 index 000000000..11f4637be --- /dev/null +++ b/guides/tls-certificates/index.md @@ -0,0 +1,6 @@ +--- +title: TLS certificates +description: Learn how to use cert-manager to set up TLS certificates. +--- + + diff --git a/guides/ssl-certificates/route53.md b/guides/tls-certificates/route53.md similarity index 100% rename from guides/ssl-certificates/route53.md rename to guides/tls-certificates/route53.md diff --git a/images/ssl-certificates.md b/images/tls-certificates.md similarity index 88% rename from images/ssl-certificates.md rename to images/tls-certificates.md index 877c01afb..81910be66 100644 --- a/images/ssl-certificates.md +++ b/images/tls-certificates.md @@ -1,9 +1,9 @@ --- -title: "SSL certificates" -description: Learn how to add SSL certificates to Coder images +title: "TLS certificates" +description: Learn how to add TLS certificates to Coder images --- -This article will show you how to correct issues regarding SSL certificates in +This article will show you how to correct issues regarding TLS certificates in Coder. ## Background diff --git a/manifest.json b/manifest.json index f1f49c525..b3b348ee1 100644 --- a/manifest.json +++ b/manifest.json @@ -89,7 +89,7 @@ "path": "./images/configure.md" }, { - "path": "./images/ssl-certificates.md" + "path": "./images/tls-certificates.md" }, { "path": "./images/deprecating.md" @@ -341,19 +341,19 @@ ] }, { - "path": "./guides/ssl-certificates/index.md", + "path": "./guides/tls-certificates/index.md", "children": [ { - "path": "./guides/ssl-certificates/azureDNS.md" + "path": "./guides/tls-certificates/azureDNS.md" }, { - "path": "./guides/ssl-certificates/cloudDNS.md" + "path": "./guides/tls-certificates/cloudDNS.md" }, { - "path": "./guides/ssl-certificates/cloudflare.md" + "path": "./guides/tls-certificates/cloudflare.md" }, { - "path": "./guides/ssl-certificates/route53.md" + "path": "./guides/tls-certificates/route53.md" } ] }, diff --git a/setup/air-gapped/index.md b/setup/air-gapped/index.md index 030d1a65e..ab089930e 100644 --- a/setup/air-gapped/index.md +++ b/setup/air-gapped/index.md @@ -111,7 +111,7 @@ platform images are hosted in Coder's Docker Hub repo. When building images for your workspaces that rely on a custom certificate authority, be sure to follow the - [docs for adding certificates](../../images/ssl-certificates#adding-certificates-for-coder) + [docs for adding certificates](../../images/tls-certificates#adding-certificates-for-coder) to images. 1. Tag and push all of the images that you've downloaded in the previous step to diff --git a/setup/kubernetes/aws.md b/setup/kubernetes/aws.md index 31efaec42..bc10f783b 100644 --- a/setup/kubernetes/aws.md +++ b/setup/kubernetes/aws.md @@ -233,6 +233,6 @@ For more information, see: ## Next steps To access Coder through a secure domain, review our guides on configuring and -using [SSL certificates](../../guides/ssl-certificates/index.md). +using [TLS certificates](../../guides/tls-certificates/index.md). Once complete, see our page on [installation](../installation.md). diff --git a/setup/kubernetes/azure.md b/setup/kubernetes/azure.md index b6eb2393e..156e3cb1f 100644 --- a/setup/kubernetes/azure.md +++ b/setup/kubernetes/azure.md @@ -140,6 +140,6 @@ For more information, see: ## Next steps To access Coder through a secure domain, review our guides on configuring and -using [SSL certificates](../../guides/ssl-certificates/index.md). +using [TLS certificates](../../guides/tls-certificates/index.md). Once complete, see our page on [installation](../installation.md). diff --git a/setup/kubernetes/google.md b/setup/kubernetes/google.md index 188f6654c..0a98f4fdc 100644 --- a/setup/kubernetes/google.md +++ b/setup/kubernetes/google.md @@ -151,6 +151,6 @@ For more information, see: ## Next steps To access Coder through a secure domain, review our guides on configuring and -using [SSL certificates](../../guides/ssl-certificates/index.md). +using [TLS certificates](../../guides/tls-certificates/index.md). Once complete, see our page on [installation](../installation.md). diff --git a/setup/kubernetes/k3s.md b/setup/kubernetes/k3s.md index 2b8d58b3a..0d573e824 100644 --- a/setup/kubernetes/k3s.md +++ b/setup/kubernetes/k3s.md @@ -137,6 +137,6 @@ cp /etc/rancher/k3s/k3s.yaml ~/.kube/config ## Next steps To access Coder through a secure domain, review our guides on configuring and -using [SSL certificates](../../guides/ssl-certificates/index.md). +using [TLS certificates](../../guides/tls-certificates/index.md). Once complete, see our page on [installation](../installation.md).