Skip to content

📝 Add pseudo hosts for xdebug.client_host #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

📝 Add pseudo hosts for xdebug.client_host #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions html/docs/include/settings/client_host.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
<p>Configures the IP address or hostname where Xdebug will attempt to connect to when initiating a
debugging connection. This address should be the address of the machine where your IDE or debugging
client is listening for incoming debugging connections.</p>
<p>On non-Windows platforms, it is also possible to configure a <a
href="https://en.wikipedia.org/wiki/Unix_domain_socket">Unix domain socket</a> which is supported by
only a select view debugging clients. In that case, instead of the hostname or IP address, use
<code>unix:///path/to/sock</code>.</p>
<p>Pseudo hosts are available to use in-place of an IP:</p>
<ul>
<li><code>xdebug://gateway</code>: use the system defined network gateway.</li>
<li><code>xdebug://nameserver</code>: use the system defined private network nameserver.</li>
Comment on lines +6 to +7
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not know if the wording is OK. And if I should add wikipedia links like the socket one.

Suggested links would be:

<li><code>unix:///path/to/sock</code>: On non-Windows platforms, supported by only a select view debugging clients,
use a <a href="https://en.wikipedia.org/wiki/Unix_domain_socket">Unix domain socket</a>.</li>
Comment on lines +8 to +9
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it make more sense to have this here , I also rephrased this a bit so it is shorter.

</ul>
<p>If [CFG:discover_client_host] is enabled then Xdebug will only use the value of this setting in
case Xdebug can not connect to an IDE using the information it obtained from HTTP headers. In that
case, the value of this setting acts as a fallback only.</p>
Expand Down