Quickstart

1. Download device setup tool

This tool is used to configure the physical ESP32 DeadLetter device with the correct Backend and Registry gateway addresses over USB.

macOS

curl http://YOUR_VPS_IP/dist/deadletter-setup-mac -o deadletter-setup
chmod +x deadletter-setup
sudo mv deadletter-setup /usr/local/bin/deadletter-setup

Linux

curl http://YOUR_VPS_IP/dist/deadletter-setup-linux -o deadletter-setup
chmod +x deadletter-setup
sudo mv deadletter-setup /usr/local/bin/deadletter-setup

Windows (PowerShell)

curl http://YOUR_VPS_IP/dist/deadletter-setup-windows.exe -OutFile deadletter-setup.exe

Run from the same directory:

.\deadletter-setup.exe --help

2. Verify checksum

Always verify the downloaded binary before running it.

Download checksums:

curl http://YOUR_VPS_IP/dist/SHA256SUMS.txt -o SHA256SUMS.txt

Verify:

sha256sum -c SHA256SUMS.txt 2>/dev/null | grep deadletter-setup

On macOS if sha256sum is missing:

shasum -a 256 deadletter-setup

Compare the hash with the value inside SHA256SUMS.txt.

3. Configure the ESP32 device

Plug in your DeadLetter ESP32 over USB and run:

deadletter-setup --registry REGISTRY_IP:8081 --backend BACKEND_IP:8080

This permanently stores the gateway addresses inside the device.