Skip to content

Commit

Permalink
[misc] report community documentation change
Browse files Browse the repository at this point in the history
  • Loading branch information
rusher committed Jul 24, 2018
1 parent 73f0ca7 commit 090ce29
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -86,7 +86,7 @@ The MariaDB Connector is available through the Node.js repositories. You can in
$ npm install mariadb
```

Using the ECMAScript, prior to 2017:
Using ECMAScript < 2017:

```js
const mariadb = require('mariadb');
Expand Down Expand Up @@ -138,9 +138,9 @@ async function asyncFunction() {

## Documentation

The MariaDB Connector can use different API's on the back-end: Promise and Callback. The default API is Promise. Callback is provided for compatibility with the `mysql` and `mysql2` API's.
The MariaDB Node.js Connector can use different APIs on the back-end: Promise and Callback. The default API is Promise. Callback is provided for compatibility with the `mysql` and `mysql2` APIs.

Documentation provided on this page uses the Promise API. If you would like to develop an application with the Callback API or have an existing application that you want to switch from the MySQL API's to the MariaDB Connector, see the [Callback API](/documentation/callback-api.md) documentation.
Documentation provided on this page uses the Promise API. If you would like to develop an application with the Callback API or have an existing application that you want to switch from the MySQL APIs to the MariaDB Connector, see the [Callback API](/documentation/callback-api.md) documentation.

### Installation

Expand Down
12 changes: 6 additions & 6 deletions documentation/connection-options.md
@@ -1,4 +1,4 @@
# Connection options
# Connection Options

- [Essential options](#essential-option)
- [Support for big integer](#support-for-big-integer)
Expand All @@ -10,7 +10,7 @@
- [Other options](#other-options)
- [F.A.Q.](#faq)

## Essential options
## Essential Options

| option| description| type| default|
| ---: | --- | :---: | :---: |
Expand Down Expand Up @@ -128,12 +128,12 @@ A certificate chain is a list of certificates that were issued from the same Cer
In cases where intermediate or root certificates are not trusted by the Connector, the Connector rejects the connection and issues an error.


#### Hostname verification (SNI)
#### Hostname Verification (SNI)

Certificates can provide hostname verification to the driver. By default this is done against the certificate's `subjectAlternativeName` DNS name field.


### One-way SSL authentication
### One-way SSL Authentication

When the server certificate is signed using the certificate chain that uses a root CA known in the JavaScript trust store, setting the `ssl` option enables one-way SSL authentication.

Expand Down Expand Up @@ -190,7 +190,7 @@ mariadb
```


#### Using specific TLS Protocols or Ciphers
#### Using Specific TLS Protocols or Ciphers

In situations where you don't like the default TLS protocol or cipher or where you would like to use a specific version, you force he Connector to use the one you want using the `secureProtocol` and `cipher` options.

Expand All @@ -214,7 +214,7 @@ mariadb
For more information on what's available, see [possible protocol](https://www.openssl.org/docs/man1.0.2/ssl/ssl.html#DEALING-WITH-PROTOCOL-METHODS) values.


### Two-way SSL authentication
### Two-way SSL Authentication

Mutual SSL authentication or certificate-based mutual authentication refers to two parties authenticating each other by verifying the provided digital certificates. This allows both parties to be assured of the other's identity. In order to use mutual authentication, you must set the `REQUIRE X509` option in the `GRANT` statement. For instance,

Expand Down

0 comments on commit 090ce29

Please sign in to comment.