Apfree WiFiDog: Efficient captive portal solution

Apfree-WiFidog is an open source captive portal solution for wireless router which with embeddable Linux(LEDE/Openwrt).

中文介绍

Features different between original wifidog and us

It has some awesome features:

• Compatible with original wifidog protocol. You can seamless migration Apfree WiFidog to connect your auth server if you runned traditional wifidog.

• HTTPS support. Not only HTTP, Apfree WiFiDog can capture HTTPS URL request. It's a big deference between traditional WiFiDog.

• Efficient performance. Run shell command time curl --compressed to test the Apfree WiFiDog reaction rate, HTTP response time is 0.05s and HTTPS is about 0.2s.

• Dynamical bulk loading. Support MAC address and IP address bulk loading with out restart Apfree WiFiDog.

• Wide application of business. Apfree WiFidog has been installed and used in tens of thousands routers from KunTeng.Org and partners. Users have been affirmed, fully embodies the applicability, reliability.

---

Added to Openwrt&LEDE

Please go to package_apfree_wifidog

---

Getting started

After compiling and installing Apfree WiFiDog into your local router, run the ps | grep wifidog command. The ps | grep wifidog command queries the Linux system for information about Apfree WiFiDog.

root@lede:~# ps | grep wifidog
 1406 root      6532 S    /usr/bin/wifidog -c /tmp/wifidog.conf -f -d 0

In this example, we can see Apfree WiFiDog has run automatically. This command shows some useful information:

• /usr/bin/wifidog is the executable binary daemon program, it's named wifidog for compatible.
• /tmp/wifidog.conf is the WiFiDog's configuration file that generated by parsing /etc/config/wifidog. The UCI format file /etc/config/wifidog is the main configuration file for user, and it will be used by Apfree WiFidog to generate wifidog reader file /tmp/wifidog.conf.
• Using operations of -c -f -d for default parameters, and you can get their by running command wifidog --help.

The default UCI configuration file like this:

config wifidog
        option gateway_interface 'br-lan'
        option auth_server_hostname 'entrance.yourauth.org'
        option auth_server_port '80'
        option auth_server_path '/wifidog/'
        option check_interval '60'
        option client_timeout '72000'
        option httpd_max_conn '200'
        option pool_mode '1'
        option thread_number '5'
        option queue_size '20'
        option wired_passed '1'
        option trusted_domains 'www.baidu.com,www.qq.com,www.qq.com.cn,www.weixin.com'

wired_passed means whether LAN access devices need to auth or not, value 1 means no need to auth

Domains of www.baidu.com,www.qq.com,www.qq.com.cn,www.weixin.com is trusted in this default configuration file, and you can modify it to what you want.

Apfree wifidog Auth server open source project

Please read AUTHSERVER.md

Test document

1, Apfree_WiFidog与原版wifidog性能对比报告

2, apfree_wifidog性能测试报告

3, 线程池和非线程池性能差别

4, 阈值调整测试技巧报告

How To Contribute

Feel free to create issues or pull-requests if you have any problems.

Please read CONTRIBUTING.md before pushing any changes.

apfree wifidog qq group： 331230369

---