Commit Graph
13 Commits
Author SHA1 Message Date
f2c84ad750 docs: add macOS Internet Sharing and Parallels Desktop conflicts for Boundary Client Agent (#5496)
* docs: add macOS Internet Sharing and Parallels Desktop conflicts for Boundary Client Agent

Updated the "Conflicting Software" section in the Boundary Client Agent documentation
to include issues caused by macOS Internet Sharing and Parallels Desktop (macOS VM with shared networking).
These configurations cause the system's DNS resolver to bind to port 53, preventing the Client Agent from starting.

* chore: change case of macOS to MacOS and added workaround for Parallels macOS VM conflict

* Apply suggestions from code review

approving style suggestions from code review

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2025-03-18 17:19:41 -04:00
d001e82817 docs: Fixes examples for alias_refresh_interval & dns_request_timeout (#5544)
* docs: Fixes examples for alias_refresh_interval & dns_request_timeout

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Michael Li <michael.li@hashicorp.com>

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: Michael Li <michael.li@hashicorp.com>
2025-02-13 09:14:18 -08:00
Johan Brandhorst-SatzkornandRobin Beck c593943209 docs/client-agent: add warning about MacOS 15 (#5543)
* docs/client-agent: add warning about MacOS 15

MacOS 15.3 has been known to sometimes block users
from using the client agent altogether. Explicitly
allowing it access to incoming network connections
resolves the issue.

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2025-02-11 15:50:40 -08:00
Johan Brandhorst-Satzkorn 35943cb408 docs: add note about MacOS 15.1, 15.2 incompatibility (#5515) 2025-02-05 09:14:38 -08:00
Aditya SharmaandDan Heath 0d206aab74 docs: Adds conflicts with Huntress EDR (#5454)
* docs: Adds conflicts with Huntress EDR

* Apply suggestions from code review

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2025-01-24 14:15:30 -05:00
Mohit KumarandDan Heath 1cf231a147 docs: clarify behavior of launchctl stop and unload for client agent (#5265)
* docs: clarify behavior of launchctl stop and unload for client agent

* docs: update unload command and clarify permanent disabling of Boundary client agent

* docs: remove "Note" wrapper and clarify unload/reload command for Boundary client agent

* docs: Capitalize Client Agent

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-12-04 15:24:20 -05:00
Dan HeathandRobin Beck c0a8775951 docs: Update meta content - API and clients (#5281)
* docs: Update meta content - API and clients

* docs: Update titles

* Apply batch suggestions from code review

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-12-04 13:34:57 -05:00
69fc3a47d0 docs: add ssh host key error to known issues (#5250)
* docs: ssh error due to change in host key

* style: remove trailing whitespace

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* docs: rephrase  message

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

---------

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-11-20 09:12:30 -05:00
Johan Brandhorst-SatzkornandDan Heath 680bb02af9 docs/client-agent: clarify use of override_upstream_dns_servers (#5220)
* docs/client-agent: clarify use of override_upstream_dns_servers

The override_upstream_dns_servers option is recommended whenever
a user needs to override the DNS servers discovered from the system.
However, if a user supplies a DNS server that is only useable while
connected to a specific network, it will break the internet in
cases where it is not able to resolve these DNS servers.
Encourage users to supply both the VPN servers and the default
DNS servers.

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-10-30 13:59:50 -07:00
Johan Brandhorst-SatzkornandDan Heath 5a071442b5 Clarify client agent config reload docs (#5213)
* docs/client-agent: clarify configuration reload on MacOS

The previous configuration was known to confuse at least one reader.
It's easy to just copy the first command you see and run it, so
make that the non-destructive reload command.

* docs/client-agent: correct log level config example

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-10-29 09:58:38 -07:00
Dan Heath 72e6ea8da0 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
2024-10-17 18:36:05 -04:00
Johan Brandhorst-Satzkorn 2d72d2488e Client agent docs updates (#5180)
* docs/client-agent: indent PAN docs correctly

Identifying the primary network interface is a sub-heading under the
PAN troubleshooting section.

* docs/transparent-sessions: add known issue around containers/VMs

VMs/containers that do not have access to the local network cannot
use aliases through transparent sessions.
2024-10-17 15:30:29 -04:00
0bd699c999 Dheath 0.18.0 assembly (#5175)
* docs: TS public beta docs

* docs: Updates

* docs: Move Client Agent sections

* docs: Updates

* docs: Fix typo

* docs: Remove x86

* docs: Add lead in sentence for links

* docs: FAQ updates

* docs: Edits and file name fixes

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>

* docs: Add alias refresh interval

* docs: Remove recurse only option

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* docs: Updates from code review

* docs: Update support request

* docs: Fix a typo

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* docs: Delete log example, create tabs

* client-agent: rework configuration docs

The section in the configuration talking about reloading the config
was repetitive and verbose. Combine the different sections into
two separate sections, one for updating general values and
one for reloading values, on MacOS only.

This also removes the specific Log section.

* docs: Minor rewrites

* client-agent: consistently use $ for shell sessions

* aliases: discourage single-word aliases

The use of single-word aliases breaks Transparent Sessions
on Windows, so we should discourage it. See ICU-15255 for more information.

* transparent-sessions: add known issues

Add two new known issues.

* client-agent: add troubleshooting section

* transparent-sessions: emphasize troubleshooting guide

* correct links

I haven't actually validated these links, but they
are now consistent with the rest of the links.

* Review comments

* client-agent: clarify that not all sessions are listed by command

* transparent-session: add known issue regarding Windows installer

* docs: Minor rewrites

* docs: Fix a typo

* docs: Add AssumeRole support

* docs: Add Backblaze support

* docs: Minor revision

* docs: Update MinIO reqs

* docs: Add supported Hitachi version

* docs: Trigger a new build

* docs: Clarify Desktop compatibility with control plane

* Update website/content/docs/enterprise/supported-versions.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: Release notes 0.18.0

* docs: Add link to Client Agent docs

* docs: Update ts definition

* docs: Remove stray line

* docs: Fix minor issues with the assembly branch

* docs: Move section

* docs: Add section

* docs: Remove duplicate section

---------

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-10-15 08:21:31 -04:00