docs: Clarify need to reload or restart Client Agent on Mac (#5183)
* docs: Clarify need to reload or restart Client Agent on Mac * docs: Wake up Vercel * docs: Use full name of client
This commit is contained in:
1 parent
2d72d2488e
commit
72e6ea8da0
1 file changed
+25
-21
@@ -170,32 +170,35 @@ By default, it is located in the following directory:
|
|||||||
|
|
||||||
`/Library/Application Support/HashiCorp/Boundary/boundary-client-agent.hcl`
|
`/Library/Application Support/HashiCorp/Boundary/boundary-client-agent.hcl`
|
||||||
|
|
||||||
1. Change the configuration settings.
|
1. Change the configuration settings, and save the file.
|
||||||
1. Save the file and restart the Client Agent with the following commands:
|
|
||||||
|
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
|
```shell-session
|
||||||
$ sudo launchctl stop com.hashicorp.boundary.boundary-client-agent
|
$ sudo launchctl stop com.hashicorp.boundary.boundary-client-agent
|
||||||
$ sudo launchctl start 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.
|
Alternatively, you can update the following configuration values by reloading the configuration file, which will not disrupt any existing sessions:
|
||||||
These values include:
|
|
||||||
|
|
||||||
- `dns_request_timeout`
|
- `dns_request_timeout`
|
||||||
- `log_file`
|
- `log_file`
|
||||||
- `log_level`
|
- `log_level`
|
||||||
- `state_file`
|
- `state_file`
|
||||||
- `override_upstream_dns_servers`
|
- `override_upstream_dns_servers`
|
||||||
- `v4_prefix`
|
- `v4_prefix`
|
||||||
|
|
||||||
To update the other values, you must reload the configuration.
|
Run the following command to reload the configuration file:
|
||||||
To reload the configuration, update the configuration file, and then use the following command:
|
|
||||||
|
|
||||||
```shell-session
|
```shell-session
|
||||||
$ sudo pkill -1 boundary-client-agent
|
$ sudo pkill -1 boundary-client-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
This command sends a SIGHUP signal to the Client Agent, which causes it to reload the configuration file.
|
|
||||||
|
|
||||||
</Tab>
|
</Tab>
|
||||||
<Tab heading="Windows" group="windows">
|
<Tab heading="Windows" group="windows">
|
||||||
@@ -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:
|
By default, it is located in the following directory:
|
||||||
|
|
||||||
`C:\Program Files\Hashicorp Boundary\boundary-client-agent.hcl`
|
`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
|
```shell-session
|
||||||
net stop BoundaryClientAgent
|
net stop BoundaryClientAgent
|
||||||
net start BoundaryClientAgent
|
net start BoundaryClientAgent
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note that when you restart the Client Agent, it closes any existing sessions.
|
||||||
|
|
||||||
</Tab>
|
</Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
Note that when you restart the Client Agent, it closes any existing sessions.
|
|
||||||
|
|
||||||
## Manage the Client Agent
|
## Manage the Client Agent
|
||||||
|
|
||||||
Refer to the following sections for more information about managing the Client Agent.
|
Refer to the following sections for more information about managing the Client Agent.
|
||||||
|
|||||||
Reference in new issue
Block a user