DOCS-3438: Update module environment variables #3993
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
viambot
added
the
safe to build
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
cheukt
approved these changes
Feb 12, 2025
| | `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> | | ||
| | `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> | | ||
| | `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/` | | | ||
| | `VIAM_MODULE_ID` | The module ID of the module.<br>Example: `viam:realsense` | | |
There was a problem hiding this comment.
this is not available on local modules
Comment on lines
+247
to
+252
| | `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> | | ||
| | `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> | | ||
| | `VIAM_MACHINE_PART_ID` | The ID of the part where this instance of the module is running. | | | ||
| | `VIAM_MACHINE_ID` | The ID of the machine where this instance of the module is running. | | | ||
| | `VIAM_LOCATION_ID` | The ID of the {{< glossary_tooltip term_id="location" text="location" >}} that owns the machine where this instance of the module is running. | | | ||
| | `VIAM_PRIMARY_ORG_ID` | The ID of the {{< glossary_tooltip term_id="organization" text="organization" >}} that owns the machine where this instance of the module is running. | | |
There was a problem hiding this comment.
these will only be available on app.viam connected robots
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Staging: https://deploy-preview-3993--viam-docs.netlify.app/operate/reference/module-configuration/#environment-variables
@cheukt I could use confirmation of which vars are available on local modules vs not