Skip to content

Commit 12e880d

Browse files
Apply #2213 by @glensc manually to both 4.0.x and 4.1.x
1 parent ff0b015 commit 12e880d

File tree

2 files changed

+46
-4
lines changed

2 files changed

+46
-4
lines changed

docs/configure.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,11 +319,11 @@ allows the RabbitMQ server and plugins to be configured.
319319
The file uses the [sysctl format](https://github.com/basho/cuttlefish/wiki/Cuttlefish-for-Application-Users),
320320
unlike `advanced.config` and the original `rabbitmq.config` (both use the Erlang terms format).
321321

322-
The syntax can be briefly explained in 3 lines:
322+
The syntax can be briefly explained like so:
323323

324324
* One setting uses one line
325325
* Lines are structured `Key = Value`
326-
* Any line starting with a `#` character is a comment
326+
* Any content starting with a `#` character is a comment
327327
* Values that contain the `#` character, such as generated strings, generated passwords, encrypted values,
328328
and so on, can be escaped with single quotes like so: `'efd3!53a9@92#a08_d_6d'`
329329

@@ -349,6 +349,27 @@ The above example is equivalent to the following [classic config format](#config
349349
This example will alter the [port RabbitMQ listens on](./networking#ports) for
350350
AMQP 0-9-1 and AMQP 1.0 client connections from 5672 to 5673.
351351

352+
A minimalistic example that uses value escaping:
353+
354+
```ini
355+
# this is a comment
356+
default_user = '40696e180b610ed9'
357+
default_pass = 'efd3!53a9@_2#a08'
358+
```
359+
360+
which is equivalent to the following [classic config format](#config-file-formats):
361+
362+
```erlang
363+
%% this is a comment
364+
[
365+
{rabbit, [
366+
{default_user, <<"40696e180b610ed9">>},
367+
{default_pass, <<"efd3!53a9@_2#a08">>}
368+
]
369+
}
370+
].
371+
```
372+
352373
The RabbitMQ server source repository contains [an example rabbitmq.conf file](https://github.com/rabbitmq/rabbitmq-server/blob/main/deps/rabbit/docs/rabbitmq.conf.example)
353374
named `rabbitmq.conf.example`. It contains examples of
354375
most of the configuration items you might want to set (with some very obscure ones omitted), along with

versioned_docs/version-4.0/configure.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,11 +319,11 @@ allows the RabbitMQ server and plugins to be configured.
319319
The file uses the [sysctl format](https://github.com/basho/cuttlefish/wiki/Cuttlefish-for-Application-Users),
320320
unlike `advanced.config` and the original `rabbitmq.config` (both use the Erlang terms format).
321321

322-
The syntax can be briefly explained in 3 lines:
322+
The syntax can be briefly explained like so:
323323

324324
* One setting uses one line
325325
* Lines are structured `Key = Value`
326-
* Any line starting with a `#` character is a comment
326+
* Any content starting with a `#` character is a comment
327327
* Values that contain the `#` character, such as generated strings, generated passwords, encrypted values,
328328
and so on, can be escaped with single quotes like so: `'efd3!53a9@92#a08_d_6d'`
329329

@@ -349,6 +349,27 @@ The above example is equivalent to the following [classic config format](#config
349349
This example will alter the [port RabbitMQ listens on](./networking#ports) for
350350
AMQP 0-9-1 and AMQP 1.0 client connections from 5672 to 5673.
351351

352+
A minimalistic example that uses value escaping:
353+
354+
```ini
355+
# this is a comment
356+
default_user = '40696e180b610ed9'
357+
default_pass = 'efd3!53a9@_2#a08'
358+
```
359+
360+
which is equivalent to the following [classic config format](#config-file-formats):
361+
362+
```erlang
363+
%% this is a comment
364+
[
365+
{rabbit, [
366+
{default_user, <<"40696e180b610ed9">>},
367+
{default_pass, <<"efd3!53a9@_2#a08">>}
368+
]
369+
}
370+
].
371+
```
372+
352373
The RabbitMQ server source repository contains [an example rabbitmq.conf file](https://github.com/rabbitmq/rabbitmq-server/blob/v4.0.x/deps/rabbit/docs/rabbitmq.conf.example)
353374
named `rabbitmq.conf.example`. It contains examples of
354375
most of the configuration items you might want to set (with some very obscure ones omitted), along with

0 commit comments

Comments
 (0)