From cb44adda06c3eade9d4cef8d8d5cd179de8391c0 Mon Sep 17 00:00:00 2001 From: andf-viam <132301587+andf-viam@users.noreply.github.com> Date: Mon, 11 Dec 2023 12:46:38 -0500 Subject: [PATCH] DOCS-1424: Update module cwd (#2311) --- docs/registry/configure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/registry/configure.md b/docs/registry/configure.md index 7b4fdc822a..e82de8df47 100644 --- a/docs/registry/configure.md +++ b/docs/registry/configure.md @@ -320,7 +320,7 @@ When a module is instantiated, it has access to the following default environmen | Name | Description | | ---- | ----------- | | `VIAM_HOME` | The root of the `viam-server` configuration.
Default: `$HOME/.viam` | -| `VIAM_MODULE_ROOT` | The root of the module install directory. Useful for file navigation that is relative to the root of the module. If you are using a [local module](#local-modules), you must set this value manually if your module requires it.
Example: `$VIAM_HOME/packages/.data/modules/verxxxx-my-module/` | +| `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. If you are using a [local module](#local-modules), you must set this value manually if your module requires it.
Example: `/opt/my-module/verxxxx-my-module/` | | `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](/build/program/python-venv/).
Example: `$VIAM_HOME/module-data/cloud-robot-id/my-module-name/` | | `VIAM_MODULE_ID` | The module ID of the module.
Example: `viam:realsense` |