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
-`dir` (String) The starting directory when a user creates a shell session. Defaults to `"$HOME"`.
77
77
-`display_apps` (Block Set, Max: 1) The list of built-in apps to display in the agent bar. (see [below for nested schema](#nestedblock--display_apps))
78
78
-`env` (Map of String) A mapping of environment variables to set inside the workspace.
79
-
-`login_before_ready` (Boolean, **Deprecated**: Configure `startup_script_behavior` instead. This attribute will be removed in a future version of the provider.) 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 `startup_script` is done and has exited. When enabled, users may see an incomplete workspace when logging in.
80
79
-`metadata` (Block List) Each `metadata` block defines a single item consisting of a key/value pair. This feature is in alpha and may break in future releases. (see [below for nested schema](#nestedblock--metadata))
81
80
-`motd_file` (String) The path to a file within the workspace containing a message to display to users when they login via SSH. A typical value would be `"/etc/motd"`.
82
81
-`order` (Number) The order determines the position of agents in the UI presentation. The lowest order is shown first and agents with equal order are sorted by name (ascending order).
83
82
-`shutdown_script` (String) A script to run before the agent is stopped. The script should exit when it is done to signal that the workspace can be stopped. This option is an alias for defining a `coder_script` resource with `run_on_stop` set to `true`.
84
-
-`shutdown_script_timeout` (Number, **Deprecated**: This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.) Time in seconds until the agent lifecycle status is marked as timed out during shutdown, this happens when the shutdown script has not completed (exited) in the given time.
85
83
-`startup_script` (String) A script to run after the agent starts. The script should exit when it is done to signal that the agent is ready. This option is an alias for defining a `coder_script` resource with `run_on_start` set to `true`.
86
84
-`startup_script_behavior` (String) This option sets the behavior of the `startup_script`. When set to `"blocking"`, the `startup_script` must exit before the workspace is ready. When set to `"non-blocking"`, the `startup_script` may run in the background and the workspace will be ready immediately. Default is `"non-blocking"`, although `"blocking"` is recommended. This option is an alias for defining a `coder_script` resource with `start_blocks_login` set to `true` (blocking).
87
-
-`startup_script_timeout` (Number, **Deprecated**: This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.) Time in seconds until the agent lifecycle status is marked as timed out during start, this happens when the startup script has not completed (exited) in the given time.
88
85
-`troubleshooting_url` (String) A URL to a document with instructions for troubleshooting problems with the agent.
Description: "Time in seconds until the agent lifecycle status is marked as timed out during start, this happens when the startup script has not completed (exited) in the given time.",
137
-
Deprecated: "This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.",
138
-
ValidateFunc: validation.IntAtLeast(1),
139
-
},
140
131
"shutdown_script": {
141
132
Type: schema.TypeString,
142
133
ForceNew: true,
143
134
Optional: true,
144
135
Description: "A script to run before the agent is stopped. The script should exit when it is done to signal that the workspace can be stopped. This option is an alias for defining a `coder_script` resource with `run_on_stop` set to `true`.",
145
136
},
146
-
"shutdown_script_timeout": {
147
-
Type: schema.TypeInt,
148
-
Default: 300,
149
-
ForceNew: true,
150
-
Optional: true,
151
-
Description: "Time in seconds until the agent lifecycle status is marked as timed out during shutdown, this happens when the shutdown script has not completed (exited) in the given time.",
152
-
Deprecated: "This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.",
Description: "The path to a file within the workspace containing a message to display to users when they login via SSH. A typical value would be `\"/etc/motd\"`.",
181
163
},
182
-
"login_before_ready": {
183
-
// Note: When this is removed, "startup_script_behavior" should
184
-
// be set to "non-blocking" by default (instead of empty string).
185
-
Type: schema.TypeBool,
186
-
Default: true,
187
-
ForceNew: true,
188
-
Optional: true,
189
-
Description: "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 `startup_script` is done and has exited. When enabled, users may see an incomplete workspace when logging in.",
190
-
Deprecated: "Configure `startup_script_behavior` instead. This attribute will be removed in a future version of the provider.",
0 commit comments