From 05dc34b27bb8cc67b2fddf4f90e6c1ef47cf75c6 Mon Sep 17 00:00:00 2001 From: Oscar Michael Abrina Date: Tue, 1 Dec 2020 20:28:50 -0800 Subject: [PATCH] Clean up server setup instructions for MQTT and HTTP demos (#429) - Removes a broken link to configure Windows Firewall - Removes references to Mosquitto in the httpbin server setup instructions --- .../HTTP_Plaintext/readme.txt | 12 ++++-------- .../MQTT_Basic_TLS/mqtt_broker_setup.txt | 6 ++---- .../MQTT_Keep_Alive/mqtt_broker_setup.txt | 6 ++---- .../MQTT_Multitask/mqtt_broker_setup.txt | 2 +- .../MQTT_Mutual_Auth/mqtt_broker_setup.txt | 6 ++---- .../MQTT_Plain_Text/mqtt_broker_setup.txt | 6 ++---- .../MQTT_Serializer/mqtt_broker_setup.txt | 6 ++---- 7 files changed, 15 insertions(+), 29 deletions(-) diff --git a/FreeRTOS-Plus/Demo/coreHTTP_Windows_Simulator/HTTP_Plaintext/readme.txt b/FreeRTOS-Plus/Demo/coreHTTP_Windows_Simulator/HTTP_Plaintext/readme.txt index 71d9a51389..195534e3ba 100644 --- a/FreeRTOS-Plus/Demo/coreHTTP_Windows_Simulator/HTTP_Plaintext/readme.txt +++ b/FreeRTOS-Plus/Demo/coreHTTP_Windows_Simulator/HTTP_Plaintext/readme.txt @@ -12,18 +12,14 @@ over plaintext for use with this HTTP demo. is an active connection listening on port 80. c. Verify that there is an output as shown below `TCP 0.0.0.0:80 :0 LISTENING` - d. If there is no output on step c, go through the Mosquitto documentation - listed above to check if the setup was correct. 4. Make sure the httpbin server is allowed to communicate through - Windows Firewall. The instructions for allowing an application on Windows 10 - Defender Firewall can be found at the link below. - https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall - After running this HTTP demo, consider disabling the Mosquitto broker to - communicate through Windows Firewall for avoiding unwanted network traffic + Windows Firewall. + After running this demo, consider disabling the httpbin server to + communicate through Windows Firewall to avoid unwanted network traffic to your machine. 5. After verifying that a httpbin server is running successfully, update the config `democonfigSERVER_HOSTNAME` in `demo_config.h` to the local IP address of your Windows host machine. Please note that "localhost" or address "127.0.0.1" will not work as this example is running on a Windows Simulator and not on a Windows host natively. Also note that, if the Windows host is using a - Virtual Private Network(VPN), connection to the Mosquitto broker may not work. + Virtual Private Network(VPN), connection to the server may not work. diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Basic_TLS/mqtt_broker_setup.txt b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Basic_TLS/mqtt_broker_setup.txt index 019b092651..b029a9bced 100644 --- a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Basic_TLS/mqtt_broker_setup.txt +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Basic_TLS/mqtt_broker_setup.txt @@ -34,11 +34,9 @@ TLS server-only authentication for use with this MQTT demo. d. If there is no output on step c, go through the Mosquitto documentation listed above to check if the setup was correct. 8. Make sure the Mosquitto broker is allowed to communicate through - Windows Firewall. The instructions for allowing an application on Windows 10 - Defender Firewall can be found at the link below. - https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall + Windows Firewall. After running this MQTT example, consider disabling the Mosquitto broker to - communicate through Windows Firewall for avoiding unwanted network traffic + communicate through Windows Firewall to avoid unwanted network traffic to your machine. 9. After verifying that a Mosquitto broker is running successfully, update the config `democonfigMQTT_BROKER_ENDPOINT` to the local IP address of your diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Keep_Alive/mqtt_broker_setup.txt b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Keep_Alive/mqtt_broker_setup.txt index 52f79c84bc..cf073ba107 100644 --- a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Keep_Alive/mqtt_broker_setup.txt +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Keep_Alive/mqtt_broker_setup.txt @@ -17,11 +17,9 @@ over plaintext for use with this MQTT demo. d. If there is no output on step c, go through the Mosquitto documentation listed above to check if the setup was correct. 5. Make sure the Mosquitto broker is allowed to communicate through - Windows Firewall. The instructions for allowing an application on Windows 10 - Defender Firewall can be found at the link below. - https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall + Windows Firewall. After running this MQTT example, consider disabling the Mosquitto broker to - communicate through Windows Firewall for avoiding unwanted network traffic + communicate through Windows Firewall to avoid unwanted network traffic to your machine. 6. After verifying that a Mosquitto broker is running successfully, update the config `democonfigMQTT_BROKER_ENDPOINT` to the local IP address of your diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Multitask/mqtt_broker_setup.txt b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Multitask/mqtt_broker_setup.txt index 0bb4e684fe..5db8e91864 100644 --- a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Multitask/mqtt_broker_setup.txt +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Multitask/mqtt_broker_setup.txt @@ -41,7 +41,7 @@ TLS mutual authentication for use with this MQTT demo. Defender Firewall can be found at the link below. https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall After running this MQTT example, consider disabling the Mosquitto broker to - communicate through Windows Firewall for avoiding unwanted network traffic + communicate through Windows Firewall to avoid unwanted network traffic to your machine. 9. After verifying that a Mosquitto broker is running successfully, update the config `democonfigMQTT_BROKER_ENDPOINT` to the local IP address of your diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_broker_setup.txt b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_broker_setup.txt index 0bb4e684fe..85d7833390 100644 --- a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_broker_setup.txt +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Mutual_Auth/mqtt_broker_setup.txt @@ -37,11 +37,9 @@ TLS mutual authentication for use with this MQTT demo. d. If there is no output on step c, go through the Mosquitto documentation listed above to check if the setup was correct. 8. Make sure the Mosquitto broker is allowed to communicate through - Windows Firewall. The instructions for allowing an application on Windows 10 - Defender Firewall can be found at the link below. - https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall + Windows Firewall. After running this MQTT example, consider disabling the Mosquitto broker to - communicate through Windows Firewall for avoiding unwanted network traffic + communicate through Windows Firewall to avoid unwanted network traffic to your machine. 9. After verifying that a Mosquitto broker is running successfully, update the config `democonfigMQTT_BROKER_ENDPOINT` to the local IP address of your diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Plain_Text/mqtt_broker_setup.txt b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Plain_Text/mqtt_broker_setup.txt index 52f79c84bc..cf073ba107 100644 --- a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Plain_Text/mqtt_broker_setup.txt +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Plain_Text/mqtt_broker_setup.txt @@ -17,11 +17,9 @@ over plaintext for use with this MQTT demo. d. If there is no output on step c, go through the Mosquitto documentation listed above to check if the setup was correct. 5. Make sure the Mosquitto broker is allowed to communicate through - Windows Firewall. The instructions for allowing an application on Windows 10 - Defender Firewall can be found at the link below. - https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall + Windows Firewall. After running this MQTT example, consider disabling the Mosquitto broker to - communicate through Windows Firewall for avoiding unwanted network traffic + communicate through Windows Firewall to avoid unwanted network traffic to your machine. 6. After verifying that a Mosquitto broker is running successfully, update the config `democonfigMQTT_BROKER_ENDPOINT` to the local IP address of your diff --git a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Serializer/mqtt_broker_setup.txt b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Serializer/mqtt_broker_setup.txt index 52f79c84bc..cf073ba107 100644 --- a/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Serializer/mqtt_broker_setup.txt +++ b/FreeRTOS-Plus/Demo/coreMQTT_Windows_Simulator/MQTT_Serializer/mqtt_broker_setup.txt @@ -17,11 +17,9 @@ over plaintext for use with this MQTT demo. d. If there is no output on step c, go through the Mosquitto documentation listed above to check if the setup was correct. 5. Make sure the Mosquitto broker is allowed to communicate through - Windows Firewall. The instructions for allowing an application on Windows 10 - Defender Firewall can be found at the link below. - https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall + Windows Firewall. After running this MQTT example, consider disabling the Mosquitto broker to - communicate through Windows Firewall for avoiding unwanted network traffic + communicate through Windows Firewall to avoid unwanted network traffic to your machine. 6. After verifying that a Mosquitto broker is running successfully, update the config `democonfigMQTT_BROKER_ENDPOINT` to the local IP address of your