You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/workspaces.md
+19-13Lines changed: 19 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,27 +37,33 @@ information, see [Resource Persistence](./templates/resource-persistence.md).
37
37
38
38
When a workspace is deleted, all of the workspace's resources are deleted.
39
39
40
-
## Workspace scheduling
40
+
## Workspace auto-stop
41
41
42
-
By default, workspaces are manually turned on/off by the user. However, a schedule
43
-
can be defined on a per-workspace basis to automate the workspace start/stop.
42
+
In Coder, workspaces can auto-stop when the user is not actively using the workspace. By default, Coder recognizing the following actions as activity and will keep the workspace online:
- Open WebSockets (web terminal, [web IDEs](./ides/web-ides.md) such as code-server and JupyterLab)
46
47
47
-
### Autostart
48
+
> [Custom activity](#TODO) can be registered via Coder's REST API, such as an ongoing data science pipeline.
48
49
49
-
The autostart feature automates the workspace build at a user-specified time
50
-
and day(s) of the week. In addition, users can select their preferred timezone.
50
+
<!-- TODO. Document this. We may want to move to a custom activity section. See coder/coder[#8064](https://github.com/coder/coder/issues/8064) and coder/coder#5629 -->
51
51
52
-

52
+
Your workspace's auto-stop behavior can be seen in the dashboard. Template settings in Coder determine if users can alter their workspace schedules.
53
53
54
-
### Autostop
54
+

55
55
56
-
The autostop feature shuts off workspaces after given number of hours in the "on"
57
-
state. If Coder detects workspace connection activity, the autostop timer is bumped up
58
-
one hour. IDE, SSH, Port Forwarding, and coder_app activity trigger this bump.
56
+
### Max workspace lifetime (enterprise)
59
57
60
-

58
+
Workspaces may also have a max lifetime, which enforces a stop or restart even if you are actively using your workspace.
59
+
60
+

61
+
62
+
To avoid interruptions, users can establish their "quiet hours", which are by default set from midnight to 4 AM, during which these actions occur. Users can also extend the deadline by up to 3 hours if they are in the middle of important work.
63
+
64
+

65
+
66
+
Admin controls around workspace auto-stop are an enterprise feature. [Learn more here](./admin/template)
0 commit comments