diff options
author | Robert Hensing <roberth@users.noreply.github.com> | 2018-11-13 10:03:38 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-11-13 10:03:38 +0100 |
commit | 9871fe3564ee6f4a5b4a77adaae62589dbcf60c2 (patch) | |
tree | fa80776210e55066d5180a8489d2808f67b4b33a /nixos | |
parent | dd3aca2d0b9dcb4888779bfb08805d79596607c9 (diff) | |
parent | 4aa30166d160f2d8f27634b7b09d0bf236b8aa73 (diff) | |
download | nixlib-9871fe3564ee6f4a5b4a77adaae62589dbcf60c2.tar nixlib-9871fe3564ee6f4a5b4a77adaae62589dbcf60c2.tar.gz nixlib-9871fe3564ee6f4a5b4a77adaae62589dbcf60c2.tar.bz2 nixlib-9871fe3564ee6f4a5b4a77adaae62589dbcf60c2.tar.lz nixlib-9871fe3564ee6f4a5b4a77adaae62589dbcf60c2.tar.xz nixlib-9871fe3564ee6f4a5b4a77adaae62589dbcf60c2.tar.zst nixlib-9871fe3564ee6f4a5b4a77adaae62589dbcf60c2.zip |
Merge pull request #47346 from NixOS/roberth-patch-1
rabbitmq module: Update documentation
Diffstat (limited to 'nixos')
-rw-r--r-- | nixos/modules/services/amqp/rabbitmq.nix | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/nixos/modules/services/amqp/rabbitmq.nix b/nixos/modules/services/amqp/rabbitmq.nix index c6878dd67dbf..7373be2a9b0b 100644 --- a/nixos/modules/services/amqp/rabbitmq.nix +++ b/nixos/modules/services/amqp/rabbitmq.nix @@ -87,9 +87,19 @@ in { } ''; description = '' - New style config options. - - See http://www.rabbitmq.com/configure.html + 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. + + 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 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 = ""; type = types.str; description = '' - Verbatim advanced configuration file contents. - Prefered way is to use configItems. + Verbatim advanced configuration file contents using the Erlang syntax. + This is also known as the <literal>advanced.config</literal> file or the old config format. + + <literal>configItems</literal> is preferred whenever possible. 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 http://www.rabbitmq.com/configure.html + 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 ''; }; |