rabbitmq module: Update documentation
Elaborate on the two config file formats.
This commit is contained in:
parent
7e3d35afc5
commit
6c568b6644
@ -87,9 +87,19 @@ in {
|
|||||||
}
|
}
|
||||||
'';
|
'';
|
||||||
description = ''
|
description = ''
|
||||||
New style config options.
|
Configuration options in RabbitMQ's new config file format,
|
||||||
|
which is a simple key-value format that can not express nested
|
||||||
|
data structures. This is known as the <literal>rabbitmq.conf</literal> file,
|
||||||
|
although outside NixOS that filename may have Erlang syntax, particularly
|
||||||
|
prior to RabbitMQ 3.7.0.
|
||||||
|
|
||||||
See http://www.rabbitmq.com/configure.html
|
If you do need to express nested data structures, you can use
|
||||||
|
<literal>config</literal> option. Configuration from <literal>config</literal>
|
||||||
|
will be merged into the these options by RabbitMQ at runtime to
|
||||||
|
form the final configuration.
|
||||||
|
|
||||||
|
See http://www.rabbitmq.com/configure.html#config-items
|
||||||
|
For the distinct formats, see http://www.rabbitmq.com/configure.html#config-file-formats
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -97,10 +107,17 @@ in {
|
|||||||
default = "";
|
default = "";
|
||||||
type = types.str;
|
type = types.str;
|
||||||
description = ''
|
description = ''
|
||||||
Verbatim advanced configuration file contents.
|
Verbatim advanced configuration file contents using the Erlang syntax.
|
||||||
Prefered way is to use configItems.
|
This is also known as the <literal>advanced.config</literal> file or the old config format.
|
||||||
|
|
||||||
See http://www.rabbitmq.com/configure.html
|
Where possible, the use <literal>configItems</literal> is preferred. However, nested
|
||||||
|
data structures can only be expressed properly using the <literal>config</literal> option.
|
||||||
|
|
||||||
|
The contents of this option will be merged into the <literal>configItems</literal>
|
||||||
|
by RabbitMQ at runtime to form the final configuration.
|
||||||
|
|
||||||
|
See the second table on http://www.rabbitmq.com/configure.html#config-items
|
||||||
|
For the distinct formats, see http://www.rabbitmq.com/configure.html#config-file-formats
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user