Skip to content

Commit f436cac

Browse files
[12.x] docs: update cache, queues and mail failover docs (#10940)
* docs: update cache and queues failover setup * docs: improve mail failover docs * Update queues.md --------- Co-authored-by: Taylor Otwell <taylor@laravel.com>
1 parent 4a03926 commit f436cac

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ Cache::lock('processing')->forceRelease();
533533
<a name="cache-failover"></a>
534534
## Cache Failover
535535

536-
The `failover` cache driver provides automatic failover functionality when interacting with the cache. If the primary cache store fails for any reason, Laravel will automatically attempt to use the next configured store in the list. This is particularly useful for ensuring high availability in production environments where cache reliability is critical.
536+
The `failover` cache driver provides automatic failover functionality when interacting with the cache. If the primary cache store of the `failover` store fails for any reason, Laravel will automatically attempt to use the next configured store in the list. This is particularly useful for ensuring high availability in production environments where cache reliability is critical.
537537

538538
To configure a failover cache store, specify the `failover` driver and provide an array of store names to attempt in order. By default, Laravel includes an example failover configuration in your application's `config/cache.php` configuration file:
539539

@@ -547,7 +547,7 @@ To configure a failover cache store, specify the `failover` driver and provide a
547547
],
548548
```
549549

550-
Once you have configured a store that uses the `failover` driver, you will probably want to set the failover store as your default cache store in your application's `.env` file:
550+
Once you have configured a store that uses the `failover` driver, you will need to set the failover store as your default cache store in your application's `.env` file to make use of the failover functionality:
551551

552552
```ini
553553
CACHE_STORE=failover

mail.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,10 +231,10 @@ To accomplish this, you should define a mailer within your application's `mail`
231231
],
232232
```
233233

234-
Once your failover mailer has been defined, you should set this mailer as the default mailer used by your application by specifying its name as the value of the `default` configuration key within your application's `mail` configuration file:
234+
Once you have configured a mailer that uses the `failover` transport, you will need to set the failover mailer as your default mailer in your application's `.env` file to make use of the failover functionality:
235235

236-
```php
237-
'default' => env('MAIL_MAILER', 'failover'),
236+
```ini
237+
MAIL_MAILER=failover
238238
```
239239

240240
<a name="round-robin-configuration"></a>

queues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1529,7 +1529,7 @@ $user->notify($invoicePaid);
15291529
<a name="queue-failover"></a>
15301530
### Queue Failover
15311531

1532-
The `failover` queue driver provides automatic failover functionality when pushing jobs to the queue. If the primary queue connection fails for any reason, Laravel will automatically attempt to push the job to the next configured connection in the list. This is particularly useful for ensuring high availability in production environments where queue reliability is critical.
1532+
The `failover` queue driver provides automatic failover functionality when pushing jobs to the queue. If the primary queue connection of the `failover` configuration fails for any reason, Laravel will automatically attempt to push the job to the next configured connection in the list. This is particularly useful for ensuring high availability in production environments where queue reliability is critical.
15331533

15341534
To configure a failover queue connection, specify the `failover` driver and provide an array of connection names to attempt in order. By default, Laravel includes an example failover configuration in your application's `config/queue.php` configuration file:
15351535

@@ -1544,7 +1544,7 @@ To configure a failover queue connection, specify the `failover` driver and prov
15441544
],
15451545
```
15461546

1547-
Once you have configured a connection that uses the `failover` driver, you will probably want to set the failover connection as your default queue connection in your application's `.env` file:
1547+
Once you have configured a connection that uses the `failover` driver, you will need to set the failover connection as your default queue connection in your application's `.env` file to make use of the failover functionality:
15481548

15491549
```ini
15501550
QUEUE_CONNECTION=failover

0 commit comments

Comments
 (0)