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

More build/install notes

Browse source
This commit is contained in:
Josh Deprez 2024-08-10 15:47:37 +10:00
parent 4dbf1b6f64
commit 8d04a405f5
1 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -51,17 +51,31 @@ TODO: explain the configuration file
Building and running: Building and running:
```shell 1. Install [Go](https://go.dev/dl).
sudo apt install libpcap-dev
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
```
2. Run these commands (for Debian-variety Linuxen, e.g. Ubuntu, Raspbian, Mint...):
```shell
sudo apt install git build-essential libpcap-dev
go install gitea.drjosh.dev/josh/jrouter@latest
sudo setcap 'CAP_NET_BIND_SERVICE=ep CAP_NET_RAW=ep' ~/go/bin/jrouter
```
3. Configure `jrouter.yaml`
4. To run:
```shell
~/go/bin/jrouter
```
Notes:
* `build-essential` is needed for `CGo`
* `libpcap-dev` and `CGo` is needed for [gopacket](https://github.com/google/gopacket)
* `NET_BIND_SERVICE` is needed to bind UDP port 387 (for talking between AIRs) * `NET_BIND_SERVICE` is needed to bind UDP port 387 (for talking between AIRs)
* `NET_RAW` is needed for EtherTalk * `NET_RAW` is needed for EtherTalk
TODO: instructions for non-Linux machines TODO: instructions for non-Linux / non-Debian-like machines
## Bug reports? Feature requests? Complaints? Praise? ## Bug reports? Feature requests? Complaints? Praise?