-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: provide guidance on shared workspaces #21214
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
Open
jcjiang
wants to merge
10
commits into
main
Choose a base branch
from
shared-workspaces-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
31b6f0c
first draft of shared workspaces page
jcjiang 14ee9b2
Merge branch 'main' into shared-workspaces-docs
jcjiang 81ecf0e
Update docs/user-guides/workspaces-shared.md
jcjiang 85ac594
Update docs/user-guides/workspaces-shared.md
jcjiang 55fa18c
Update docs/user-guides/workspaces-shared.md
jcjiang beb5adb
Update docs/user-guides/workspaces-shared.md
jcjiang a1450ae
Update docs/user-guides/workspaces-shared.md
jcjiang 3b661d2
Update docs/user-guides/workspaces-shared.md
jcjiang 589a651
added beta tag
jcjiang 8f030be
Merge branch 'main' into shared-workspaces-docs
jcjiang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Shared Workspaces | ||
|
|
||
| Multiple users can securely connect to a single Coder workspace for programming and debugging. | ||
|
|
||
| <!-- Insert screenshot of UI here --> | ||
|
|
||
| ## Features | ||
|
|
||
| Workspace sharing is available to all Coder users by default, but platform admins with a Premium subscription can choose to disable sharing within their organizations or for their entire deployment. | ||
|
|
||
| Owners of a workspace can grant access to other users or groups with scoped roles. | ||
|
|
||
| This is helpful in a number of scenarios, including: | ||
|
|
||
| - Developers can do ad-hoc debugging or pair programming. | ||
| - A workspace can be owned by a group of users for QA, on-call rotations, or shared staging. | ||
| - AI workflows where an agent prepares a workspace and a developer takes over to review or finalize the work (ex. with [Coder Tasks](https://coder.com/docs/ai-coder/tasks).) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Workspaces can be shared through either the Coder CLI or UI. | ||
|
|
||
| Before you begin, ensure that you have a version of Coder with workspace sharing enabled and that your account has permission to share workspaces. This is true by default if you are an OSS user, but deployments with Premium licenses may be restricted by admins. | ||
|
|
||
| ### CLI | ||
|
|
||
| To share a workspace: | ||
| - `coder sharing share <workspace> --user alice` | ||
| - Shares the workspace with a single user, `alice`, with `use` permissions | ||
| - `coder sharing share <workspace> --user alice:admin,bob` | ||
| - Shares the workspace with two users - `alice` with `admin` permissions, and `bob` with `use` permissions | ||
| - `coder sharing share <workspace> --group contractor` | ||
| - Shares the workspace with `contractor`, which is a group of users | ||
|
|
||
| To remove sharing from a workspace: | ||
| - `coder sharing remove <workspace> --user alice` | ||
| - Workspace is no longer shared with the user `alice`. | ||
| - `coder sharing remove <workspace> --group contractor` | ||
| - Workspace is no longer shared with the group `contractor`. | ||
|
|
||
| To show who a workspace is shared with: | ||
| - `coder sharing show <workspace>` | ||
|
|
||
| To list shared workspaces: | ||
| - `coder list --shared` | ||
| - `coder list --search shared_with_user:<user>` | ||
| - `coder list --search shared_with_group:<group>` | ||
|
|
||
| ### UI | ||
|
|
||
| 1. Open a workspace that you own. | ||
| 2. Locate and click the 'Share' button. | ||
|
|
||
| <!-- Add screenshot of where the button is located in the UI --> | ||
|
|
||
| 3. Add the users or groups that you want to share the workspace with. For each one, select a role. | ||
| - `use` allows for connection via SSH and apps, the ability to start and stop the workspace, view logs and stats, and update on start when required. | ||
| - `admin` allows for all of the above, as well as the ability to rename the workspace, update at any time, and invite others with the `use` role. | ||
| - Neither role allows for the user to delete the workspace. | ||
|
|
||
|
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we change the name to shared-workspaces.md please? the reversed word order feels a little unnatural.
alternatively, workspace-sharing.md would also be fine