DOCS-3983: Update agent docs for windows #4352
Conversation
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
| {{% tab name="Windows" %}} | ||
|
|
||
| On Windows, the [`viam-agent` executable](https://storage.googleapis.com/packages.viam.com/apps/viam-agent/viam-agent-windows-installer.exe) installs `viam-agent` as a service. | ||
| Your machine credentials file must be at <file>/etc/viam.json</file>. |
There was a problem hiding this comment.
would write this as c:\etc\viam.json, will make more sense to windows users
(but the operating system will accept /etc/viam.json)
| {{% /tab %}} | ||
| {{% tab name="Windows" %}} | ||
|
|
||
| On Windows, the [`viam-agent` executable](https://storage.googleapis.com/packages.viam.com/apps/viam-agent/viam-agent-windows-installer.exe) installs `viam-agent` as a service. |
There was a problem hiding this comment.
would call this 'viam-agent installer' rather than 'viam-agent executable'; the latter implies agent itself
|
|
||
| Open the Windows Event Viewer (`eventvwr` from the command line). | ||
|
|
||
| You will find the `viam-agent` logs under `Windows Logs` > `Application`. |
There was a problem hiding this comment.
optionally add that people need to switch to the 'details' tab in the bottom-center pane, but most users figure this out on their own
| To uninstall `viam-agent`, run the following command: | ||
|
|
||
| ```sh {class="command-line" data-prompt="$"} | ||
| sc delete viam-agent |
There was a problem hiding this comment.
notes on this:
- has to happen in an administrator prompt (start -> cmd -> right click -> run as administrator), otherwise you should get access denied. this may not be necessary on a system with developer mode
- if agent is running, the service won't be deleted until the user stops it manually; could tell people to run
sc stop viam-agentfirst - this won't delete any files, it will just stop agent from running
There was a problem hiding this comment.
Are there files aside from the installer and the viam.json file? I suppose everything that got installed... Is there anything we can do aside from tell people to remove whichever folder they are in?
There was a problem hiding this comment.
(oops missed last week)
the user can delete the whole /opt/viam folder and the viam dotdir folder (C:\Windows\system32\config\systemprofile\.viam)
we don't use a normal MSI because symlinking is thorny with MSI, but if we did, it would have an entry in the 'add/remove programs' control panel page, and would clean up any folders it installed. (but we don't have this)
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
@abe-winter do you mind reviewing this? If you have any other thoughts on where windows installations differ let me know so we can document: