patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

samples: net: mqtt: update readme with SOCKS5 info

Browse source 
This commits adds an overlay file with the SOCKS5 symbol that is needed
to run MQTT with a proxy, and extends README with instructions on how to
use it with the default and custom settings.

Signed-off-by: Tomasz Gorochowik <tgorochowik@antmicro.com>
This commit is contained in:
Tomasz Gorochowik 2019-03-11 11:20:57 +01:00 committed by Andrew Boie
parent 3aa8443ab4
commit 9115386e4d
2 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
samples/net/mqtt_publisher/README.rst
View file

@ -122,6 +122,31 @@ specifying ``-DOVERLAY_CONFIG=overlay-tls-offload.conf`` when running cmake.
Using this overlay enables TLS without bringing in mbedtls.
SOCKS5 proxy support
====================
It is also possible to connect to the MQTT broker through a SOCKS5 proxy.
To enable it, use ``-DOVERLAY_CONFIG=overlay-socks5.conf`` when running cmake.
By default, to make the testing easier, the proxy is expected to run on the
same host as the MQTT broker.
To start a proxy server, ``ssh`` can be used.
Use the following command to run it on your host with the default port:
.. code-block: console
$ ssh -N -D 0.0.0.0:1080 localhost
To connect to a proxy server that is not running under the same IP as the MQTT
broker or uses a different port number, modify the following values:
.. code-block:: c
#define SOCKS5_PROXY_ADDR SERVER_ADDR
#define SOCKS5_PROXY_PORT 1080
Running on cc3220sf_launchxl
============================

1
samples/net/mqtt_publisher/overlay-socks5.conf Normal file
View file

@ -0,0 +1 @@
CONFIG_MQTT_LIB_SOCKS=y