Wrap console instructions to improve readability (#253)

ramonsmits · web-flow · commit c0777103fca4 · 2025-07-08T11:33:22.000+02:00
diff --git a/Container-README.md b/Container-README.md
@@ -5,7 +5,7 @@ An extension to [ServiceControl](https://docs.particular.net/servicecontrol) tha
 ## How to use this image
 
 This extension currently supports both RabbitMQ and Azure Service Bus brokers.  
-In order to successfully run this extension, you need to first run the ServiceControl container. Read more about the ServiceControl [image](https://hub.docker.com/r/particular/servicecontrol). 
+In order to successfully run this extension, you need to first run the ServiceControl container. Read more about the [ServiceControl image](https://hub.docker.com/r/particular/servicecontrol). 
 
 ### 1. Setup the connector
 
@@ -16,11 +16,21 @@ Before the connector can be run, the connector needs:
 
 To do this you need to run the container with the `--run-mode setup` option:
 ```shell
-docker run -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> -e CONNECTION_STRING=<connection string> --rm particular/servicecontrol-masstransit-connector:latest --run-mode setup
+docker run \
+  -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> \
+  -e CONNECTION_STRING=<connection string> \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode setup
 ```
 Followed by the `queues-list` command:
 ```shell
-docker run -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> -e CONNECTION_STRING=<connection string> --rm particular/servicecontrol-masstransit-connector:latest queues-list
+docker run \
+  -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> \
+  -e CONNECTION_STRING=<connection string> \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  queues-list
 ```
 
 The `queues-list` command will output onto the console a list of applicable queues that have been found in the broker.  
@@ -31,24 +41,63 @@ By default, we only list the queues that end with `_error` (the default naming c
 Assuming a RabbitMQ message broker is also hosted in a Docker container. Replace the &lt;port&gt;, &lt;username&gt; and &lt;password&gt; sections with their respective values.
 
 ```shell
-docker run -e TRANSPORT_TYPE=RabbitMQ -e CONNECTION_STRING=host=host.docker.internal -e RABBITMQ_MANAGEMENT_API_URL=http://host.docker.internal:<port> -e RABBITMQ_MANAGEMENT_API_USERNAME=<username> -e RABBITMQ_MANAGEMENT_API_PASSWORD=<password> --rm particular/servicecontrol-masstransit-connector:latest --run-mode setup
-docker run -e TRANSPORT_TYPE=RabbitMQ -e CONNECTION_STRING=host=host.docker.internal -e RABBITMQ_MANAGEMENT_API_URL=http://host.docker.internal:<port> -e RABBITMQ_MANAGEMENT_API_USERNAME=<username> -e RABBITMQ_MANAGEMENT_API_PASSWORD=<password> --rm particular/servicecontrol-masstransit-connector:latest queues-list > queues.txt
+docker run \
+  -e TRANSPORT_TYPE=RabbitMQ \
+  -e CONNECTION_STRING=host=host.docker.internal \
+  -e RABBITMQ_MANAGEMENT_API_URL=http://host.docker.internal:<port> \
+  -e RABBITMQ_MANAGEMENT_API_USERNAME=<username> \
+  -e RABBITMQ_MANAGEMENT_API_PASSWORD=<password> \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode setup
+
+docker run \
+  -e TRANSPORT_TYPE=RabbitMQ \
+  -e CONNECTION_STRING=host=host.docker.internal \
+  -e RABBITMQ_MANAGEMENT_API_URL=http://host.docker.internal:<port> \
+  -e RABBITMQ_MANAGEMENT_API_USERNAME=<username> \
+  -e RABBITMQ_MANAGEMENT_API_PASSWORD=<password> \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  queues-list > queues.txt
 ```
 
 #### Example of an Azure Service Bus setup
 
 ```shell
-docker run -e TRANSPORT_TYPE=AzureServiceBus -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] --rm particular/servicecontrol-masstransit-connector:latest --run-mode setup
-docker run -e TRANSPORT_TYPE=AzureServiceBus -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] --rm particular/servicecontrol-masstransit-connector:latest queues-list > queues.txt
+docker run \
+  -e TRANSPORT_TYPE=AzureServiceBus \
+  -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode setup
+
+docker run \
+  -e TRANSPORT_TYPE=AzureServiceBus \
+  -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  queues-list > queues.txt
 ```
 
 #### Example of an Azure Service Bus with Dead Letter enabled setup
 
 Using the `--filter` option.
 
 ```shell
-docker run -e TRANSPORT_TYPE=AzureServiceBusWithDeadLetter -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] --rm particular/servicecontrol-masstransit-connector:latest --run-mode setup
-docker run -e TRANSPORT_TYPE=AzureServiceBusWithDeadLetter -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] --rm particular/servicecontrol-masstransit-connector:latest queues-list --filter "^production_.*" > queues.txt
+docker run \
+  -e TRANSPORT_TYPE=AzureServiceBusWithDeadLetter \
+  -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode setup
+
+docker run \
+  -e TRANSPORT_TYPE=AzureServiceBusWithDeadLetter \
+  -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  queues-list --filter "^production_.*" > queues.txt
 ```
 
 ### 2. Configure error queues to monitor
@@ -63,27 +112,52 @@ From the previous step, we have piped the list of error queues output to the con
 The last step is to map the queues text file to the docker container `-v [local_path_to_queues_file]:/app/queues.txt:ro`, then run the connector to bridge MassTransit errors queues with the Particular Platform.
 
 ```shell
-docker run -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> -e CONNECTION_STRING=<connection string> -v [local_path_to_queues_file]:/app/queues.txt:ro particular/servicecontrol-masstransit-connector:latest --run-mode run
+docker run \
+  -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> \
+  -e CONNECTION_STRING=<connection string> \
+  -v [local_path_to_queues_file]:/app/queues.txt:ro \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode run
 ```
 
 #### Example of running with RabbitMQ
 
 Assuming a RabbitMQ message broker is also hosted in a Docker container. Replace the &lt;port&gt;, &lt;username&gt; and &lt;password&gt; sections with their respective values.
 
 ```shell
-docker run -e TRANSPORT_TYPE=RabbitMQ -e CONNECTION_STRING=host=host.docker.internal -e RABBITMQ_MANAGEMENT_API_URL=http://host.docker.internal:<port> -e RABBITMQ_MANAGEMENT_API_USERNAME=<username> -e RABBITMQ_MANAGEMENT_API_PASSWORD=<password> -v $(pwd)/queues.txt:/app/queues.txt:ro particular/servicecontrol-masstransit-connector:latest --run-mode run
+docker run \
+  -e TRANSPORT_TYPE=RabbitMQ \
+  -e CONNECTION_STRING=host=host.docker.internal \
+  -e RABBITMQ_MANAGEMENT_API_URL=http://host.docker.internal:<port> \
+  -e RABBITMQ_MANAGEMENT_API_USERNAME=<username> \
+  -e RABBITMQ_MANAGEMENT_API_PASSWORD=<password> \
+  -v $(pwd)/queues.txt:/app/queues.txt:ro \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode run
 ```
 
 #### Example of running with Azure Service Bus
 
 ```shell
-docker run -e TRANSPORT_TYPE=AzureServiceBus -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] -v $(pwd)/queues.txt:/app/queues.txt:ro --rm particular/servicecontrol-masstransit-connector:latest --run-mode run
+docker run \
+  -e TRANSPORT_TYPE=AzureServiceBus \
+  -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] \
+  -v $(pwd)/queues.txt:/app/queues.txt:ro \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode run
 ```
 
 #### Example of running with Azure Service Bus with Dead Letter enabled
 
 ```shell
-docker run -e TRANSPORT_TYPE=AzureServiceBusWithDeadLetter -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] -v $(pwd)/queues.txt:/app/queues.txt:ro --rm particular/servicecontrol-masstransit-connector:latest --run-mode run
+docker run \
+  -e TRANSPORT_TYPE=AzureServiceBusWithDeadLetter \
+  -e CONNECTION_STRING=Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccessKeyName=[KEYNAME];SharedAccessKey=[KEY] \
+  -v $(pwd)/queues.txt:/app/queues.txt:ro \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  --run-mode run
 ```
 
 ## Refreshing the errors queue text file
@@ -92,7 +166,12 @@ The `queues-list` command can be run when you need to update the list of error q
 The text file containing queue names can be updated without bringing down the container.  
 
 ```shell
-docker run -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> -e CONNECTION_STRING=<connection string> --rm particular/servicecontrol-masstransit-connector:latest queues-list
+docker run \
+  -e TRANSPORT_TYPE=<RabbitMQ|AzureServiceBus|AzureServiceBusWithDeadLetter> \
+  -e CONNECTION_STRING=<connection string> \
+  --rm \
+  particular/servicecontrol-masstransit-connector:latest \
+  queues-list
 ```
 
 This will output the list of all queues that end with `_error` (you can specify a different filter by using `--filter <regular expression>`).
@@ -137,11 +216,13 @@ Once you have received a license from Particular, there are two options to insta
 
 Currently supported are the most used MassTransit transports: RabbitMQ and Azure Service Bus.
 
-| Description       | Key                                  | Notes |
-|-------------------|--------------------------------------| --- |
-| Azure Service Bus | `AzureServiceBus`         | |
-| Azure Service Bus with Dead Letter | `AzureServiceBusWithDeadLetter`         | Azure Service Bus configured to ingest from [dead-letter queues](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues). | 
-| RabbitMQ          | `RabbitMQ` | |
+| Description                        | Key                             | Notes                                                                                                                                                           |
+|------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Azure Service Bus                  | `AzureServiceBus`               |                                                                                                                                                                 |
+| Azure Service Bus with Dead Letter | `AzureServiceBusWithDeadLetter` | Azure Service Bus configured to ingest from [dead-letter queues](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues). |
+| RabbitMQ                           | `RabbitMQ`                      |                                                                                                                                                                 |
+
+
 
 
 ### CONNECTION_STRING
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ A ServiceControl container image that adds support for processing [MassTransit](
 
 ## Installation
 
-The connector is container image which is **Linux Arm64** and **Linux Amd64** compatible. The image is available at https://hub.docker.com/r/particular/servicecontrol-masstransit-connector . Please read the docker hub README for more information on available tags and container usage.
+The connector is container image which is **Linux Arm64** and **Linux Amd64** compatible. The image is available at <https://hub.docker.com/r/particular/servicecontrol-masstransit-connector> . Please read the docker hub README for more information on available tags and container usage.
 
 ## Prerequisites
 
@@ -28,12 +28,15 @@ dotnet build src/ServiceControl.Connector.MassTransit.sln
 > The following creates a multiplatform images. This can only be build when the "Use containerd for pulling and storing images" is enabled under General.
 
 > [!NOTE]
-> The dockerfile is also compatible with https://podman.io/, replace `docker buildx build` with `podman build`.
+> The dockerfile is also compatible with <https://podman.io/>, replace `docker buildx build` with `podman build`.
 
 To locally build and test the container run the following in any shell:
 
 ```shell
-docker buildx build --file src/ServiceControl.Connector.MassTransit.Host/Dockerfile --platform linux/arm64,linux/amd64 --tag particular/servicecontrol-masstransit-connector:latest .
+docker buildx build \
+  --file src/ServiceControl.Connector.MassTransit.Host/Dockerfile \
+  --platform linux/arm64,linux/amd64 \
+  --tag particular/servicecontrol-masstransit-connector:latest .
 ```
 ### Troubleshooting
 
