feat: Add documentation for workspace proxy creation #7377
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bpmct
approved these changes
May 3, 2023
docs/admin/workspaceproxies.md
Outdated
|
|
||
| A workspace proxy is a relay connection a developer can choose to use when connecting with their workspace over ssh, a workspace app, port forwarding, etc. | ||
|
|
||
| <!-- TODO: Might want to modify this diagram? --> |
There was a problem hiding this comment.
I modified next.config.js in my coder.com codebase to allow other origins (e.g. imgur) to preview this temporarily. Not bad! I don't think we need to modify this, but will defer to you and Dean.
There was a problem hiding this comment.
🙏
I figure someone can make a better graphic. I just wanted something since it's way easier to understand when illustrated.
There was a problem hiding this comment.
Yeah this really helps convey how it works
|
Oh - had another thought. It'd be helpful to mention that workspace proxies only need network connectivity to the Coder dashboard URL and only need port 443 exposed. Workspace proxies do not need to connect to the database. |
bpmct
reviewed
May 4, 2023
bpmct
reviewed
May 4, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial documentation for workspace proxies. This will evolve over time.
Disclaimer that is is experimental is at the top. So we can merge these docs if we are happy with the language and modify as we develop.