docs(erlite3): project init.

README.md

@@ -1 +1,53 @@
-# shadowsocks_erlite3
+# shadowsocks_erlite3
+
+shadowsocks for EdgeRouter Lite3
+
+本项目修改自shadowsocks_erx, 只是把用到的工具重新编译了了一份mips。  
+
+# 缺少的依赖可以从下面安装
+在 https://packages.debian.org/zh-cn/ 这个界面搜索以下包  
+安装  
+sudo dpkg -i apg_2.2.3.dfsg.1-2_mipsel.deb  
+sudo dpkg -i pwgen_2.07-1_mipsel.deb  
+sudo dpkg -i libc6_2.19-18+deb8u7_mipsel.deb  
+sudo dpkg -i libev4_4.15-3_mipsel.deb  
+sudo dpkg -i libmbedcrypto0_2.4.0-1-bpo8+1_mipsel.deb  
+sudo dpkg -i libpcre3_8.35-3.3+deb8u4_mipsel.deb  
+sudo dpkg -i libsodium18_1.0.11-1-bpo8+1_mipsel.deb  
+sudo dpkg -i libudns0_0.4-1_mipsel.deb  
+sudo dpkg -i shadowsocks-libev_3.0.5-1_mipsel.deb
+
+
+安装:
+1.下载shadowsocks_erlite3-master.zip并解压  
+2.用winscp把解压的所有文件copy到/tmp目录  
+3.连接路由CLI命令界面并登陆，然后执行:   
+cd /tmp  
+sudo bash install.sh  
+4.根据提示输入shadowsocks配置信息，一般只需要输入服务器地址、端口、密码，其它选项可以直接回车使用默认选项。  
+
+注意:
+1.国内外流量自动分流，通过ipset对国内IP进行白名单，国内IP不会翻墙访问，只有国外流量会走shadowsocks通道翻墙   
+2.只能对TCP流量翻墙  
+3.国外网站DNS经shadowsocks服务器中转使用TCP访问8.8.8.8，防止污染，国内域名使用国内DNS解析，不会影响CDN访问  
+4.1080端口可以作为socks5翻墙代理使用  
+5.文件存放在/config目录是因为这个目录备份配置的时候会被一起备份，并且系统升级也不会删除  
+6.shadowsocks-libev版本:v3.1.0, chinadns版本:v1.3.2(修改版)，pdnsd版本:v1.2.9  
+7.EdgeRouter X EdgeOS v1.8.5,v1.9.0测试通过  
+8.如果想暂停shadowsocks，运行sudo /etc/init.d/shadowsocks stop  
+9.重新启动就运行sudo /etc/init.d/shadowsocks start  
+10.运行sudo crontab -e，并在文件末尾添加以下内容，就可以实现每隔5分钟检测ss状态，如果不能翻墙就自动重启服务：  
+*/5 * * * * sh /config/shadowsocks/bin/ss-monitor.sh  
+
+PT下载用户请注意，如果你有独立的下载机，可以设置让下载机不走SS。具体操作如下：  
+ss启动脚本/etc/init.d/shadowsocks里面有下面一行:  
+#BYPASS_RANGE=192.168.123.0/24  
+去掉注释(删掉#号)重启服务就可以生效，然后192.168.123.0/24这整个网段都不会走ss通道了，同时也无法翻墙了，192.168.123.0/24也可以换成单独IP或者其它网段。  
+
+DNS解析过程  
+chinadns    必须配置至少一个国内DNS，一个国外DNS  
+dnsmasq  ->    chinadns    (国外IP)->    pdnsd   -> ss-server -> dns-server:ok  
+			   (国内IP)->    114.114.114.114:ok  
+
+chinadns作者很久没有更新过了，但是有几个bug，会导致有些同时有国内国外CDN的域名解析出国外的IP，本方案使用的chinadns我修复了这个bug并优化了部分情况下的解析速度。  
+ss翻墙方案目前最容易出问题的就是DNS防污染，最近的几次更新几乎都是针对DNS，到目前版本终于让我比较满意了。  

config/shadowsocks/bin/ss-monitor.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+LOGTIME=$(date "+%Y-%m-%d %H:%M:%S")
+LOGFILE=/var/log/shadowsocks_monitor.log
+COUNT=`wc -l $LOGFILE|awk '{print $1}'`
+#clear log if to many logs
+if [ $COUNT -gt 1000 ]; then
+        echo '' > $LOGFILE
+fi
+
+#check if shadowsocks ok
+curl --retry 1 --silent --connect-timeout 3 -I www.google.com > /dev/null
+if [ "$?" == "0" ]; then
+	echo '['$LOGTIME'] No Problem.' >> $LOGFILE
+	exit 0
+else
+	curl --retry 1 --silent --connect-timeout 3 -I www.baidu.com  > /dev/null
+	if [ "$?" == "0" ]; then
+		echo '['$LOGTIME'] Problem decteted, restarting shadowsocks.'  >> $LOGFILE
+		/etc/init.d/shadowsocks restart
+	else
+		echo '['$LOGTIME'] Network Problem. Do nothing.'  >> $LOGFILE
+	fi
+fi