Skip to content

Commit 54261b6

Browse files
ericpaulsenbpmct
andauthored
docs: add auto-start/stop (#4728)
* docs: add auto-start/stop * feedback Co-authored-by: Ben Potter <ben@coder.com> Co-authored-by: Ben Potter <ben@coder.com>
1 parent a82f05a commit 54261b6

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed

docs/images/auto-start.png

241 KB
Loading

docs/images/auto-stop.png

123 KB
Loading

docs/images/schedule.png

90.5 KB
Loading

docs/workspaces.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Coder [supports multiple IDEs](ides.md) for use with your workspaces.
2424

2525
Workspaces in Coder are started and stopped, often based on whether there was
2626
any activity or if there was a [template
27-
update](./templates.md#manage-templates) available.
27+
update](./templates.md#start/stop) available.
2828

2929
Resources are often destroyed and re-created when a workspace is restarted,
3030
though the exact behavior depends on the template's definitions. For more
@@ -40,6 +40,28 @@ resources](./templates.md#persistent-vs-ephemeral-resources).
4040
4141
When a workspace is deleted, all of the workspace's resources are deleted.
4242

43+
## Workspace scheduling
44+
45+
By default, workspaces are manually turned on/off by the user. However, a schedule
46+
can be defined on a per-workspace basis to automate the workspace start/stop.
47+
48+
![Scheduling UI](./images/schedule.png)
49+
50+
### Auto-start
51+
52+
The auto-start feature automates the workspace build at a user-specified time
53+
and day(s) of the week. In addition, users can select their preferred timezone.
54+
55+
![Auto-start UI](./images/auto-start.png)
56+
57+
### Auto-stop
58+
59+
The auto-stop feature shuts off workspaces after given number of hours in the "on"
60+
state. If Coder detects workspace connection activity, the auto-stop timer is bumped up
61+
one hour. IDE, SSH, Port Forwarding, and coder_app activity trigger this bump.
62+
63+
![auto-stop UI](./images/auto-stop.png)
64+
4365
## Updating workspaces
4466

4567
Use the following command to update a workspace to the latest template version.

0 commit comments

Comments
 (0)