mirror of
				https://github.com/Ysurac/openmptcprouter.git
				synced 2025-03-09 15:40:20 +00:00 
			
		
		
		
	Update before OpenMPTCProuter release
This commit is contained in:
		
							parent
							
								
									c3948de177
								
							
						
					
					
						commit
						40c3e6056e
					
				
					 2 changed files with 58 additions and 3 deletions
				
			
		
							
								
								
									
										57
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										57
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,57 @@
 | 
				
			||||||
 | 
					# OpenMPTCProuter
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					OpenMPTCProuter is an open source solution to aggregate and encrypt multiple internet connections and terminates it over any VPS which make clients benefit security, reliability, net neutrality, as well as dedicated public IP.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The aggregation is based on MPTCP, which is ISP, WAN type, and latency independent "whether it was Fiber, VDSL, SHDSL, ADSL or even 4G", different scenarios can be configured to have either aggregation or failover based on MPTCP.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The solution takes advantage of the OpenWRT/LEDE system, which is user friendly and also adds the possibility of installing other packages like VPN, QoS, routing protocols, monitoring, etc. through web-interface or terminal.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Install from pre-compiled images
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Soon
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Install from source
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Dependencies
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You need a classical build environment like `build-essential` on Debian and `git`.
 | 
				
			||||||
 | 
					Some feeds might not available over `git` but only via `subversion` or `mercurial`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					On Debian you'll need to install the following:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```sh
 | 
				
			||||||
 | 
					sudo apt install build-essential git unzip ncurses-dev libz-dev libssl-dev
 | 
				
			||||||
 | 
					  python subversion gettext gawk wget curl rsync perl
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Prepare and build
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```sh
 | 
				
			||||||
 | 
					git clone https://github.com/ysurac/openmptcprouter.git
 | 
				
			||||||
 | 
					cd openmptcprouter
 | 
				
			||||||
 | 
					./build.sh
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The script `build.sh` accepts all `make` arguments (like `-j`).
 | 
				
			||||||
 | 
					When finished, files are located in the directory `source/bin`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Custom arch build
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					By default the build script will create the packages for the `x86_64` architecture.
 | 
				
			||||||
 | 
					You can specify a custom build target by adding a `OMR_TARGET` environment variable to the build and the corresponding `config-$OMR_TARGET` file.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To build the project for the raspberry pi 3:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```sh
 | 
				
			||||||
 | 
					OMR_TARGET="rpi3" ./build.sh
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Credits
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Our solution is mainly based on:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					* [OverTheBox](https://www.ovhtelecom.fr/overthebox/)
 | 
				
			||||||
 | 
					* [OpenWRT](https://openwrt.org)
 | 
				
			||||||
 | 
					* [LEDE](https://lede-project.org)
 | 
				
			||||||
 | 
					* [MultiPath TCP (MPTCP)](https://multipath-tcp.org)
 | 
				
			||||||
 | 
					* [Shadowsocks](https://shadowsocks.org)
 | 
				
			||||||
							
								
								
									
										4
									
								
								build.sh
									
										
									
									
									
								
							
							
						
						
									
										4
									
								
								build.sh
									
										
									
									
									
								
							| 
						 | 
					@ -29,7 +29,7 @@ if [ ! -f "$OMR_TARGET_CONFIG" ]; then
 | 
				
			||||||
	exit 1
 | 
						exit 1
 | 
				
			||||||
fi
 | 
					fi
 | 
				
			||||||
 | 
					
 | 
				
			||||||
_get_repo source https://github.com/ovh/overthebox-lede "otb-master-17.11.03"
 | 
					_get_repo source https://github.com/ysurac/openmptcprouter "master"
 | 
				
			||||||
_get_repo feeds/packages https://github.com/openwrt/packages "master"
 | 
					_get_repo feeds/packages https://github.com/openwrt/packages "master"
 | 
				
			||||||
_get_repo feeds/luci https://github.com/openwrt/luci "for-15.05"
 | 
					_get_repo feeds/luci https://github.com/openwrt/luci "for-15.05"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -59,8 +59,6 @@ EOF
 | 
				
			||||||
cat > source/feeds.conf <<EOF
 | 
					cat > source/feeds.conf <<EOF
 | 
				
			||||||
src-link packages $(readlink -f feeds/packages)
 | 
					src-link packages $(readlink -f feeds/packages)
 | 
				
			||||||
src-link luci $(readlink -f feeds/luci)
 | 
					src-link luci $(readlink -f feeds/luci)
 | 
				
			||||||
src-git routing https://git.lede-project.org/feed/routing.git
 | 
					 | 
				
			||||||
src-git management https://github.com/openwrt-management/packages.git
 | 
					 | 
				
			||||||
src-link openmptcprouter $(readlink -f "$OMR_FEED")
 | 
					src-link openmptcprouter $(readlink -f "$OMR_FEED")
 | 
				
			||||||
EOF
 | 
					EOF
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue