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/manage/fleet/provision/setup.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -229,13 +229,13 @@ It also configures timeouts to control how long `viam-agent` waits for a valid l
229
229
|`hotspot_prefix`| string | Optional |`viam-agent` will prepend this to the hostname of the device and use the resulting string for the provisioning hotspot SSID. Default: `"viam-setup"`. |
230
230
|`hotspot_password`| string | Optional | The Wifi password for the provisioning hotspot. Default: `"viamsetup"`. |
231
231
|`disable_captive_portal_redirect`| boolean | Optional | By default, ALL DNS lookups using the provisioning hotspot will redirect to the device. This causes most phones/mobile devices to automatically redirect the user to the captive portal as a "sign in" screen. When disabled, only domains ending in .setup (ex: viam.setup) will be redirected. This generally avoids displaying the portal to users and is mainly used in conjunction with a mobile provisioning application workflow. Default: `false`. |
232
-
|`turn_on_hotspot_if_wifi_has_no_internet`| boolean | Optional | By default, the device will only attempt to connect to a single wifi network (the one with the highest priority), provided during initial provisioning/setup using the provisioning mobile app or captive web portal. Wifi connection alone is enough to consider the device as "online" even if the global internet is not reachable. If the primary network configured during provisioning cannot be connected to and roaming mode is enabled, the device will attempt connections to all configured networks in `networks`, and only consider the device online if the internet is reachable. Default: `false`. |
232
+
|`turn_on_hotspot_if_wifi_has_no_internet`| boolean | Optional | By default, the device will only attempt to connect to a single wifi network (the one with the highest priority), provided during initial provisioning/setup using the provisioning mobile app or captive web portal. Wifi connection alone is enough to consider the device as "online" even if the global internet is not reachable. If the primary network configured during provisioning cannot be connected to and `turn_on_hotspot_if_wifi_has_no_internet` mode is enabled, the device will attempt connections to all configured networks in `networks`, and only consider the device online if the internet is reachable. Default: `false`. |
233
233
|`offline_before_starting_hotspot_minutes`| integer | Optional | Will only enter provisioning mode (hotspot) after being disconnected longer than this time. Useful on flaky connections, or when part of a system where the device may start quickly, but the wifi/router may take longer to be available. Default: `2` (2 minutes). |
234
234
|`user_idle_minutes`| integer | Optional | Amount of time before considering a user (using the captive web portal or provisioning app) idle, and resuming normal behavior. Used to avoid interrupting provisioning mode (for example for network tests/retries) when a user might be busy entering details. Default: `5` (5 minutes). |
235
235
|`retry_connection_timeout_minutes`| integer | Optional | Provisioning mode will exit after this time, to allow other unmanaged (for example wired) or manually configured connections to be tried. Provisioning mode will restart if the connection/online status doesn't change. Default: `10` (10 minutes). |
236
236
|`networks`| array | Optional | Add additional networks the machine can connect to for provisioning. We recommend that you add WiFi settings in the operating system (for example, directly in NetworkManager) rather than in this file, or in the corresponding machine config in the Viam app, if networks aren't needed until after initial provisioning. See [Networks](/manage/reference/viam-agent/#network_configuration). Default: `[]`. |
237
-
|`wifi_power_save`| boolean | Optional |If set, will explicitly enable or disable power save for all WiFi connections managed by NetworkManager. |
238
-
|`device_reboot_after_offline_minutes`| integer | Optional | If set, `viam-agent` will reboot the device after it has been offline for the specified duration. Default: `0` (disabled). |
237
+
|`wifi_power_save`| boolean | Optional |Boolean, which, if set, will explicitly enable or disable power save for all WiFi connections managed by NetworkManager. If not set, the system default applies. Default: `NULL`. |
238
+
|`device_reboot_after_offline_minutes`| integer | Optional | If set, `viam-agent` will reboot the device after it has been offline (and in hotspot mode) for the specified duration. Default: `0` (disabled). |
239
239
240
240
{{% /expand%}}
241
241
@@ -496,7 +496,7 @@ For a guide you can give to end users for setting up their machine, see [Setup m
496
496
497
497
-`agent-provisioning` will use the provided network if it can connect, even if that network does not have internet access.
498
498
Note that any features that require internet access will not function if the connected WiFi network is not connected to the internet.
499
-
If you want `agent-provisioning` to require that a WiFi network be connected to the internet in order to connect to it, enable roaming mode.
499
+
If you want `agent-provisioning` to require that a WiFi network be connected to the internet in order to connect to it, enable `turn_on_hotspot_if_wifi_has_no_internet`.
500
500
501
501
1.`viam-agent` then starts `viam-server` with the provided configuration and the machine becomes **live**.
502
502
@@ -536,7 +536,7 @@ For a guide you can give to end users for setting up their machine, see [Setup m
536
536
537
537
-`agent-provisioning` will use the provided network if it can connect, even if that network does not have internet access.
538
538
Note that any features that require internet access will not function if the connected WiFi network is not connected to the internet.
539
-
If you want `agent-provisioning` to require that a WiFi network be connected to the internet in order to connect to it, enable roaming mode.
539
+
If you want `agent-provisioning` to require that a WiFi network be connected to the internet in order to connect to it, enable `turn_on_hotspot_if_wifi_has_no_internet`.
540
540
541
541
1.`viam-agent` then starts `viam-server` with the provided configuration and the machine becomes **live**.
Copy file name to clipboardExpand all lines: docs/manage/reference/viam-agent/_index.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -216,8 +216,8 @@ To ensure that updates only occur when your machines are ready, configure a [mai
216
216
<!-- prettier-ignore -->
217
217
| Name | Type | Required? | Description |
218
218
| ---------- | ---- | --------- | ----------- |
219
-
|`agent`| string | true | The version of Viam agent specified as `"X.Y.Z"`or `"stable"`. Viam agent is semantically versioned and is tested before release. Releases happen infrequently. When set to `"stable"`, `viam-agent` will automatically upgrade when a new stable version is released. Default: `"stable"`. |
220
-
|`viam-server`| string | true | The version of `viam-server` specified as `"X.Y.Z"`or `"stable"`. `viam-server` is semantically versioned and is tested before release. When set to `"stable"`, `viam-server` will automatically upgrade when a new stable version is released. Default: `"stable"`. |
219
+
|`agent`| string | true | The version of Viam agent specified as `"5.6.77"`, `"stable"`or by providing a URL such as `"http://example.com/viam-agent-test-aarch64"` or `"file://home/myuser/viam-agent-test-aarch64"`. Viam agent is semantically versioned and is tested before release. Releases happen infrequently. When set to `"stable"`, `viam-agent` will automatically upgrade when a new version is released. Default: `"stable"`. |
220
+
|`viam-server`| string | true | The version of `viam-server` specified as `"5.6.77"`, `"stable"`or by providing a URL such as `"http://example.com/viam-agent-test-aarch64"` or `"file://home/myuser/viam-server-test-aarch64"`. `viam-server` is semantically versioned and is tested before release. When set to `"stable"`, `viam-server` will automatically upgrade when a new stable version is released. Default: `"stable"`. |
221
221
222
222
{{< alert title="Important" color="note" >}}
223
223
When `viam-agent` updates itself, you must [restart `viam-agent`](/manage/reference/viam-agent/manage-viam-agent/) or reboot in order to use the new version.
@@ -241,10 +241,10 @@ For more information on managing `viam-agent` see:
|`debug`| boolean | false |Sets the log level to debug for any logging from the Viam agent binary. Default: `false`. |
245
245
|`disable_network_configuration`| boolean | false | Disables the network and hotspot configuration, as well as the configuration of additional networks. Default: `false`. |
246
246
|`disable_system_configuration`| boolean | false | Disables the system configuration. Default: `false`. |
|`disable_viam_server`| boolean | false |Disable `viam-server` remotely. This option is often used by developers working on Viam agent or when manually running `viam-server`. Default: `false`. |
|`wait_for_update_check`| boolean | false | If set to `true`, `viam-agent` will wait for a network connection and check for updates before starting `viam-server`. See [Reduce startup time](#reduce-startup-time). Default: `true`. |
250
250
@@ -277,7 +277,7 @@ You can also start `viam-agent` in fast start mode by setting `VIAM_AGENT_FAST_S
277
277
|`model`| string | false | Purely informative. May be displayed on captive portal or provisioning app. Default: `"custom"`. |
278
278
|`offline_before_starting_hotspot_minutes`| integer | false | Will only enter provisioning mode (hotspot) after being disconnected longer than this time. Useful on flaky connections, or when part of a system where the device may start quickly, but the wifi/router may take longer to be available. Default: `2` (2 minutes). |
279
279
|`retry_connection_timeout_minutes`| integer | Optional | Provisioning mode will exit after this time, to allow other unmanaged (for example wired) or manually configured connections to be tried. Provisioning mode will restart if the connection/online status doesn't change. Default: `10` (10 minutes). |
280
-
|`turn_on_hotspot_if_wifi_has_no_internet`| boolean | false | By default, the device will only attempt to connect to a single wifi network (the one with the highest priority), provided during initial provisioning/setup using the provisioning mobile app or captive web portal. Wifi connection alone is enough to consider the device as "online" even if the global internet is not reachable. If the primary network configured during provisioning cannot be connected to and roaming mode is enabled, the device will attempt connections to all configured networks in `networks`, and only consider the device online if the internet is reachable. Default: `false`. |
280
+
|`turn_on_hotspot_if_wifi_has_no_internet`| boolean | false | By default, the device will only attempt to connect to a single wifi network (the one with the highest priority), provided during initial provisioning/setup using the provisioning mobile app or captive web portal. Wifi connection alone is enough to consider the device as "online" even if the global internet is not reachable. If the primary network configured during provisioning cannot be connected to and `turn_on_hotspot_if_wifi_has_no_internet` is enabled, the device will attempt connections to all configured networks in `networks`, and only consider the device online if the internet is reachable. Default: `false`. |
281
281
|`user_idle_minutes`| integer | false | Amount of time before considering a user (using the captive web portal or provisioning app) idle, and resuming normal behavior. Used to avoid interrupting provisioning mode (for example for network tests/retries) when a user might be busy entering details. Default: `5` (5 minutes). |
282
282
|`wifi_power_save`| boolean | false | If set, will explicitly enable or disable power save for all WiFi connections managed by NetworkManager. If not set, the system default applies. Default: `false`. |
283
283
@@ -292,14 +292,14 @@ It's primarily useful for a machine that moves between different networks, so th
292
292
| Name | Type | Required? | Description |
293
293
| ---------- | ---- | --------- | ----------- |
294
294
|`interface`| string | optional | Name of interface, for example: `"wlan0"`, `"eth0"`, `"enp14s0"`. Default: `""`. |
|`ipv4_route_metric`| integer | optional | IPv4 route metric. Lower values are preferred. Default: `100` for wired networks and `600` for wireless network. Otherwise the default is `0` or `-1`. |
299
-
|`priority`| integer | optional | Priority to choose the network with. Values between -999 and 999. Default: `0`. |
298
+
|`ipv4_route_metric`| integer | optional | IPv4 route metric. Lower values are preferred. Default: `0` which defaults to `100` for wired networks and `600` for wireless network. |
299
+
|`priority`| integer | optional | Priority to choose the network with. Values between -999 and 999 with higher values taking precedence. Default: `0`. |
|`type`| string | optional | The type of the network. Options: `"wifi"`. Default: `""`. |
301
+
|`ssid`| string | optional | The WiFi network's SSID. Only needed for WiFi networks. Default: `""`. |
302
+
|`type`| string | optional | The type of the network. Options: `"wifi"`, `"wired"`. Default: `""`. |
303
303
304
304
To add additional networks add them using the JSON editor for your device's config in the Viam app.
305
305
@@ -318,7 +318,7 @@ If the highest-priority network is not available or the machine can connect but
318
318
| ---------- | ---- | --------- | ----------- |
319
319
|`logging_journald_runtime_max_use_megabytes`| integer | optional |Set the temporary space limit for logs. `-1` to disable. Default: `512` (512 MB). |
320
320
|`logging_journald_system_max_use_megabytes`| integer | optional | Sets the maximum disk space `journald` will user for persistent log storage. `-1` to disable. Default: `512` (512 MB). |
321
-
|`os_auto_upgrade_type`| boolean | optional | Manage OS package updates using Viam by setting this field. Installs the `unattended-upgrades` package, and replace `20auto-upgrades` and `50unattended-upgrades` in <FILE>/etc/apt/apt.conf.d/</FILE>, with an automatically generated Origins-Pattern list that is generated based on that of `50unattended-upgrades`. Custom repos installed on the system at the time the setting is enabled will be included. Options: `"all"` (automatic upgrades are performed for all packages), `"security"` (automatic upgrades for only packages containing `"security"` in their codename (for example `bookworm-security`)), `""` (disable automatic upgrades). Default: `""`. |
321
+
|`os_auto_upgrade_type`| boolean | optional | Manage OS package updates using Viam by setting this field. Installs the `unattended-upgrades` package, and replace `20auto-upgrades` and `50unattended-upgrades` in <FILE>/etc/apt/apt.conf.d/</FILE>, with an automatically generated Origins-Pattern list that is generated based on that of `50unattended-upgrades`. Custom repos installed on the system at the time the setting is enabled will be included. Options: `"all"` (automatic upgrades are performed for all packages), `"security"` (automatic upgrades for only packages containing `"security"` in their codename (for example `bookworm-security`)), `"disable"` (disable automatic upgrades), `""` (do not change system settings). Default: `""`. |
322
322
323
323
For more detailed instructions, see [Configure machine settings](https://docs.viam.com/manage/fleet/system-settings/).
0 commit comments