Skip to content

Commit 65c0168

Browse files
committed
add reference to parse_url() for Extended Host Configuration
* fixes #776
1 parent 7241e69 commit 65c0168

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/configuration.asciidoc

+3-2
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,17 @@ Basic Auth's password contains special characters such as a pound sign (`#`) or
6060
For this reason, the client supports an extended host syntax which provides greater control over host initialization.
6161
None of the components are validated, so edge-cases like underscores domain names will not cause problems.
6262

63-
The extended syntax is an array of parameters for each host:
63+
The extended syntax is an array of parameters for each host. The structure of the parameter list is identical to the return values of a http://php.net/manual/en/function.parse-url.php#refsect1-function.parse-url-returnvalues[`parse_url()`] call:
6464

6565
[source,php]
6666
----
6767
$hosts = [
68-
// This is effectively equal to: "https://username:password!#$?*[email protected]:9200/"
68+
// This is effectively equal to: "https://username:password!#$?*[email protected]:9200/elastic"
6969
[
7070
'host' => 'foo.com',
7171
'port' => '9200',
7272
'scheme' => 'https',
73+
'path' => '/elastic',
7374
'user' => 'username',
7475
'pass' => 'password!#$?*abc'
7576
],

0 commit comments

Comments
 (0)