josh/jrouter
josh/jrouter
1
0
Fork 0
Code Issues 10 Pull requests Releases Activity

Update README How to use

Browse source
This commit is contained in:
Josh Deprez 2024-04-15 11:38:30 +10:00
parent 6b8ed2f807
commit 5f5e888a4f
Signed by: josh
SSH key fingerprint: SHA256:zZji7w1Ilh2RuUpbQcqkLPrqmRwpiCSycbF2EfKm6Kw
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -12,4 +12,21 @@ TashTalk could be a stretch goal, if I can acquire one!
## How to use
It's not ready yet. Come back later.
WARNING: It Barely Works™
First, set up a `jrouter.yaml` (use the one in this repo as an example).
TODO: explain the configuration file
Building and running:
```shell
go install gitea.drjosh.dev/josh/jrouter@latest
sudo setcap 'CAP_NET_BIND_SERVICE=ep CAP_NET_RAW=ep' ~/go/bin/jrouter
~/go/bin/jrouter
```
* `NET_BIND_SERVICE` is needed to bind UDP port 387 (for talking between AIRs)
* `NET_RAW` is needed for EtherTalk
TODO: instructions for non-Linux machines