Commit cb787e0c authored by Thomas Markiewicz's avatar Thomas Markiewicz

Updated README and CHANGES

parent 646aabe4
Pipeline #9250 passed with stage
in 2 minutes and 52 seconds
......@@ -12,4 +12,5 @@ Version 0.1.1 released to App Store on 2019-04-17
Version 0.1.0 released to App Store on 2019-04-10
-------------------------------------------------
* Initial release
* Forked PIA VPN for iOS v2.8.1
[![PIA logo][pia-image]][pia-url]
# Librem Tunnel
# Private Internet Access
Librem Tunnel iOS app is a fork of [PIA VPN for iOS](https://github.com/pia-foss/vpn-ios) customized for [Librem One](https://librem.one) services.
Private Internet Access is the world's leading consumer VPN service. At Private Internet Access we believe in unfettered access for all, and as a firm supporter of the open source ecosystem we have made the decision to open source our VPN clients. For more information about the PIA service, please visit our website [privateinternetaccess.com][pia-url] or check out the [Wiki][pia-wiki].
## Features
* Protect your privacy with secure connection to a VPN tunnel
* Encrypt your network traffic
* Enable optional Safari Content Blocker to stop ads and trackers while browsing with Safari
* High speeds, unlimited bandwidth, up to 5 devices
# PIA VPN for iOS
With the Private Internet Access VPN app for iOS, you can access our network of VPN servers across the world from your iPhone, iPad or iPod touch (64-bit only). Choose among many available countries and connect to them easily. Features include kill switch, multiple VPN protocols, DNS/IPv6 leak protection and Safari Content Blocker for ad-blocking while browsing with Safari.
## Branch setup
* `master` represents the latest release that is currently in the Apple App Store
* `develop` represents the bleeding edge; send your PR's to this branch
* `release/*` represents branches in bug fix cycle with no new features allowed
* `issue/#_*` represets a specific issue being worked on
## Getting started
### [CHANGES](https://source.puri.sm/liberty/tunnel/ios/blob/master/CHANGES.md)
The PIA VPN app features:
- [x] Plenty of countries to connect to (28 as of today)
- [x] Kill switch
- [x] Multiple VPN protocols
- [x] Fine-grained VPN settings
- [x] DNS leak protection
- [x] IPv6 leak protection
- [x] Safari Content Blocker
- [x] Dark theme
- [x] Hotspot Helper
## Installation
### Requirements
- iOS 9.0+ / macOS 10.11+
- Xcode 9+ (Swift 4)
- Git (preinstalled with Xcode Command Line Tools)
- Ruby (preinstalled with macOS)
- [CocoaPods 1.5.0][dep-cocoapods]
- [SwiftGen][dep-swiftgen]
It's highly recommended to use the Git and Ruby packages provided by [Homebrew][dep-brew].
### Building
Xcode7 must be used for pulling down pods in order to support older iOS 9.0:
- Download latest version of Xcode 7 from Apple
- Install Xcode 7 in Applications/xcode7
- `sudo xcode-select -switch /Applications/xcode7/Xcode.app/Contents/Developer`
- Clean all the pod cache from the computer
- `pod install` ... etc
- `sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer`
### Testing
Download the app codebase locally:
$ git clone https://github.com/pia-foss/vpn-ios.git
Assuming you have a [working CocoaPods environment][dep-cocoapods], setting up the app workspace only requires installing the pod dependencies:
$ pod install
After that, open `PIA VPN.xcworkspace` in Xcode and run the `PIA VPN` target.
For the VPN to work properly, the app requires:
- _App Groups_ and _Keychain Sharing_ capabilities
- App IDs with _Packet Tunnel_ entitlements
both in the main app and the tunnel extension target.
### Hotspot Helper API
We use a special entitlement to participate in the process of joining Wi-Fi/hotspot networks (https://developer.apple.com/documentation/networkextension/nehotspothelper)
You need to request this entitlement to Apple or remove the call to `configureHotspotHelper()` in `AppDelegate.swift` and adapt the entitlements file to your needs.
## Contributing
By contributing to this project you are agreeing to the terms stated in the Contributor License Agreement (CLA) [here](/CLA.rst).
For more details please see [CONTRIBUTING](/CONTRIBUTING.md).
Issues and Pull Requests should use these templates: [ISSUE](/.github/ISSUE_TEMPLATE.md) and [PULL REQUEST](/.github/PULL_REQUEST_TEMPLATE.md).
## Authors
- Jose Blaya - [ueshiba](https://github.com/ueshiba)
- Davide De Rosa
- Amir Malik (before 2016)
## License
This project is licensed under the [MIT (Expat) license](https://choosealicense.com/licenses/mit/), which can be found [here](/LICENSE).
## Acknowledgements
- SwiftyBeaver - © 2015 Sebastian Kreutzberger
- Alamofire - © 2014-2018 Alamofire Software Foundation (http://alamofire.org/)
- iRate - © 2011 Charcoal Design
- TPKeyboardAvoiding - © 2013 Michael Tyson
- SideMenu - © 2015 Jonathan Kent <contact@jonkent.me>
- FXPageControl - © 2010 Charcoal Design
- MBProgressHUD - © 2009-2016 Matej Bukovinski
© 2002-2018 OpenVPN Inc. - OpenVPN is a registered trademark of OpenVPN Inc.
[pia-image]: https://www.privateinternetaccess.com/assets/PIALogo2x-0d1e1094ac909ea4c93df06e2da3db4ee8a73d8b2770f0f7d768a8603c62a82f.png
[pia-url]: https://www.privateinternetaccess.com/
[pia-wiki]: https://en.wikipedia.org/wiki/Private_Internet_Access
[dep-cocoapods]: https://guides.cocoapods.org/using/getting-started.html
[dep-swiftgen]: https://github.com/SwiftGen/SwiftGen
[dep-jazzy]: https://github.com/realm/jazzy
[dep-brew]: https://brew.sh/
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment