Skip to content

Commit 04da638

Browse files
authored
Config documentation update (typo and dsn example) (#107)
* Fix typo (overriden --> overridden) * Clarify DSN/update example. Fix confusing language for thinking 'url' only contains the protocol, not the full DSN, through a more extensive example. * Update example with a full DSN
1 parent 6470345 commit 04da638

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/en/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,11 @@ The following configuration should be present in the config array of your **conf
4141
'Queue' => [
4242
'default' => [
4343
// A DSN for your configured backend. default: null
44-
'url' => 'redis:',
44+
// Can contain protocol/port/username/password or be null if the backend defaults to localhost
45+
'url' => 'redis://myusername:mypassword@example.com:1000',
4546

4647
// The queue that will be used for sending messages. default: default
47-
// This can be overriden when queuing or processing messages
48+
// This can be overridden when queuing or processing messages
4849
'queue' => 'default',
4950

5051
// The name of a configured logger, default: null

0 commit comments

Comments
 (0)