Rename deprecated Pusher Channels `encrypted` to `forceTLS` (#5248)

It was renamed in 922ed101b9.

I also made the description of `forceTLS` semantics a bit clearer.
This commit is contained in:
Will Sewell 2019-06-19 15:41:16 +01:00 committed by Taylor Otwell
parent 5e1db4c48b
commit de565a29f0
1 changed files with 3 additions and 3 deletions

View File

@ -65,7 +65,7 @@ Next, you should configure your Channels credentials in the `config/broadcasting
'options' => [
'cluster' => 'eu',
'encrypted' => true
'useTLS' => true
],
When using Channels and [Laravel Echo](#installing-laravel-echo), you should specify `pusher` as your desired broadcaster when instantiating the Echo instance in your `resources/assets/js/bootstrap.js` file:
@ -460,13 +460,13 @@ Once Echo is installed, you are ready to create a fresh Echo instance in your ap
key: 'your-pusher-channels-key'
});
When creating an Echo instance that uses the `pusher` connector, you may also specify a `cluster` as well as whether the connection should be encrypted:
When creating an Echo instance that uses the `pusher` connector, you may also specify a `cluster` as well as whether the connection must be made over TLS (by default, when `forceTLS` is `false`, a non-TLS connection will be made if the page was loaded over HTTP, or as a fallback if a TLS connection fails):
window.Echo = new Echo({
broadcaster: 'pusher',
key: 'your-pusher-channels-key',
cluster: 'eu',
encrypted: true
forceTLS: true
});
<a name="listening-for-events"></a>