![ApFreeWiFiDog](https://github.com/liudf0716/apfree_wifidog/blob/master/logo.png) [![license][1]][2] [![PRs Welcome][3]][4] [![Issue Welcome][5]][6] [![Release Version][7]][8] [![OpenWRT][11]][12] [![KunTeng][13]][14] [1]: https://img.shields.io/badge/license-GPLV3-brightgreen.svg?style=plastic [2]: https://github.com/liudf0716/apfree_wifidog/blob/master/COPYING [3]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=plastic [4]: https://github.com/liudf0716/apfree_wifidog/pulls [5]: https://img.shields.io/badge/Issues-welcome-brightgreen.svg?style=plastic [6]: https://github.com/liudf0716/apfree_wifidog/issues/new [7]: https://img.shields.io/badge/release-2.05.1326-red.svg?style=plastic [8]: https://github.com/liudf0716/apfree_wifidog/releases [11]: https://img.shields.io/badge/Platform-%20OpenWRT%7C%20LEDE%20-brightgreen.svg?style=plastic [12]: https://github.com/KunTengRom/LEDE [13]: https://img.shields.io/badge/KunTeng-Inside-blue.svg?style=plastic [14]: http://rom.kunteng.org ## Apfree WiFiDog: Efficient captive portal solution Apfree-WiFidog is an open source captive protal solution for wireless router which with embeddabled linux([LEDE](https://github.com/lede-project/source)/[Openwrt](https://github.com/openwrt/openwrt)). **[中文介绍](https://github.com/liudf0716/apfree_wifidog/blob/master/README_ZH.md)** ## Features different between original wifidog and us It has some awesome features: * *Compatible with original wifodog 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. ---- ## How To Compile **[基于LEDE编译Apfree_wifidog](https://github.com/liudf0716/apfree_wifidog/wiki/%E5%9F%BA%E4%BA%8ELEDE%E7%BC%96%E8%AF%91Apfree_wifidog)** Fork and clone the Apfree WiFiDog project: git clone https://github.com/liudf0716/apfree_wifidog cd apfree_wifidog Assuming you have a working [LEDE](https://github.com/lede-project/source)/[Openwrt](https://github.com/openwrt/openwrt) setup, taking `LEDE` as an example and assuming your LEDE root path is `LEDE_ROOT`: cp -r package/apfree_wifidog/ /LEDE_ROOT/package/ To support `HTTPS`, you need install `libevent` with version 2.1.7 or latest in your LEDE environment, Or using the package copied in Apfree WiFiDog git project: cp -r package/libevent2/ /LEDE_ROOT/package/libs/ Now Apfree WiFiDog package has been installed in LEDE packages environment. cd /LEDE_ROOT/ make menuconfig Chose your `Target System` and `Network -->Captive Portals --> apfree_wifidog`. `SAVE` and `EXIT`. Do compiling: ``` make package/apfree_wifidog/compile V=s ``` After Doing `make package/apfree_wifidog/compile V=s`, Apfree WiFiDog `ipk` package is packed in path `bin/packages/YOUR-TARGET-ARCH/base/apfree_wifidog_VERSION-RELEASE_YOUR-TARGET-ARCH.ipk `. Push it up into your LEDE-system router, use `opkg install ` command to install this `ipk`. **The CA-Certificate in this project is ONLY for Apfree WiFiDog HTTPS captive testing, CAN NOT be used for business scene** -------- ## 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](https://github.com/liudf0716/apfree_wifidog/blob/master/AUTHSERVER.md)** ### Test document 1, [Apfree_WiFidog与原版wifidog性能对比报告](https://github.com/liudf0716/apfree_wifidog/blob/master/doc/Apfree_WiFidog%E4%B8%8E%E5%8E%9F%E7%89%88wifidog%E6%80%A7%E8%83%BD%E5%AF%B9%E6%AF%94%E6%8A%A5%E5%91%8A.md) 2, [apfree_wifidog性能测试报告](https://github.com/liudf0716/apfree_wifidog/blob/master/doc/apfree%20wifidog%E7%BA%BF%E7%A8%8B%E6%B1%A0%E4%B8%8D%E5%90%8C%E9%85%8D%E7%BD%AE%E6%80%A7%E8%83%BD%E6%B5%8B%E8%AF%95%E6%8A%A5%E5%91%8A.md) 3, [线程池和非线程池性能差别](https://github.com/liudf0716/apfree_wifidog/blob/master/doc/%E7%BA%BF%E7%A8%8B%E6%B1%A0%E5%92%8C%E9%9D%9E%E7%BA%BF%E7%A8%8B%E6%B1%A0%E6%80%A7%E8%83%BD%E5%B7%AE%E5%88%AB.md) 4, [阈值调整测试技巧报告](https://github.com/liudf0716/apfree_wifidog/blob/master/doc/%E9%98%88%E5%80%BC%E8%B0%83%E6%95%B4%E6%B5%8B%E8%AF%95%E6%8A%80%E5%B7%A7%E6%8A%A5%E5%91%8A.md) ### How To Contribute Feel free to create issues or pull-requests if you have any problems. **Please read [CONTRIBUTING.md](https://github.com/liudf0716/apfree_wifidog/blob/master/CONTRIBUTING.md) before pushing any changes.** ### apfree wifidog qq group： [331230369](https://jq.qq.com/?_wv=1027&k=4ADDSev) ---