IVPN for iOS
IVPN for iOS is a native app built using Swift language. Some of the features include: multiple protocols (IKEv2, OpenVPN, WireGuard), Kill-switch, Multi-Hop, Trusted Networks, AntiTracker, Custom DNS, Dark mode and more.
IVPN iOS app is distributed on the App Store.
- About this Repo
- Installation
- Testing
- Deployment
- Versioning
- Contributing
- Security Policy
- License
- Authors
- Acknowledgements
About this Repo
This is the official Git repo of the IVPN for iOS project.
Installation
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Requirements
- iOS 14.0+
- Xcode 14.0+
- Swift 5.0+
- fastlane 2.178.0+
- Go 1.18+
Dev dependencies
Project dev dependencies:
Install fastlane, SwiftLint and Go:
$ brew install fastlane swiftlint go
Dependencies
Dependencies are installed with Swift Package Manager.
Project dependencies:
- WireGuardKit
- TunnelKit
- SnapKit
- KeychainAccess
- SwiftyStoreKit
- JGProgressHUD
- ActiveLabel
- ReachabilitySwift
- FloatingPanel
Xcode build configurations
There are different build configurations: Staging and Release.
Rename and populate .xcconfig
files:
$ cp IVPNClient/Config/staging.template.xcconfig IVPNClient/Config/staging.xcconfig
$ cp IVPNClient/Config/release.template.xcconfig IVPNClient/Config/release.xcconfig
OpenVPN configuration
Rename and populate OpenVPNConf.swift
file:
$ cp IVPNClient/Config/OpenVPNConf.template.swift IVPNClient/Config/OpenVPNConf.swift
Fastlane configuration
Rename and populate Appfile
files:
$ cp fastlane/Appfile.template fastlane/Appfile
Testing
Run code linter using fastlane:
$ fastlane lint
Run tests using fastlane:
$ fastlane test
Alternatively, run tests using xcodebuild:
$ xcodebuild test -scheme IVPNClient -destination 'platform=iOS Simulator,name=iPhone 14'
Deployment
To build and deploy beta build to TestFlight:
$ fastlane beta
To build and deploy staging build to TestFlight:
$ fastlane staging
To build and deploy App Store release build to TestFlight:
$ fastlane release
Versioning
Project is using Semantic Versioning (SemVer) for creating release versions.
SemVer is a 3-component system in the format of x.y.z
where:
x
stands for a major version
y
stands for a minor version
z
stands for a patch
So we have: Major.Minor.Patch
Contributing
If you are interested in contributing to IVPN for iOS project, please read our Contributing Guidelines.
Security Policy
If you want to report a security problem, please read our Security Policy.
License
This project is licensed under the GPLv3 - see the License file for details.
Authors
See the Authors file for the list of contributors who participated in this project.
Acknowledgements
See the Acknowledgements file for the list of third party libraries used in this project.