summaryrefslogtreecommitdiff
path: root/fw/sim/srv/README.md
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2025-08-10 15:58:49 +0200
committerxengineering <me@xengineering.eu>2025-08-10 15:58:49 +0200
commitc931e04f7ecf18645d114144e5663e633cfd1a78 (patch)
tree05732b0e529a45997d49db53635cfd223f4f1a12 /fw/sim/srv/README.md
parent17c334ada43ee5eabd14caabacbe393fe3482451 (diff)
downloadiot-contact-c931e04f7ecf18645d114144e5663e633cfd1a78.tar
iot-contact-c931e04f7ecf18645d114144e5663e633cfd1a78.tar.zst
iot-contact-c931e04f7ecf18645d114144e5663e633cfd1a78.zip
fw: sim: srv: Add this folder
This folder contains material to set up a network environment for the native sim firmware.
Diffstat (limited to 'fw/sim/srv/README.md')
-rw-r--r--fw/sim/srv/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/fw/sim/srv/README.md b/fw/sim/srv/README.md
new file mode 100644
index 0000000..455800f
--- /dev/null
+++ b/fw/sim/srv/README.md
@@ -0,0 +1,17 @@
+# Network setup for native sim firmware
+
+This folder contains documentation to provide a network setup suitable to run
+the native sim build of the firmware.
+
+It assumes a Linux host, an executable file with the native sim firmware,
+`systemd-networkd` as network configuration solution and `ufw` as firewall.
+
+For network configuration the `zeth.netdev` and `zeth.network` files from this
+folder have to be used with `systemd-networkd`.
+
+The following is required to open the firewall for the firmware on the `zeth`
+virtual network interface created by `systemd-networkd`:
+
+```
+ufw allow in on zeth to any port 1883 proto tcp
+```