README.md

Spear

• VPN Proxy
• Simplest
• Filter App
• Total Free
• Open Source
• Mobile Client

Platforms

Server

• Ubuntu

Client

• Android
• IOS - Developing
• Harmony - Wait for OS Function, use Android Client for backup

Client Proxy Token

Client side Proxy Token to Connect your server.
Authentication system is under development, so pleases note there is no security for auth yet.
Your Proxy Token should be {IP}:22333.
e.g. if your server ip is 10.87.225.96, your token is 10.87.225.96:22333.

Guide - Setup Ubuntu Server

• Setup Network Firewall 22333-22589 Ports inbound TCP & UDP open
• Download _deploy.sh and spear_server in Latest Release
• Make sure they are in same folder on your Ubuntu Server
• Run _deploy.sh using Root Privilege

Done! If you need customize configuration, refer to Config Ubuntu Server
If you need to Re-Deploy server, please kill old process mannually firstly.
ps aux | spear to get spear process and kill -9 {Spear-Server-Process-Id}

Guide - Install Android Client

• Download spear.apk in Latest Release
• Install spear.apk in your Android Device
• Add Android Widget to quickly toggle VPN

android_widget_guide.mp4

Guide - Install iOS Client

• TBD

Advance - Config Ubuntu Server

In _deploy.sh there are several server configurable parameters.
-p 22333 -d 8.8.8.8 -f 22334 -m 256 in _deploy.sh

• -p 22333 is server communication port with all clients
• -d 8.8.8.8 is VPN DNS server ip
• -f 22334 is packet transport port range start
• -m 256 is maximum support client number

Clients will connect server port range is 22334 to 22334 + 256 - 1 = 22589, so Server's ports in this scope need to open.

About

Spear will keep simple.
It is made by personal usage, so only necessary function will be retained.
Even there are many VPN choices in the market,
But I cannot get a perfect one.
Simplest, quickly access, application filter.
This is Spear.