README.md revision e2e38f71 
1## OAF(Open App Filter)  
2OAF is a parental control plug-in based on OpenWrt, which supports app filtering for games, videos, chats, downloads, such as Tiktok, Youtube, Telegram,etc.,and support self-defined app rules, you can lean more and download firmware by visiting [www.openappfilter.com](http://www.openappfilter.com) .
3### Preparation
4- Prepare a router that supports openwrt  
5There are already many routers that support the openwrt system, you can choose a simple one for installation,[See which devices support](https://openwrt.org).  
6- Install the openwrt system on your router  
7The openwrt install tutorial can be found through the [forum](https://forum.openwrt.org).  
8### How to compile OAF  
91. Prepare OpenWrt source or SDK and compile successfully   
10#### general steps  
11```
12   git clone https://github.com/openwrt/openwrt
13   cd openwrt
14   ./scripts/feeds update -a
15   ./scripts/feeds install -a
16   make defconfig
17   make V=s
18```   
192. Download OAF source code  
20git clone https://github.com/destan19/OpenAppFilter.git package/OpenAppFilter    
213. Open the compile configuration   
22```
23     echo luci-app-oaf >>.config  
24     make defconfig  
25```
264. Begin compile  
27- Compile OAF separately  
28```
29     make package/luci-app-oaf/compile V=s  
30```
31- Compile the entire firmware  
32```
33     make V=s  
34```
35### How to install OAF  
36If you can't compile it yourself, you can install it directly into the released OpenWrt version  
371. Install an officially released version of openwrt  
38Note that it must be the official release version,may cause failure if other versions are used, because OAF depend on the kernel version.  
39It is best to download through the following official address  
40https://downloads.openwrt.org/releases   
412. Download OAF zip file  
42Find the corresponding OAF zip file on the release page and download it, note that the plug-in version and the system version must be consistent.  
433. Install OAF ipks  
44Unzip thie OAF package and then install ipks in order  
45- kmod-oaf  
46- appfilter   
47- luci-compat(if the luci version is 2.0, openwrt 19.07+)   
48- luci-app-oaf    
49- luci-i18n-oaf-zh-cn(Chinese Language Pack, optional)  
50
51### Notice
52If there is no version you need, you need to compile and generate it yourself, and I will release more architecture ipks later.
53
54
55