habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

moved ssl options to the config page

Browse Source
This commit is contained in:
Spencer Alger
2015-01-06 11:08:02 -07:00
parent a074672980
commit 2052921d54
3 changed files with 31 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/host.asciidoc
View File

@ -45,47 +45,7 @@ Options :::
`Any` -- When the host receives a configuration object, it assigns all of the object's keys to itself. This allows you to pass in arbitrary keys and values that can be used within selectors, or other custom functionality.
`ssl`::
`Object` -- configuration options pertaining to HTTPS/SSL. For more information visit the <<auth-reference>> Section.
`ssl.pfx`::
`String,Array[String]` -- Certificate, Private key and CA certificates to use for SSL.
Default ::: `null`
`ssl.key`::
`String` -- Private key to use for SSL.
Default ::: `null`
`ssl.passphrase`::
`String` -- A string of passphrase for the private key or pfx.
Default ::: `null`
`ssl.cert`::
`String` -- Public x509 certificate to use.
Default ::: `null`
`ssl.ca`::
`String,Array[String]` -- An authority certificate or array of authority certificates to check the remote host against.
Default ::: `null`
`ssl.ciphers`::
`String` -- A string describing the ciphers to use or exclude. Consult http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT for details on the format.
Default ::: `null`
`ssl.rejectUnauthorized`::
`Boolean` -- If true, the server certificate is verified against the list of supplied CAs. An 'error' event is emitted if verification fails. Verification happens at the connection level, before the HTTP request is sent.
Default ::: `false`
`ssl.secureProtocol`::
`String` -- The SSL method to use, e.g. TLSv1_method to force TLS version 1. The possible values depend on your installation of OpenSSL and are defined in the constant SSL_METHODS.
Default ::: `null`
`Object` -- Host specific version of the <<config-ssl,ssl config>>.
=== Examples