Skip to content

Commit

Permalink
docs: Clarify need to reload or restart Client Agent on Mac (#5183)
Browse files Browse the repository at this point in the history
* docs: Clarify need to reload or restart Client Agent on Mac

* docs: Wake up Vercel

* docs: Use full name of client
  • Loading branch information
Dan-Heath authored Oct 17, 2024
1 parent 2d72d24 commit 72e6ea8
Showing 1 changed file with 25 additions and 21 deletions.
46 changes: 25 additions & 21 deletions website/content/docs/api-clients/client-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -170,32 +170,35 @@ By default, it is located in the following directory:

`/Library/Application Support/HashiCorp/Boundary/boundary-client-agent.hcl`

1. Change the configuration settings.
1. Save the file and restart the Client Agent with the following commands:
1. Change the configuration settings, and save the file.

You must restart the Client Agent to update some configuration settings.
However, when you restart the Client Agent, it closes any existing sessions.
Other configuration settings can be updated by only reloading the configuration file, which does not affect any existing sessions.

1. Either restart the Client Agent or reload the configuration file.

You can update any configuration value by restarting the Client Agent with the following commands, however it will close any existing sessions:

```shell-session
$ sudo launchctl stop com.hashicorp.boundary.boundary-client-agent
$ sudo launchctl start com.hashicorp.boundary.boundary-client-agent
```

You can change some configuration values without restarting the Client Agent.
These values include:
Alternatively, you can update the following configuration values by reloading the configuration file, which will not disrupt any existing sessions:

- `dns_request_timeout`
- `log_file`
- `log_level`
- `state_file`
- `override_upstream_dns_servers`
- `v4_prefix`
- `dns_request_timeout`
- `log_file`
- `log_level`
- `state_file`
- `override_upstream_dns_servers`
- `v4_prefix`

To update the other values, you must reload the configuration.
To reload the configuration, update the configuration file, and then use the following command:

```shell-session
$ sudo pkill -1 boundary-client-agent
```
Run the following command to reload the configuration file:

This command sends a SIGHUP signal to the Client Agent, which causes it to reload the configuration file.
```shell-session
$ sudo pkill -1 boundary-client-agent
```

</Tab>
<Tab heading="Windows" group="windows">
Expand All @@ -204,19 +207,20 @@ This command sends a SIGHUP signal to the Client Agent, which causes it to reloa
By default, it is located in the following directory:

`C:\Program Files\Hashicorp Boundary\boundary-client-agent.hcl`
1. Change the configuration settings.
1. Save the file and restart the Client Agent with the following commands:

1. Change the configuration settings, and save the file.
1. Run the following commands to restart the Client Agent.

```shell-session
net stop BoundaryClientAgent
net start BoundaryClientAgent
```

Note that when you restart the Client Agent, it closes any existing sessions.

</Tab>
</Tabs>

Note that when you restart the Client Agent, it closes any existing sessions.

## Manage the Client Agent

Refer to the following sections for more information about managing the Client Agent.
Expand Down

0 comments on commit 72e6ea8

Please sign in to comment.