This folder contains both Arduino/PlatformIO and native ESP-IDF examples for an ESP32 board.
src/main.cpp– Arduino reverse-tunnel example (Wi-Fi setup, SSH configuration, tunnel loop, periodic stats).esp-idf/– native ESP-IDF project with Wi-Fi and SSH settings inmenuconfig; see its README.
No .ino sketches or helper scripts are required; everything builds from
src/main.cpp.
pio run -e arduino-3 # compile from the repository root
pio run -t upload # flash your connected ESP32
pio device monitor # watch serial logs (115200 by default)The root platformio.ini fetches the
playmiel/libssh2_esp32 fork. For native ESP-IDF, initialize the submodule,
then run idf.py build flash monitor from examples/esp-idf; the
ESP-IDF guide covers installation and PSRAM.
Edit src/main.cpp and adjust:
- Wi-Fi credentials (
WIFI_SSID,WIFI_PASSWORD) - SSH server settings (
globalSSHConfig.setSSHServer/setSSHKeyAuthFromMemory) - Tunnel parameters (
setTunnelConfig) - Optional tuning (
setBufferConfig,setKeepAliveOptions,setLogLevel, …)
src/main.cpp now ships with an optional multi-tunnel scenario guarded by the
ENABLE_MULTI_TUNNEL_DEMO flag at the top of the file. When the flag is set to
1 (default), configureMultiTunnelMappings() clears the legacy single tunnel,
enables up to three reverse listeners via setMaxReverseListeners(), and adds
several sample mappings:
globalSSHConfig.clearTunnelMappings();
globalSSHConfig.setMaxReverseListeners(3);
globalSSHConfig.addTunnelMapping("127.0.0.1", 22080, "192.168.1.100", 80);
globalSSHConfig.addTunnelMapping("127.0.0.1", 22081, "192.168.1.150", 5020);
globalSSHConfig.addTunnelMapping("127.0.0.1", 22082, "192.168.1.200", 22);If you prefer the original single-listener behaviour, set
#define ENABLE_MULTI_TUNNEL_DEMO 0 and the sketch will revert to
setTunnelConfig().
To illustrate the SSHTunnelEvents interface, the example registers a
handful of lightweight callbacks (registerTunnelCallbacks()), printing when
the SSH session connects/disconnects, when channels open/close (with reasons),
and on errors. Replace the logging lambdas with your own application logic
if you need deeper integration.
- Make sure the root library dependencies are installed (
pio pkg install, automatically handled in CI). - If you change the target board, update
examples/platformio.ini. - Use
globalSSHConfig.setDebugConfig(true, 115200);to increase log verbosity.