Comment out all options and simplify

1 files changed, 211 insertions, 227 deletions

diff --git a/docs/rabbitmq.sample.config b/docs/rabbitmq.sample.config
index 3cbfdc7a..2c702961 100644
--- a/docs/rabbitmq.sample.config
+++ b/docs/rabbitmq.sample.config
@@ -1,86 +1,92 @@
 [
  %% ----------------------------------------------------------------------------
- %% RabbitMQ Sample Configuration File
+ %% RabbitMQ Sample Configuration File.
+ %%
+ %% See http://www.rabbitmq.com/configure.html for details.
  %% ----------------------------------------------------------------------------
 
  {rabbit, [%%
            %% Network Connectivity
            %%
 
-           %% Configure AMQP to listen on ports
-           {tcp_listeners, [5672, 5673]},
+           %% Configure AMQP to listen on ports.
+           %% {tcp_listeners, [5672, 5673]},
 
-           %% Configure SSL (AMQP) to listen on ports
-           {ssl_listeners, [5674, 5675]},
+           %% Configure SSL (AMQP) to listen on ports.
+           %% {ssl_listeners, [5674, 5675]},
 
-           %% SSL options
-           {ssl_options, [{cacertfile,"/path/to/testca/cacert.pem"},
-                          {certfile,"/path/to/server/cert.pem"},
-                          {keyfile,"/path/to/server/key.pem"},
-                          {verify, verify_peer},
-                          {fail_if_no_peer_cert, true}]},
+           %% SSL options.
+           %%
+           %% {ssl_options, [{cacertfile,"/path/to/testca/cacert.pem"},
+           %%                {certfile,"/path/to/server/cert.pem"},
+           %%                {keyfile,"/path/to/server/key.pem"},
+           %%                {verify, verify_peer},
+           %%                {fail_if_no_peer_cert, true}]},
 
-           %% Frame Max (in bytes)
-           {frame_max, 131072},
+           %% Frame Max (in bytes).
+           %% {frame_max, 131072},
 
-           %% Heartbeat delay (in seconds)
-           {heartbeat, 600},
+           %% Heartbeat delay (in seconds).
+           %% {heartbeat, 600},
 
-           %% Socket options
-           %% See  (http://www.erlang.org/doc/man/inet.html#setopts-2)
-           {tcp_listen_options, [binary,
-                                 {packet,        raw},
-                                 {reuseaddr,     true},
-                                 {backlog,       128},
-                                 {nodelay,       true},
-                                 {exit_on_close, false}]},
+           %% Socket options.
+           %%
+           %% See (http://www.erlang.org/doc/man/inet.html#setopts-2) for
+           %% further documentation.
+           %%
+           %% {tcp_listen_options, [binary,
+           %%                       {packet,        raw},
+           %%                       {reuseaddr,     true},
+           %%                       {backlog,       128},
+           %%                       {nodelay,       true},
+           %%                       {exit_on_close, false}]},
 
            %%
            %% Security/AAA & Default VHost/User
            %%
 
-           %% Set available auth mechanisms
-           {auth_mechanisms, ['PLAIN', 'AMQPLAIN']},
+           %% Set available auth mechanisms.
+           %% {auth_mechanisms, ['PLAIN', 'AMQPLAIN']},
 
-           %% To enable auth-mechanism-ssl
+           %% To enable auth-mechanism-ssl.
            %% {auth_mechanisms, ['EXTERNAL']},
 
-           %% Available authentication databases
-           {auth_backends, [rabbit_auth_backend_internal]},
+           %% Set Available authentication databases.
+           %% {auth_backends, [rabbit_auth_backend_internal]},
 
-           %% To enable the LDAP backend
+           %% To enable the LDAP backend.
            %% {auth_backends, [rabbit_auth_backend_ldap]},
 
-           %% Virtual host to create on first start
-           {default_vhost, <<"/">>},
+           %% Virtual host to create on first start.
+           %% {default_vhost, <<"/">>},
 
-           %% User name to create on first start
-           {default_user, <<"guest">>},
+           %% User name to create on first start.
+           %% {default_user, <<"guest">>},
 
-           %% Password for default user
-           {default_pass, <<"guest">>},
+           %% Password for default user.
+           %% {default_pass, <<"guest">>},
 
-           %% Tags for default user
-           {default_user_tags, [administrator]},
+           %% Tags for default user.
+           %% {default_user_tags, [administrator]},
 
-           %% Permissions for default user
-           {default_permissions, [<<".*">>, <<".*">>, <<".*">>]},
+           %% Permissions for default user.
+           %% {default_permissions, [<<".*">>, <<".*">>, <<".*">>]},
 
            %%
            %% Resource Limits & Flow Control
            %%
 
-           %% Memory-based Flow Control threshold
-           {vm_memory_high_watermark, 0.4},
+           %% Memory-based Flow Control threshold.
+           %% {vm_memory_high_watermark, 0.4},
 
-           %% Disk free limits (set in bytes)
-           {disk_free_limit, 1000000000},
+           %% Set disk free limit (in bytes).
+           %% {disk_free_limit, 1000000000},
 
-           %% Disk free limits (relative to total RAM)
-           {disk_free_limit, {mem_relative, 1.0}},
+           %% Alternatively, set disk free limit relative to total RAM.
+           %% {disk_free_limit, {mem_relative, 1.0}},
 
-           %% Log levels
-           {log_levels, [{connection, info}]},
+           %% Log levels.
+           %% {log_levels, [{connection, info}]},
 
            %%
            %% Misc/Advanced Options:
@@ -88,42 +94,39 @@
            %% NB: Change these only if you understand what you're doing!
            %%
 
-           %% How to respond to cluster partitions
-           {cluster_partition_handling, ignore},
-
-           %% Make clustering happen *automatically*
-           {cluster_nodes, {['rabbit@my.host.com'], disc}},
-
-           %% Set (internal) statistics granularity
-           {collect_statistics, none},
-
-           %% Statistics collection interval (in milliseconds)
-           {collect_statistics_interval, 5000},
-
-           %% Override file handle limits
-           {file_handles_high_watermark, 10000000},
+           %% How to respond to cluster partitions.
+           %%
+           %% - ignore: take no further action
+           %% - pause_minority: pause any nodes belonging to a minority island
+           %% - autoheal: start and stop nodes as required, to heal a partition
+           %%
+           %% See http://www.rabbitmq.com/partitions.html for further details.
+           %%
+           %% {cluster_partition_handling, ignore},
 
-           %% Explicitly enable/disable hipe compilation
-           {hipe_compile, true},
+           %% Make clustering happen *automatically* at startup. Note that
+           %% changes to this element are only applied when the broker is
+           %% starting, and not thereafter.
+           %%
+           %% {cluster_nodes, {['rabbit@my.host.com'], disc}},
 
-           %% Override the number of delegate processes in use
-           {delegate_count, 16}m
+           %% Set (internal) statistics collection granularity.
+           %%
+           %% - none: disables statistics events
+           %% - coarse: emit stats per queue, channel and connection
+           %% - fine: also emit per-message stats
+           %%
+           %% {collect_statistics, none},
 
-           %% Implementation module for queue indexing
-           {msg_store_index_module, rabbit_msg_store_ets_index},
+           %% Statistics collection interval (in milliseconds).
+           %% {collect_statistics_interval, 5000},
 
-           %% Implementation module for queue content handling
-           {backing_queue_module, rabbit_variable_queue},
+           %% Override file handle limits.
+           %% {file_handles_high_watermark, 10000000},
 
-           %% Tunes the maximum (individual) file size limit for
-           %% the broker's persistent message store. WARNING you
-           %% should almost certainly not need to change this
-           {msg_store_file_size_limit, 16777216},
+           %% Explicitly enable/disable hipe compilation.
+           %% {hipe_compile, true},
 
-           %% Tunes the maximum number of journal entries for
-           %% the broker's persistent message store. WARNING:
-           %% you should almost certainly not need to change this
-           {queue_index_max_journal_entries, 65536}
           ]},
 
  %% ----------------------------------------------------------------------------
@@ -133,31 +136,28 @@
  %% ----------------------------------------------------------------------------
 
  {rabbitmq_management,
-  [%% Pre-Load schema definitions from the following JSON file
-   {load_definitions, "/path/to/schema.json"},
+  [%% Pre-Load schema definitions from the following JSON file.
+   %% {load_definitions, "/path/to/schema.json"},
 
-   %% Log HTTP requests to a file
-   {http_log_dir, "/path/to/access.log"},
+   %% Log HTTP requests to a file.
+   %% {http_log_dir, "/path/to/access.log"},
 
    %% Change the port on which the HTTP listener listens,
-   %% specify an interface for the web server to bind to.
-   %% Also set the listener to use SSL
-   {listener, [{port, 12345},
-               {ip, "127.0.0.1"},
-               {ssl, true},
-               {ssl_opts, [{cacertfile, "/path/to/cacert.pem"},
-                           {certfile,   "/path/to/cert.pem"},
-                           {keyfile,    "/path/to/key.pem"}]}]},
-
-   %% Sample retention policies
-   {sample_retention_policies,
-    [{global,   [{60, 5}, {3600, 60}, {86400, 1200}]},
-     {basic,    [{60, 5}, {3600, 60}]},
-     {detailed, [{10, 5}]}]}
+   %% specifying an interface for the web server to bind to.
+   %% Also set the listener to use SSL.
+   %%
+   %% {listener, [{port, 12345},
+   %%             {ip, "127.0.0.1"},
+   %%             {ssl, true},
+   %%             {ssl_opts, [{cacertfile, "/path/to/cacert.pem"},
+   %%                         {certfile,   "/path/to/cert.pem"},
+   %%                         {keyfile,    "/path/to/key.pem"}]}]},
+
   ]},
 
- {rabbitmq_management_agent [%% Force fine-grained statistics
-                             {force_fine_statistics, true}]},
+ {rabbitmq_management_agent [%% Force fine-grained statistics.
+                             %% {force_fine_statistics, true}
+                            ]},
 
  %% ----------------------------------------------------------------------------
  %% RabbiMQ Shovel Plugin
@@ -166,71 +166,51 @@
  %% ----------------------------------------------------------------------------
 
  {rabbitmq_shovel,
-  [{shovels, [%% a named shovel worker
-              {my_first_shovel,
-               [{sources,
-                 %% Setting SSL Options via connection string
-                 [{brokers, ["amqps://username:password@host:port/vhost?"
-                             "cacertfile=/path/to/cacert.pem"
-                             "&certfile=/path/to/certfile.pem"
-                             "&keyfile=/path/to/keyfile.pem"
-                             "&verify=verify_peer"
-                             "&fail_if_no_peer_cert=true",
-
-                             %% Tuning connections via connection string
-                             "amqp://john:secret@host2.domain/my_vhost"
-                             "?heartbeat=5&frame_max=8192"
-                            ]},
-
-                  %% AMQP objects that we want to ensure are present
-                  %% on the source broker(s)
-                  {declarations,
-                   [ {'exchange.declare',
-                      [{exchange, <<"my_fanout">>},
-                       {type, <<"fanout">>}, durable]},
-                     {'queue.declare',
-                      [{arguments,
-                        [{<<"x-message-ttl">>, long, 60000}]}]},
-                     {'queue.bind',
-                      [{exchange, <<"my_direct">>}, {queue,<<>>}]}
-                   ]}
-                 ]},
-
-                {destinations,
-                 [%% a singular version of the 'brokers' configuration element
-                  {broker, "amqp://"},
-
-                  %% declarations we want to ensure are present on
-                  %% the destination broker(s)
-                  {declarations, [{'exchange.declare',
-                                   [{exchange, <<"my_direct">>},
-                                    {type, <<"direct">>}, durable]}]}
-                 ]},
-
-                %% name of the queue to shovel messages from
-                {queue, <<>>},
-
-                %% optional prefetch count
-                {prefetch_count, 10},
-
-                %% when to acknowledge messages:
-                %% - no_ack: never (auto)
-                %% - on_publish: after each message is republished
-                %% - on_confirm: when the destination broker confirms receipt
-                {ack_mode, on_confirm},
-
-                %% static list of basic.properties to set on re-publication
-                {publish_properties, [{delivery_mode, 2}]},
-
-                %% overwrite fields of the outbound basic.publish
-                {publish_fields, [{exchange, <<"my_direct">>},
-                                  {routing_key, <<"from_shovel">>}]},
-
-                %% the number of seconds to wait before attempting to
-                %% reconnect in the event of a connection failure
-                {reconnect_delay, 2.5}
+  [{shovels, [%% A named shovel worker
+              %% {my_first_shovel,
+              %%  [{sources,
+              %%    [{brokers, [
+                                %% URI(s) of source broker(s).
+              %%                "amqp://user:password@host.domain/my_vhost"
+              %%               ]},
+
+                     %% Declarations we want to ensure are present on the
+                     %% source broker(s).
+              %%     {declarations, []}
+              %%    ]},
+
+              %%   {destinations,
+              %%    [%% A singular version of the 'brokers' element.
+              %%     {broker, "amqp://"},
+
+                     %% Declarations we want to ensure are present on
+                     %% the destination broker(s).
+              %%     {declarations, []}
+              %%    ]},
+
+                   %% Name of the queue to shovel messages from.
+              %%   {queue, <<>>},
+
+                   %% Optional prefetch count.
+              %%   {prefetch_count, 10},
+
+                   %% when to acknowledge messages:
+                   %% - no_ack: never (auto)
+                   %% - on_publish: after each message is republished
+                   %% - on_confirm: when the destination broker confirms receipt
+              %%   {ack_mode, on_confirm},
+
+                   %% Static list of basic.properties to set on re-publication.
+              %%   {publish_properties, [{delivery_mode, 2}]},
+
+                   %% Overwrite fields of the outbound basic.publish.
+              %%   {publish_fields, []},
+
+                   %% the number of seconds to wait before attempting to
+                   %% reconnect in the event of a connection failure
+              %%   {reconnect_delay, 2.5}
                ]}
-             ]}]},
+             ]},
 
  %% ----------------------------------------------------------------------------
  %% RabbiMQ Stomp Adapter
@@ -238,22 +218,22 @@
  %% See http://www.rabbitmq.com/stomp.html for details
  %% ----------------------------------------------------------------------------
 
- {rabbitmq_stomp, [%% Listen only on localhost (ipv4 & ipv6) on port 61613
-                   {tcp_listeners, [{"127.0.0.1", 61612},
-                                    {"::1",       61612}]},
+ {rabbitmq_stomp, [%% Listen only on localhost (ipv4 & ipv6) on port 61613.
+                   %% {tcp_listeners, [{"127.0.0.1", 61612},
+                   %%                  {"::1",       61612}]},
 
-                   %% Listen for SSL connections on 61613
-                   {ssl_listeners, [61613]},
+                   %% Listen for SSL connections on 61613.
+                   %% {ssl_listeners, [61613]},
 
-                   %% Extract name from client's certificate when using SSL
-                   {ssl_cert_login, true},
+                   %% Extract name from client's certificate when using SSL.
+                   %% {ssl_cert_login, true},
 
                    %% Use cn instead of dn when reading from the SSL cert
-                   %%                , {ssl_cert_login_from, common_name}
+                   %%                , {ssl_cert_login_from, common_name}.
 
-                   %% Set a default user and password
-                   {default_user, [{login, "guest"},
-                                   {passcode, "guest"}]}
+                   %% Set a default user and password.
+                   %% {default_user, [{login, "guest"},
+                   %%                 {passcode, "guest"}]}
                   ]},
 
  %% ----------------------------------------------------------------------------
@@ -262,20 +242,36 @@
  %% See http://hg.rabbitmq.com/rabbitmq-mqtt/file/stable/README.md for details
  %% ----------------------------------------------------------------------------
 
- {rabbitmq_mqtt, [{default_user,     <<"guest">>},
-                  {default_pass,     <<"guest">>},
-                  {allow_anonymous,  true},
-                  {vhost,            <<"/">>},
-                  {exchange,         <<"amq.topic">>},
-                  {subscription_ttl, 1800000},
-                  {prefetch,         10},
-                  {ssl_listeners,    []},
-                  {tcp_listeners,    [1883]},
-                  {tcp_listen_options, [binary,
-                                        {packet,    raw},
-                                        {reuseaddr, true},
-                                        {backlog,   128},
-                                        {nodelay,   true}]}]},
+ {rabbitmq_mqtt, [%% Set the default user name and password
+                  %% {default_user, <<"guest">>},
+                  %% {default_pass, <<"guest">>},
+
+                  %% Enable anonymous access
+                  %% {allow_anonymous, true},
+
+                  %% Specify the vhost
+                  %% {vhost, <<"/">>},
+
+                  %% Specify the exchange
+                  %% {exchange, <<"amq.topic">>},
+
+                  %% Specify TTL for subscriptions
+                  %% {subscription_ttl, 1800000},
+
+                  %% Set prefetch count
+                  %% {prefetch, 10},
+
+                  %% TCP/SSL Configuration
+                  %% {ssl_listeners, []},
+                  %% {tcp_listeners,    [1883]},
+
+                  %% TCP/Socket options
+                  %% {tcp_listen_options, [binary,
+                  %%                       {packet,    raw},
+                  %%                       {reuseaddr, true},
+                  %%                       {backlog,   128},
+                  %%                       {nodelay,   true}]}
+                 ]},
 
  %% ----------------------------------------------------------------------------
  %% RabbiMQ AMQP 1.0 Support
@@ -284,8 +280,12 @@
  %% for details
  %% ----------------------------------------------------------------------------
 
- {rabbitmq_amqp1_0, [{default_user, "guest"},
-                     {protocol_strict_mode, false}]},
+ {rabbitmq_amqp1_0, [%% Set the default user
+                     %% {default_user, "guest"},
+
+                     %% Enable protocol strict mode
+                     %% {protocol_strict_mode, false}
+                    ]},
 
  %% ----------------------------------------------------------------------------
  %% RabbitMQ LDAP Plugin
@@ -295,46 +295,30 @@
  %% ----------------------------------------------------------------------------
 
  {rabbitmq_auth_backend_ldap,
-  [{servers,               ["my-ldap-server"]},
-   {user_dn_pattern,       "cn=${username},ou=People,dc=example,dc=com"},
-   {use_ssl,               false},
-   {port,                  389},
-   {log,                   false},
-   {vhost_access_query,    {in_group
-                            "ou=${vhost}-users,ou=vhosts,dc=example,dc=com"}},
-   {resource_access_query,
-    {for, [{permission, configure, {in_group, "cn=admin,dc=example,dc=com"}},
-           {permission, write,
-            {for, [{resource, queue, {in_group,
-                                      "cn=admin,dc=example,dc=com"}},
-                   {resource, exchange, {constant, true}}]}},
-           {permission, read,
-            {for, [{resource, exchange, {in_group,
-                                         "cn=admin,dc=example,dc=com"}},
-                   {resource, queue, {constant, true}}]}}
-          ]
-    }},
-   {tag_queries, [{administrator, {constant, false}},
-                  {management,    {constant, true}}]}
-  ]
- },
+  [%% Specify a list of LDAP Servers
+   %% {servers, []},
 
- %% ----------------------------------------------------------------------------
- %% Lager Logging Support
- %%
- %% See https://github.com/basho/lager for specific configuration.
- %%
- %% ----------------------------------------------------------------------------
+   %% Set user DN pattern
+   %% {user_dn_pattern, "cn=${username},ou=People,dc=example,dc=com"},
+
+   %% Enable SSL
+   %% {use_ssl, false},
+
+   %% Specify the LDAP port
+   %% {port, 389},
+
+   %% Enable logging
+   %% {log, false},
+
+   %% Set vhost access query
+   %% {vhost_access_query, {in_group
+   %%                        "ou=${vhost}-users,ou=vhosts,dc=example,dc=com"}},
+
+   %% Set resource access query
+   %% {resource_access_query, {constant, true}},
 
- {lager, [{handlers,
-           [{lager_console_backend, info},
-            {lager_file_backend,
-             [%% Location of the error log
-              {"/var/log/rabbitmq/error.log", error, 10485760, "$D0", 5},
-              %% Location of the info log
-              {"/var/log/rabbitmq/console.log", info, 10485760, "$D0", 5}
-             ]}
-           ]}
-         ]}
+   %% Set tag queries
+   %% {tag_queries, []}
+  ]}
 ].