Skip to content

Commit 0e3aab7

Browse files
committed
Update documentation for auto boot option
1 parent ccf4a02 commit 0e3aab7

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1002,6 +1002,12 @@ when `SESSION_DRIVER` equals `redis-sentinel`. It defaults to the package's
10021002
internal, auto-configured *session* connection when unset unless the
10031003
application configuration already contains a value for `session.connection`.
10041004

1005+
### `REDIS_SENTINEL_AUTO_BOOT`
1006+
1007+
When set to `true`, this flag instructs the package to boot the package after
1008+
it registers its services without waiting for the application boot phase. This
1009+
provides a way for applications that use Sentinel connections in other service
1010+
providers to initialize the package immediately.
10051011

10061012
Appendix: Configuration Examples
10071013
--------------------------------

config/redis-sentinel.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,12 @@
6464
| values to the cache file. If the application uses this configuration
6565
| key for other purposes, set the value of "clean_config" to FALSE.
6666
|
67+
| The "auto_boot" directive instructs the package to immediately boot its
68+
| services after the registration phase. This allows applications to use
69+
| Sentinel-backed services in service providers during the registration
70+
| phase for compatibility with other packages that may use cache, session
71+
| queue, and broadcasting features before the application boot phase.
72+
|
6773
*/
6874

6975
'load_config' => true,

0 commit comments

Comments
 (0)