Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lexrus/vpnon
Turn On your VPN like a hero.
https://github.com/lexrus/vpnon
Last synced: about 1 month ago
JSON representation
Turn On your VPN like a hero.
- Host: GitHub
- URL: https://github.com/lexrus/vpnon
- Owner: lexrus
- License: other
- Archived: true
- Created: 2014-12-16T10:05:13.000Z (almost 10 years ago)
- Default Branch: develop
- Last Pushed: 2020-03-15T07:23:04.000Z (over 4 years ago)
- Last Synced: 2024-09-25T22:02:30.788Z (about 1 month ago)
- Language: Swift
- Homepage: https://itunes.apple.com/app/vpn-on/id951344279
- Size: 80.1 MB
- Stars: 4,480
- Watchers: 182
- Forks: 940
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-network-stuff - **4049**星
README
# VPN On
[](https://travis-ci.org/lexrus/VPNOn)
[
](https://itunes.apple.com/app/vpn-on/id951344279)
Turning on a VPN is always a painful experience on an iOS device due to the deep nested menus. This App installs a Today Widget into Notification Center which make it possible to turn on a VPN in about 3 seconds(depends on the connection speed). Furthermore, by turning on On Demand feature, the VPN could be automatically connected when you visit any domain specified in this App.
## Requirements
- An iPhone/iPad running iOS 10.3+
- An IPSec IKEv1 / IKEv2 VPN(create yours with [my Ansible Playbook](https://github.com/lexrus/vpn-deploy-playbook) or [deploy on DigitalOcean](http://installer.71m.us/install?url=https://github.com/lexrus/do-ikev1))
- Xcode 10.3+
- An Apple iOS develop account
- A [MaxMind account](https://www.maxmind.com) for GeoIP resolving
- [Carthage](https://github.com/carthage/carthage)
## Build with Xcode
To compile the project, you may temporarily modify the `bundle_id` after adding yours into the Apple Developer Center. And then activate the following capabilities of the container App and the Today extension:
1. Personal VPN
2. Keychain Sharing
3. App Groups
Meanwhile, provisioning profiles are required for testing on iPhone/iPad.
## Usage
Once you add a VPN configuration you can activate the Today Widget in Notification Center, then turn on the VPN by tapping a switch or flag. You may be asked to allow the installation of a VPN profile for the first time.
## Contribution
Issues and roadmap are [listed here](https://github.com/lexrus/VPNOn/issues).
This project follows the [gitflow](https://github.com/nvie/gitflow) workflow. You'd better create a branch called `feature/sth_improved` before any major improvements. Meanwhile minor bug fixes are welcomed in the develop branch.
## Localization
Please contribute to [the Transifex project](https://www.transifex.com/lexrus/vpnon/).
## URL Schemes
### Add configuration
VPN service providers may list a link for their customers to efficiently add server configurations in VPN On. By register the `vpnon://` protocol, it supports the following URL scheme:
`vpnon://{account}:{password}@{server}/?title={title}&group={group}&secret={secret}&alwayson=[yes|no]&ikev2=[yes|no]`
`server` and `title` are required, other fields are optional. The following URLs are valid:
* `vpnon://jony:[email protected]/?title=Apple&group=Design&secret=iPhone`
* `vpnon://apple.com/?title=Apple`
* `vpnon://[email protected]/?title=Google&group=devops`
* `vpnon://[email protected]/?title=Yahoo&alwayson=no`
* `vpnon://jony:[email protected]/?title=Twitter&ikev2=yes`
* `vpnon://jony:[email protected]/?title=Twitter&ikev2=yes&remoteid=jetblack`
### Establish connection
* `vpnon://VPNTitle/?connect`
* `vpnon://VPNTitle/?connect&callback=https://twitter.com`
### Disconnect
* `vpnon://disconnect/`
## Credits
* Arabic(Saudi Arabia) - [Mohsen Qaysi](https://github.com/Mohsenqaysi)
* Japanese translation - [Onevcat](https://github.com/onevcat)
* Polish translation - [Seb Kaczorowski](http://photographyservices.ie)
* Turkish - Ozancan Karataş
* Dutch (Netherlands) translation - [Niels Peen](https://github.com/nielspeen)
This product includes [GeoLite2 data](http://dev.maxmind.com/geoip/geoip2/geolite2/) created by MaxMind, available from [http://www.maxmind.com](http://www.maxmind.com).
The GeoLite2 databases are distributed under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/).
In order to query the database, I created a wrapper for [libmaxminddb](https://github.com/maxmind/libmaxminddb) called [MMDB-Swift](https://github.com/lexrus/MMDB-Swift).
## License
This code is distributed under the terms and conditions of the MIT license.
```
Copyright (C) 2020 lexrus.com
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```