Skip to content

Commit 73b7c97

Browse files
More edits to CONTRIBUTING.md
1 parent 54d0dc6 commit 73b7c97

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

CONTRIBUTING.md

+18-12
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,29 @@ To configure a node to run the TLS tests, configure the node to use the [certifi
4444
under `TestCertificates`. The certificates have a Subject Alternative Name of `localhost`
4545
which makes them not to be dependent on the host they were generated on.
4646

47-
The following [RabbitMQ configuration file](https://www.rabbitmq.com/configure.html#configuration-files) is used by CI:
47+
The test suite also requires the [x509 certificate authentication mechanism](https://github.com/rabbitmq/rabbitmq-auth-mechanism-ssl)
48+
plugin to be enabled:
49+
50+
``` shell
51+
brew install rabbitmq
52+
# target location will vary depending on how RabbitMQ was installed,
53+
# the Homebrew Cellar location and so on
54+
cp TestCertificates/* /usr/local/etc/rabbitmq/
55+
rabbitmq-plugins enable rabbitmq_auth_mechanism_ssl --offline
56+
```
57+
58+
Then restart RabbitMQ.
59+
60+
The following [RabbitMQ configuration file](https://www.rabbitmq.com/configure.html#configuration-files)
61+
is used by CI and can be used as example:
4862

4963
``` ini
5064
listeners.tcp.1 = 0.0.0.0:5672
5165
listeners.tcp.2 = 0.0.0.0:5674
5266

53-
5467
listeners.ssl.default = 5671
5568

69+
# the paths must match those
5670
ssl_options.cacertfile = /usr/local/etc/rabbitmq/ca_certificate.pem
5771
ssl_options.certfile = /usr/local/etc/rabbitmq/server_certificate.pem
5872
ssl_options.keyfile = /usr/local/etc/rabbitmq/server_key.pem
@@ -65,16 +79,8 @@ auth_mechanisms.2 = AMQPLAIN
6579
auth_mechanisms.3 = EXTERNAL
6680
```
6781

68-
The test suite also requires the [x509 certificate authentication mechanism](https://github.com/rabbitmq/rabbitmq-auth-mechanism-ssl)
69-
plugin to be enabled:
70-
71-
``` shell
72-
brew install rabbitmq
73-
cp TestCertificates/* /path/to/rabbitmq/installation/etc/rabbitmq/
74-
rabbitmq-plugins enable rabbitmq_auth_mechanism_ssl --offline
75-
```
76-
77-
Then restart RabbitMQ.
82+
In case a different set of certificates is desired, it is highly recommended
83+
[using tls-gen](https://github.com/michaelklishin/tls-gen)'s basic profile.
7884

7985
### Node Preconfiguration
8086

0 commit comments

Comments
 (0)