Skip to content

Commit d17e998

Browse files
authored
DOCS-3870: Document Windows viam-server root (#4237)
1 parent cedfe4d commit d17e998

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Diff for: docs/operate/reference/module-configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -234,11 +234,11 @@ Not all of these variables are automatically available on [local modules](/opera
234234
<!-- prettier-ignore -->
235235
| Name | Description | Automatically set on local modules? |
236236
| ---- | ----------- | ----------------------------------- |
237-
| `VIAM_HOME` | The root of the `viam-server` configuration.<br>Default: `$HOME/.viam` | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
238-
| `VIAM_MODULE_ROOT` | The root of the module install directory. The module process uses this directory as its current working directory (`cwd`). This variable is useful for file navigation that is relative to the root of the module.<br>Example: `/opt/my-module/verxxxx-my-module/` | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
237+
| `VIAM_HOME` | The root of the `viam-server` configuration.<br>Default for Linux, macOS, and WSL: <file>$HOME/.viam</file><br>Default for Windows: <file>C:\WINDOWS\system32\config\systemprofile\.viam</file> | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
238+
| `VIAM_MODULE_ROOT` | The root of the module install directory. The module process uses this directory as its current working directory (`cwd`). This variable is useful for file navigation that is relative to the root of the module.<br>Example: <file>/opt/my-module/verxxxx-my-module/</file> | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
239239
| `VIAM_RESOURCE_CONFIGURATION_TIMEOUT` | Duration that resources are allowed to configure or reconfigure.<br>Example: `4m0s`<br>Default: 1 minute. | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
240240
| `VIAM_MODULE_STARTUP_TIMEOUT` | Duration that modules are allowed to start up.<br>Example: `7m15s`<br>Default: 5 minutes. | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
241-
| `VIAM_MODULE_DATA` | A persistent folder location a module can use to store data across reboots and versions. This location is a good place to store [python virtual environments](/dev/reference/sdks/python/python-venv/).<br>Example: `$VIAM_HOME/module-data/cloud-machine-id/my-module-name/` | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
241+
| `VIAM_MODULE_DATA` | A persistent folder location a module can use to store data across reboots and versions. This location is a good place to store [python virtual environments](/dev/reference/sdks/python/python-venv/).<br>Example: <file>$VIAM_HOME/module-data/cloud-machine-id/my-module-name/</file> | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
242242
| `VIAM_MODULE_ID` | The module ID of the module.<br>Example: `viam:realsense` | |
243243
| `VIAM_API_KEY` | An API key with access to the machine where this instance of the module is running. | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |
244244
| `VIAM_API_KEY_ID` | The ID of the API key with access to the machine where this instance of the module is running. | <p class="center-text"><i class="fas fa-check" title="yes"></i></p> |

0 commit comments

Comments
 (0)