Skip to content

Commit d56362e

Browse files
committed
Update
1 parent fbd698c commit d56362e

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

docs/manage/fleet/system-settings.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can set automatic upgrades to the following options:
3636
- `"security"`: automatic upgrades for only packages containing `"security"` in their codename (for example `bookworm-security`)
3737
- `""`: disable automatic upgrades
3838

39-
For complete reference information, see [viam-agent](/manage/reference/viam-agent/#system_configuration).
39+
For complete reference information, see [viam-agent](/manage/reference/viam-agent/#system-configuration).
4040

4141
## Configure networks
4242

@@ -82,7 +82,7 @@ By default, the maximum disk space `journald` will use for `viam-server` logs is
8282

8383
To adjust these settings update the `"agent"` value in the machine's JSON configuration.
8484

85-
For complete reference information, see [viam-agent](/manage/reference/viam-agent/#system_configuration) and the [`journald` docs](https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#SystemMaxUse=).
85+
For complete reference information, see [viam-agent](/manage/reference/viam-agent/#system-configuration) and the [`journald` docs](https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#SystemMaxUse=).
8686

8787
### Set the maximum disk space
8888

docs/manage/reference/viam-agent/_index.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ aliases:
1414

1515
The [`viam-agent`](https://github.com/viamrobotics/agent) is a self-updating service manager that maintains the lifecycle for itself and `viam-server`.
1616

17-
- [`system_configuration`](#system_configuration):
18-
1917
Among other things, `viam-agent`:
2018

2119
- Installs, runs, and monitors `viam-server` or a custom build of `viam-server`.
@@ -97,8 +95,8 @@ Edit and fill in the attributes as applicable.
9795
{
9896
"agent": {
9997
"version_control": {
100-
"agent": "stable",
101-
"viam-server": "0.52.1"
98+
"agent": "stable",
99+
"viam-server": "0.52.1"
102100
},
103101
"advanced_settings": {
104102
"debug": false,
@@ -150,8 +148,8 @@ Edit and fill in the attributes as applicable.
150148
{
151149
"agent": {
152150
"version_control": {
153-
"agent": "stable",
154-
"viam-server": "0.52.1"
151+
"agent": "stable",
152+
"viam-server": "0.52.1"
155153
},
156154
"advanced_settings": {
157155
"debug": false,
@@ -278,7 +276,7 @@ You can also start `viam-agent` in fast start mode by setting `VIAM_AGENT_FAST_S
278276
| `manufacturer` | string | false | Purely informative. May be displayed on captive portal or provisioning app. Default: `"viam"`. |
279277
| `model` | string | false | Purely informative. May be displayed on captive portal or provisioning app. Default: `"custom"`. |
280278
| `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). |
281-
| `retry_connection_timeout_minutes` |
279+
| `retry_connection_timeout_minutes` | TODO | TODO | TODO |
282280
| `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`. |
283281
| `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). |
284282
| `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`. |
@@ -318,9 +316,9 @@ If the highest-priority network is not available or the machine can connect but
318316
<!-- prettier-ignore -->
319317
| Name | Type | Required? | Description |
320318
| ---------- | ---- | --------- | ----------- |
321-
| `logging_journald_runtime_max_use_megabytes` | Set the temporary space limit for logs. `-1` to disable. Default: `512` (512 MB). |
322-
| `logging_journald_system_max_use_megabytes` | Sets the maximum disk space `journald` will user for persistent log storage. `-1` to disable. Default: `512` (512 MB). |
323-
| `os_auto_upgrade_type` | 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: `""`. |
319+
| `logging_journald_runtime_max_use_megabytes` | integer | optional |Set the temporary space limit for logs. `-1` to disable. Default: `512` (512 MB). |
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: `""`. |
324322

325323
For more detailed instructions, see [Configure machine settings](https://docs.viam.com/manage/fleet/system-settings/).
326324

0 commit comments

Comments
 (0)