Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 36 additions & 13 deletions docs/manage/reference/viam-agent/manage-viam-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,44 @@ aliases:
{{< tabs >}}
{{% tab name="Linux" %}}

- To start `viam-agent`:
- To restart `viam-agent`:

{{< alert title="Alert" color="note" >}}
When you restart `viam-agent`, the agent will restart `viam-server` as well.
{{< /alert >}}

{{< tabs >}}
{{% tab name="Web UI" %}}

1. Navigate to your machine in [Viam](https://app.viam.com).
1. Click on the machine status indicator next to the machine name.
1. Click on the restart arrow symbol.
This will restart `viam-server` and `viam-agent`.

{{% /tab %}}
{{% tab name="Shell" %}}

```sh {class="command-line" data-prompt="$"}
sudo systemctl start viam-agent
sudo systemctl restart viam-agent
```

- To stop `viam-agent`:
{{% /tab %}}
{{< /tabs >}}

- To start `viam-agent`:

```sh {class="command-line" data-prompt="$"}
sudo systemctl stop viam-agent
sudo systemctl start viam-agent
```

{{< alert title="Alert" color="note" >}}
When you stop `viam-agent`, the agent will stop `viam-server` as well.
{{< /alert >}}

- To restart `viam-agent`:
- To stop `viam-agent`:

{{< alert title="Alert" color="note" >}}
When you restart `viam-agent`, the agent will restart `viam-server` as well.
When you stop `viam-agent`, the agent will stop `viam-server` as well.
{{< /alert >}}

```sh {class="command-line" data-prompt="$"}
sudo systemctl restart viam-agent
sudo systemctl stop viam-agent
```

- To completely uninstall `viam-agent` and `viam-server`, run the following command:
Expand All @@ -61,7 +75,8 @@ You can only restore this file if you have access to the machine configuration.
{{% /tab %}}
{{% tab name="Windows native" %}}

On Windows, you can manage `viam-agent` using the Services GUI or the command line:
On Windows, you can manage `viam-agent` using the Services GUI or the command line.
You can also use the Viam web UI to restart `viam-agent`.

{{< tabs >}}
{{% tab name="Services GUI" %}}
Expand All @@ -72,7 +87,7 @@ On Windows, you can manage `viam-agent` using the Services GUI or the command li

{{<imgproc src="/manage/viam-agent-windows-services-manager.png" resize="x1100" declaredimensions=true alt="Windows Services manager with viam-agent highlighted." style="max-width:600px" class="shadow imgzoom" >}}

1. Use the **Start Service**, **Stop Service**, and **Restart Service** buttons to manage `viam-agent`.
1. Use the **Restart Service**, **Stop Service**, and **Start Service** buttons to manage `viam-agent`.

1. To change the startup type of `viam-agent`, right-click on `viam-agent` and select **Properties**.
Select your desired startup type from the **Startup type** dropdown menu.
Expand Down Expand Up @@ -111,6 +126,14 @@ On Windows, you can manage `viam-agent` using the Services GUI or the command li
Set-Service -Name "viam-agent" -StartupType Automatic
```

{{% /tab %}}
{{% tab name="Web UI" %}}

1. Navigate to your machine in [Viam](https://app.viam.com).
1. Click on the machine status indicator next to the machine name.
1. Click on the restart arrow symbol.
This will restart `viam-server` and `viam-agent`.

{{% /tab %}}
{{< /tabs >}}

Expand Down
2 changes: 2 additions & 0 deletions docs/manage/troubleshoot/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,8 @@ To remotely access your machine from your terminal:
1. Select the part status dropdown to the right of your machine's name on the top of the page.
{{<imgproc src="configure/machine-part-info.png" resize="500x" declaredimensions=true alt="machine cloud credentials button on the machine part info dropdown" class="shadow" >}}
1. If you installed `viam-server` with `viam-agent` you will see a **Restart** button. Click it.
Both `viam-server` and `viam-agent` will restart.

If you do not see the **Restart** button, click the **...** menu on the right side of the machine part's card, and select **Restart part**.
If restarting the machine part does not resolve the issue, ssh into the machine and [stop and restart viam-server manually](/operate/reference/viam-server/manage-viam-server/#run-viam-server).

Expand Down
7 changes: 7 additions & 0 deletions docs/operate/hello-world/tutorial-desk-safari.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,13 @@ Save the config.
{{% /tab %}}
{{< /tabs >}}

{{% /tablestep %}}
{{% tablestep %}}
**Restart module every time you iterate.**

If you make changes to your module code, you must restart your module for the changes to take effect.
Click on the **...** menu near the module and select **Restart**.

{{% /tablestep %}}
{{% tablestep %}}
**Test your game logic.**
Expand Down
1 change: 1 addition & 0 deletions docs/operate/modules/control-logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,7 @@ If you are encountering errors, check the **LOGS** tab for more information.
**Iterate.**

If you make changes to your module code, you must restart your module for the changes to take effect.
Click on the **...** menu near the module and select **Restart**.

{{% /tablestep %}}
{{< /table >}}
Expand Down
16 changes: 11 additions & 5 deletions docs/operate/reference/components/camera/webcam.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,13 +248,19 @@ This file contains basic diagnostic and configuration information about your cam
{{% /expand%}}

{{% expand "No visible live video feed" %}}
If you're working on a Linux machine, `ssh` into it, then restart `viam-server` by running:

```sh {class="command-line" data-prompt="$"}
sudo systemctl restart viam-server
```
Restart `viam-server`:

1. Navigate to your machine's page.
1. Select the part status dropdown to the right of your machine's name on the top of the page.
{{<imgproc src="configure/machine-part-info.png" resize="500x" declaredimensions=true alt="machine cloud credentials button on the machine part info dropdown" class="shadow" >}}
1. If you installed `viam-server` with `viam-agent` you will see a **Restart** button. Click it.
Both `viam-server` and `viam-agent` will restart.

If you do not see the **Restart** button, click the **...** menu on the right side of the machine part's card, and select **Restart part**.
If restarting the machine part does not resolve the issue, ssh into the machine and [stop and restart viam-server manually](/operate/reference/viam-server/manage-viam-server/#run-viam-server).

If this doesn't work, you can reboot your machine by running:
If this doesn't work, you can reboot your machine by running the following command on the machine:

```sh {class="command-line" data-prompt="$"}
sudo reboot
Expand Down
3 changes: 0 additions & 3 deletions docs/operate/reference/viam-server/manage-viam-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,6 @@ For example, the following `version_control` configuration will always update to
}
```

To use the new versions of `viam-server` and `viam-agent`, [restart `viam-agent`](/manage/reference/viam-agent/manage-viam-agent/).
When you stop or restart `viam-agent`, the agent also restarts `viam-server`.

{{% /tab %}}
{{% tab name="Manual" %}}

Expand Down
Loading