OpenWrt/apfree_wifidog
1
0
Fork 0
mirror of https://github.com/liudf0716/apfree_wifidog.git synced 2025-01-09 04:19:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

add usage example of apfree wifidog in README.md

Browse Source
This commit is contained in:
KerwinKoo 2016-12-20 17:06:40 +08:00
parent f875360d6d
commit 212958d92d
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -56,5 +56,47 @@ After Doing `make V=s`, Apfree WiFiDog `ipk` package is packed in path `bin/pack
**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 '0'
option trusted_domains 'www.baidu.com,www.qq.com,www.qq.com.cn,www.weixin.com'
```
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.
-----
## Usage examples