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

Update README

Browse source
This commit is contained in:
Josh Deprez 2024-04-27 21:45:45 +10:00
parent 94f375f256
commit da4c729912
Signed by: josh
SSH key fingerprint: SHA256:zZji7w1Ilh2RuUpbQcqkLPrqmRwpiCSycbF2EfKm6Kw
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -7,6 +7,7 @@ Home-grown alternative implementation of Apple Internet Router 3.0
* Full compatibility with Apple Internet Router 3.0 * Full compatibility with Apple Internet Router 3.0
* Function on modern operating systems * Function on modern operating systems
* EtherTalk support * EtherTalk support
* Be observable (there's a HTTP server with a `/status` page)
TashTalk could be a stretch goal, if I can acquire one! TashTalk could be a stretch goal, if I can acquire one!
@ -21,16 +22,14 @@ Things I plan to fix Real Soon Now:
You can now configure a different Ethernet address for the EtherTalk You can now configure a different Ethernet address for the EtherTalk
interface. I haven't tested it with netatalk or tashrouter on the same interface. I haven't tested it with netatalk or tashrouter on the same
host, but I think using a distinct Ethernet address would help them coexist. host, but I think using a distinct Ethernet address would help them coexist.
* It doesn't do any of the required packet splitting to keep packets under the * It currently ignores other AppleTalk routers on the EtherTalk side. This is
AppleTalk size limits. ~~In particular ZIP GetZoneList Replies are incorrect the next main thing to implement to make it work with e.g. netatalk.
when the zone list would exceed the limit.~~ GetZoneList is now fixed, but * Some packet types need splitting to fit within limits. Some of these aren't
various others need fixing. implemented yet (mainly encapsulated).
* It logs a lot and has no other monitoring or observability capability. I plan * I plan to add a Prometheus metrics endpoint and at least add log levels /
to add a Prometheus metrics endpoint and at least add log levels / verbosity verbosity config.
flag. * The AURP implementation is mostly there, but not fully complete. The main
* The AURP implementation is strictly incomplete, and lost connections with thing missing is sequence number checking.
configured peers aren't re-established after some backoff. This won't be too
difficult.
Things I plan to fix At Some Point: Things I plan to fix At Some Point:
@ -40,7 +39,7 @@ Things I plan to fix At Some Point:
## How to use ## How to use
WARNING: It Barely Works™ WARNING: It Sorta Works™
First, set up a `jrouter.yaml` (use the one in this repo as an example). First, set up a `jrouter.yaml` (use the one in this repo as an example).