- Introduction to x86routertools
- Using the command line tools
- Using the daemon
- System requirements
- Installation
- Configuration options
- Scripts and examples
A command line toolkit written in Bash that aims to turn a regular computer running GNU/Linux into a wireless router or access point (AP), whilst managing things like system services, alerts, system LEDs and making sure the network is always up via watchdog daemons.**
Some features:
- Managing wireless APs, with per-AP configuration and simple masquerading/fowarding rules.
- Watching the internet-facing interface's connectivity and taking action when needed.
- Logging network status and sending alerts as notification/console/LED.
- Restarting a service 'stack' on network initialization.
- Managing queue disciplines with CAKE SQM and pre-defined categories.
- Managing ath9k Wi-Fi cards' special features, like digital predistortion and ack timeout estimation.
- Manage generic Wi-Fi AP features, like power saving, retransmission, regulatory domains and transmit power.
- Optimize the network stack, for example, toggling on BBRv2/v1 if present.
- Offer command line tools for wireless AP management and debugging.
x86routertools comes with many verbs that can be used to get information on the system.
For example, you can check what MCS rates your client is using on the connection, to measure the quality of the service it is getting:
- Get the MAC address of the device by looking at the list of connected devices:
- -
$ routertools ls - Then, you can pull up the real-time rate display with the AP's interface name:
- -
$ routertools display-rates wlan0 aa:bb:cc:dd:ee:ff
You can also toggle many runtime options of a wireless interface. For example, to turn on LNA mixing on ath9k cards (the daemon can do this for you, too):
- -
# routertools lnamix-on wlan0 - Or, to set it on all APs on the system:
- -
# routertools lnamix-on
Calling routertools --help should be enough to get you a full, descriptive list of commands.
The x86routertools daemon has two instances, Wi-Fi and internet, which are independent from each other.
Their function is to watch the system-wide SQM/qdisc configuration, and watch the AP interfaces and the internet-facing interface respectively. How they work and what they do is extensively configurable via files in /etc/routertools.d/.
The most important of them, containing the most options, is arguably x86routertools.conf.
To start the internet daemon, you can use:
sudo systemctl start routertoolsd-inet
To start the wireless AP daemon:
sudo systemctl start routertoolsd-wifi@wlan0
Where, of course, wlan0 is the name of one interface you configured in /etc/routertools.d/wifi-access-points.
The daemons will regularly output their status to the system log, send notifications, or make a light blink somewhere.
- Access point-capable Wi-Fi card (ath9k is preferred but optional)
- systemd
- netstat
- iw
- ifconfig
- iptables
- hostapd
Incompatible:
- NetworkManager
Optional:
- wget, for grabbing hostapd configuration reference.
- haveged or rngd, without, WPA/WEP performance may suffer
- A firewall like ufw, shorewall or firewalld. x86routertools will not block any vulnerable ports for you!
- A DHCP server like Pi-hole or dnsmasq, otherwise your clients will not be able to use DHCP. x86routertools will not configure DNS for you!
x86routertools is normally installed to /usr/bin. Other necessary directories like in /etc will be populated by the program on first run.
- Clone the repository somewhere:
- -
$ git clone https://github.com/yagoplx/x86routertools.git - -
$ cd x86routertools - Run make install:
- -
# make install
You may also want to run a systemctl daemon-reload if you want to try out the daemon right away.
Configuration is well documented and required, check the new files at /etc/routertools.d for examples and info.
For example, to register a new wireless interface with x86routertools, you will want to set up them at /etc/routertools.d/wifi-access-points.
Each wireless interface should have two files in there: a interface.conf, and a interface_hostapd.conf.
Example files with all possible options documented are provided for you to copy/rename.
As for the internet facing interface, you should set up scripts to set them up and down at /etc/routertools.d/scripts.
The default is to just call the Arch Linux pppoe-start and pppoe-stop commands for PPPoE, in this case the internet interface is ppp0.
The daemon will call the stop script when it restarts the interface, and then the start script. The command line tools also can use these scripts as well.
If necessary, you should include configuration for other interfaces on the start script, for example, making a 6to4 tunnel or a bridge interface, setting addresses/routes for them via ip/iptables, etc.
In the scripts folder you can also add start-interfacename/stop-interfacename files for your access point interfaces.
This is useful for additional routing/address work if the included functionality in x86routertools isn't enough (eg. IPv6).
You can have the daemon start on boot for the standard wifi router experience:
- -
# systemctl enable routertoolsd-inet - -
# systemctl enable routertoolsd-wifi@interface_name
Configuration is system-wide and is done via files in /etc/routertools.d