diff --git a/docs/images/auto-start.png b/docs/images/auto-start.png new file mode 100644 index 0000000000..71363f0b74 Binary files /dev/null and b/docs/images/auto-start.png differ diff --git a/docs/images/auto-stop.png b/docs/images/auto-stop.png new file mode 100644 index 0000000000..fe176d8732 Binary files /dev/null and b/docs/images/auto-stop.png differ diff --git a/docs/images/schedule.png b/docs/images/schedule.png new file mode 100644 index 0000000000..7c4c2eb035 Binary files /dev/null and b/docs/images/schedule.png differ diff --git a/docs/workspaces.md b/docs/workspaces.md index 5839a7e056..874ae94c75 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -24,7 +24,7 @@ Coder [supports multiple IDEs](ides.md) for use with your workspaces. 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. +update](./templates.md#start/stop) 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 @@ -40,6 +40,28 @@ resources](./templates.md#persistent-vs-ephemeral-resources). When a workspace is deleted, all of the workspace's resources are deleted. +## Workspace scheduling + +By default, workspaces are manually turned on/off by the user. However, a schedule +can be defined on a per-workspace basis to automate the workspace start/stop. + +![Scheduling UI](./images/schedule.png) + +### Auto-start + +The auto-start feature automates the workspace build at a user-specified time +and day(s) of the week. In addition, users can select their preferred timezone. + +![Auto-start UI](./images/auto-start.png) + +### Auto-stop + +The auto-stop feature shuts off workspaces after given number of hours in the "on" +state. If Coder detects workspace connection activity, the auto-stop timer is bumped up +one hour. IDE, SSH, Port Forwarding, and coder_app activity trigger this bump. + +![auto-stop UI](./images/auto-stop.png) + ## Updating workspaces Use the following command to update a workspace to the latest template version.