Skip to content

chore: rename SSL to TLS #504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion admin/access-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions admin/workspace-management/ssh-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion admin/workspace-providers/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 0 additions & 6 deletions guides/ssl-certificates/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions guides/tls-certificates/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: TLS certificates
description: Learn how to use cert-manager to set up TLS certificates.
---

<children></children>
File renamed without changes.
6 changes: 3 additions & 3 deletions images/ssl-certificates.md → images/tls-certificates.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
12 changes: 6 additions & 6 deletions manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"path": "./images/configure.md"
},
{
"path": "./images/ssl-certificates.md"
"path": "./images/tls-certificates.md"
},
{
"path": "./images/deprecating.md"
Expand Down Expand Up @@ -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"
}
]
},
Expand Down
2 changes: 1 addition & 1 deletion setup/air-gapped/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion setup/kubernetes/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion setup/kubernetes/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion setup/kubernetes/google.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion setup/kubernetes/k3s.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).