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/resources/script.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -18,14 +18,17 @@ Use this resource to run a script from an agent.
18
18
### Required
19
19
20
20
-`agent_id` (String) The "id" property of a "coder_agent" resource to associate with.
21
+
-`display_name` (String) The display name of the script to display logs in the dashboard.
21
22
-`script` (String) The script to run.
22
23
23
24
### Optional
24
25
25
-
-`login_before_ready` (Boolean) This option defines whether or not the user can (by default) login to the workspace before it is ready. Ready means that e.g. the script is done and has exited. When enabled, users may see an incomplete workspace when logging in.
26
+
-`cron` (String) The cron schedule to run the script on. This is a cron expression.
27
+
-`icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
28
+
-`log_path` (String) The path of a file to write the logs to. If relative, it will be appended to tmp.
26
29
-`run_on_start` (Boolean) This option defines whether or not the script should run when the agent starts.
27
30
-`run_on_stop` (Boolean) This option defines whether or not the script should run when the agent stops.
28
-
-`schedule` (String) The schedule to run the script on. This is a cron expression.
31
+
-`start_blocks_login` (Boolean) This option defines whether or not the user can (by default) login to the workspace before this script completes running on start. When enabled, users may see an incomplete workspace when logging in.
29
32
-`timeout` (Number) Time in seconds until the agent lifecycle status is marked as timed out, this happens when the script has not completed (exited) in the given time.
0 commit comments