mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
a21a6d2f4a
* docs: replaced manual up next blocks with doc tag in workspaces.md * replaced up next blocks with <doc page=""> tags * revert back to markdown now that we updated how these links work, we can have them as markdown on github and as cards on the docs website. Co-authored-by: Anton Korzhuk <antonkorzhuk@gmail.com>
66 lines
2.1 KiB
Markdown
66 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 create --template="<templateName>" <workspaceName>
|
|
|
|
# show the resources behind the workspace and how to connect
|
|
coder show <workspace-name>
|
|
```
|
|
|
|
## IDEs
|
|
|
|
Coder [supports multiple IDEs](ides.md) for use with your workspaces.
|
|
|
|
## 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/templates](https://github.com/coder/coder/tree/c6b1daabc5a7aa67bfbb6c89966d728919ba7f80/examples/templates).
|
|
>
|
|
> You can use `coder 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 update <workspace-name>
|
|
```
|
|
|
|
## Logging
|
|
|
|
Coder stores macOS and Linux logs at the following locations:
|
|
|
|
| Service | Location |
|
|
| ---------------- | ------------------------------- |
|
|
| `startup_script` | `/tmp/coder-startup-script.log` |
|
|
| Agent | `/tmp/coder-agent.log` |
|
|
|
|
---
|
|
|
|
## Up next
|
|
- Learn about how to personalize your workspace with [Dotfiles](./dotfiles.md)
|
|
- Learn about using [IDEs](./ides.md)
|