Update README How to use
This commit is contained in:
parent
6b8ed2f807
commit
5f5e888a4f
1 changed files with 18 additions and 1 deletions
19
README.md
19
README.md
|
@ -12,4 +12,21 @@ TashTalk could be a stretch goal, if I can acquire one!
|
||||||
|
|
||||||
## How to use
|
## 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
|
||||||
|
|
Loading…
Reference in a new issue