From dcf982bb915e60622e7059fc1188d0f44c694288 Mon Sep 17 00:00:00 2001 From: Mark Milligan Date: Thu, 3 Nov 2022 18:38:41 -0500 Subject: [PATCH 1/7] docs: update port forwarding to state it works without a wildcard with tunnel --- docs/networking/port-forwarding.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/networking/port-forwarding.md b/docs/networking/port-forwarding.md index 9118a484eb09a..67ab27c97505f 100644 --- a/docs/networking/port-forwarding.md +++ b/docs/networking/port-forwarding.md @@ -45,7 +45,11 @@ For more examples, see `coder port-forward --help`. ## Dashboard > To enable port forwarding via the dashboard, Coder must be configured with a -> [wildcard access URL](../admin/configure.md#wildcard-access-url). +> [wildcard access URL](../admin/configure.md#wildcard-access-url). If an access +> URL is not specified, Coder will create [a publicly accessible +> URL](../admin/configure#tunnel) to reverse proxy the deployment, and port +> forwarding will work. There is a known limitation where if the port forwarding +> URL length is greater than 63 characters, port fordwarding will not work. ### From an arbitrary port From 6818b287f9cd5f906b936f64e0e5fe6cc4eec715 Mon Sep 17 00:00:00 2001 From: sharkymark Date: Thu, 3 Nov 2022 19:29:54 -0500 Subject: [PATCH 2/7] Update docs/networking/port-forwarding.md Thank you sir Co-authored-by: Ammar Bandukwala --- docs/networking/port-forwarding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/networking/port-forwarding.md b/docs/networking/port-forwarding.md index 67ab27c97505f..d69677b8f4469 100644 --- a/docs/networking/port-forwarding.md +++ b/docs/networking/port-forwarding.md @@ -49,7 +49,7 @@ For more examples, see `coder port-forward --help`. > URL is not specified, Coder will create [a publicly accessible > URL](../admin/configure#tunnel) to reverse proxy the deployment, and port > forwarding will work. There is a known limitation where if the port forwarding -> URL length is greater than 63 characters, port fordwarding will not work. +> URL length is greater than 63 characters, port forwarding will not work. ### From an arbitrary port From 4968585f9be8e8c6d2b0614426db08fef26e555e Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 9 Nov 2022 08:50:44 +0000 Subject: [PATCH 3/7] resolve linting errors --- docs/networking/port-forwarding.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/networking/port-forwarding.md b/docs/networking/port-forwarding.md index d69677b8f4469..85c275db8ee12 100644 --- a/docs/networking/port-forwarding.md +++ b/docs/networking/port-forwarding.md @@ -46,10 +46,10 @@ For more examples, see `coder port-forward --help`. > To enable port forwarding via the dashboard, Coder must be configured with a > [wildcard access URL](../admin/configure.md#wildcard-access-url). If an access -> URL is not specified, Coder will create [a publicly accessible -> URL](../admin/configure#tunnel) to reverse proxy the deployment, and port -> forwarding will work. There is a known limitation where if the port forwarding -> URL length is greater than 63 characters, port forwarding will not work. +> URL is not specified, Coder will create [a publicly accessible URL](../admin/configure#tunnel) +> to reverse proxy the deployment, and port forwarding will work. There is a +> known limitation where if the port forwarding URL length is greater than 63 +> characters, port forwarding will not work. ### From an arbitrary port From d1a20c692359022623dd70d03166c57e2b9da586 Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 9 Nov 2022 19:01:13 +1000 Subject: [PATCH 4/7] Update docs/networking/port-forwarding.md --- docs/networking/port-forwarding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/networking/port-forwarding.md b/docs/networking/port-forwarding.md index 85c275db8ee12..08028561b54ec 100644 --- a/docs/networking/port-forwarding.md +++ b/docs/networking/port-forwarding.md @@ -45,7 +45,7 @@ For more examples, see `coder port-forward --help`. ## Dashboard > To enable port forwarding via the dashboard, Coder must be configured with a -> [wildcard access URL](../admin/configure.md#wildcard-access-url). If an access +> [wildcard access URL](../admin/configure#wildcard-access-url). If an access > URL is not specified, Coder will create [a publicly accessible URL](../admin/configure#tunnel) > to reverse proxy the deployment, and port forwarding will work. There is a > known limitation where if the port forwarding URL length is greater than 63 From 2a809d13a19018473cd855450a6088d5e525a367 Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 9 Nov 2022 09:16:08 +0000 Subject: [PATCH 5/7] resolve another linting issue --- docs/secrets.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/secrets.md b/docs/secrets.md index c3566b3ed3877..03c3753a4fe61 100644 --- a/docs/secrets.md +++ b/docs/secrets.md @@ -2,7 +2,7 @@
This article explains how to use secrets in a workspace. To authenticate the -workspace provisioner, see this. +workspace provisioner, see [this](./admin/auth).
Coder is open-minded about how you get your secrets into your workspaces. @@ -20,7 +20,7 @@ Often, this workflow is simply: 1. Your users write them to a persistent file after they've built their workspace -Template parameters are a dangerous way to accept secrets. +[Template parameters](./templates#parameters)> are a dangerous way to accept secrets. We show parameters in cleartext around the product. Assume anyone with view access to a workspace can also see its parameters. From 6e6c210a6cb80e676f548d7a793e2fad4a1944e5 Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 9 Nov 2022 09:26:53 +0000 Subject: [PATCH 6/7] #til it appears .md is required in the pre step --- docs/networking/port-forwarding.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/networking/port-forwarding.md b/docs/networking/port-forwarding.md index 08028561b54ec..ce8bb6822f5e6 100644 --- a/docs/networking/port-forwarding.md +++ b/docs/networking/port-forwarding.md @@ -45,8 +45,8 @@ For more examples, see `coder port-forward --help`. ## Dashboard > To enable port forwarding via the dashboard, Coder must be configured with a -> [wildcard access URL](../admin/configure#wildcard-access-url). If an access -> URL is not specified, Coder will create [a publicly accessible URL](../admin/configure#tunnel) +> [wildcard access URL](../admin/configure.md#wildcard-access-url). If an access +> URL is not specified, Coder will create [a publicly accessible URL](../admin/configure.md#tunnel) > to reverse proxy the deployment, and port forwarding will work. There is a > known limitation where if the port forwarding URL length is greater than 63 > characters, port forwarding will not work. From 25d376451c2b2cca1f20e71a22acfdfcb3d4947b Mon Sep 17 00:00:00 2001 From: Geoffrey Huntley Date: Wed, 9 Nov 2022 09:30:14 +0000 Subject: [PATCH 7/7] one more --- docs/secrets.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/secrets.md b/docs/secrets.md index 03c3753a4fe61..f135c4602c577 100644 --- a/docs/secrets.md +++ b/docs/secrets.md @@ -2,7 +2,7 @@
This article explains how to use secrets in a workspace. To authenticate the -workspace provisioner, see [this](./admin/auth). +workspace provisioner, see [this](./admin/auth.md).
Coder is open-minded about how you get your secrets into your workspaces. @@ -20,7 +20,7 @@ Often, this workflow is simply: 1. Your users write them to a persistent file after they've built their workspace -[Template parameters](./templates#parameters)> are a dangerous way to accept secrets. +[Template parameters](./templates.md#parameters)> are a dangerous way to accept secrets. We show parameters in cleartext around the product. Assume anyone with view access to a workspace can also see its parameters.