mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
22668c388c
* docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * fix typos * Update docs/about.md Co-authored-by: Joe Previte <jjprevite@gmail.com> * remove line breaks between bullets * rename variables to parameters * reduce limits * chore: edit text * revert some changes, fix footnotes Co-authored-by: Katie Horne <katie@coder.com> Co-authored-by: Joe Previte <jjprevite@gmail.com>
77 lines
2.1 KiB
Markdown
77 lines
2.1 KiB
Markdown
# Workspaces
|
|
|
|
Workspaces contain the IDEs, dependencies, and configuration information needed
|
|
for software development.
|
|
|
|
## Create workspaces
|
|
|
|
Each Coder user has their own workspaces created from [shared
|
|
templates](./templates.md):
|
|
|
|
```sh
|
|
# create a workspace from the template; specify any variables
|
|
coder workspaces create <workspace-name>
|
|
|
|
# show the resources behind the workspace, and how to connect
|
|
coder workspaces show <workspace-name>
|
|
```
|
|
|
|
## Connect with SSH
|
|
|
|
Once you've added your workspaces to your SSH hosts, you can connect from any
|
|
IDE with remote development support:
|
|
|
|
```sh
|
|
coder config-ssh
|
|
|
|
ssh coder.<workspace-name>
|
|
```
|
|
|
|
## Editors and IDEs
|
|
|
|
The following desktop IDEs have been tested with Coder, though any IDE with SSH
|
|
support should work!
|
|
|
|
- VS Code (with [Remote -
|
|
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
|
|
extension)
|
|
- JetBrains (with
|
|
[Gateway](https://www.jetbrains.com/help/idea/remote-development-a.html#launch_gateway)
|
|
installed)
|
|
- IntelliJ IDEA
|
|
- CLion
|
|
- GoLand
|
|
- PyCharm
|
|
- Rider
|
|
- RubyMine
|
|
- WebStorm
|
|
|
|
## Workspace lifecycle
|
|
|
|
Workspaces in Coder are started and stopped, often based on whether there was
|
|
any activity or if there was a [template
|
|
update](./templates.md#manage-templates) available.
|
|
|
|
Resources are often destroyed and re-created when a workspace is restarted,
|
|
though the exact behavior depends on the template's definitions. For more
|
|
information, see [persistent and ephemeral
|
|
resources](./templates.md#persistent-and-ephemeral-resources).
|
|
|
|
> ⚠️ To avoid data loss, refer to your template documentation for information on
|
|
> where to store files, install software, etc., so that they persist. Default
|
|
> templates are documented in [../examples](../examples/).
|
|
>
|
|
> You can use `coder workspace show <workspace-name>` to see which resources are
|
|
> persistent and which are ephemeral.
|
|
|
|
When a workspace is deleted, all of the workspace's resources are deleted.
|
|
|
|
## Updating workspaces
|
|
|
|
Use the following command to update a workspace to the latest template version.
|
|
The workspace will be stopped and started:
|
|
|
|
```sh
|
|
coder workspaces update <workspace-name>
|
|
```
|