Skip to content

docs: update port forwarding to state it works without a wildcard with tunnel #4887

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.

Sign up for GitHub

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 7 commits into from
Nov 9, 2022
Merged

docs: update port forwarding to state it works without a wildcard with tunnel #4887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dcf982b
docs: update port forwarding to state it works without a wildcard wit…
sharkymark Nov 3, 2022
6818b28
Update docs/networking/port-forwarding.md
sharkymark Nov 4, 2022
4968585
resolve linting errors
ghuntley Nov 9, 2022
d1a20c6
Update docs/networking/port-forwarding.md
ghuntley Nov 9, 2022
2a809d1
resolve another linting issue
ghuntley Nov 9, 2022
6e6c210
#til it appears .md is required in the pre step
ghuntley Nov 9, 2022
25d3764
one more
ghuntley Nov 9, 2022
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
6 changes: 5 additions & 1 deletion docs/networking/port-forwarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.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 an arbitrary port

Expand Down
4 changes: 2 additions & 2 deletions docs/secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<blockquote class="info">
This article explains how to use secrets in a workspace. To authenticate the
workspace provisioner, see <a href="./templates/authentication">this</a>.
workspace provisioner, see [this](./admin/auth.md).
</blockquote>

Coder is open-minded about how you get your secrets into your workspaces.
Expand All @@ -20,7 +20,7 @@ Often, this workflow is simply:
1. Your users write them to a persistent file after
they've built their workspace

<a href="./templates#parameters">Template parameters</a> 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.

Expand Down