Windscribe/iOS-App: Complete source code of the official Windscribe iOS application. · GitHub

Native Swift apps for iPhone, iPad, and Apple TV. Supports multiple VPN protocols (WireGuard, AmneziaWG, OpenVPN, IKEv2, Stealth, WStunnel), per-Wi-Fi configuration, On-Demand mode, Siri/Shortcuts integration, and a home-screen widget.

• Install from the App Store
• Build from source
  • Requirements
  • First-time setup
  • Build & run
  • Schemes
  • Troubleshooting
• Testing
• Linting
• Contributing
• Versioning
• Acknowledgements

apps.apple.com/us/app/windscribe-vpn/id1129435228

Physical iOS/tvOS hardware is required to actually run a tunnel. Simulators build and launch, but cannot bring up a Network Extension.

1. Clone and open the project:

   git clone <repo-url> iosapp
   cd iosapp
   open Windscribe.xcodeproj

2. Override Windscribe/Environments/Config.xcconfig with your own signing values. The default file points at Windscribe's team / bundle IDs:

   APP_TEAM_ID = <your Apple Developer team ID>
   APP_BUNDLE_ID = <your reverse-DNS bundle ID>
   

   The extension bundle IDs (PacketTunnel, WireGuardTunnel, SiriIntents, HomeWidget) are derived from APP_BUNDLE_ID automatically.

3. In each target's Signing & Capabilities tab, select your Apple Developer team. All five app-group-sharing targets must be signed with the same team.

4. Let Xcode resolve Swift packages (File → Packages → Resolve Package Versions).

Pick a scheme, pick a device, hit ⌘R. The build_wireguard_go_bridge.sh run script builds the WireGuard-Go bridge the first time you build (and re-runs when the SDK root changes). It needs go on your PATH or it will download a toolchain to a temp dir.

• Packages fail to resolve → Xcode → Settings → Locations → Derived Data → delete, then File → Packages → Reset Package Caches.
• WireGuard-go build fails → install Go (brew install go) and rebuild. The script caches by SDK root, so Product → Clean Build Folder also clears it.
• Code signing errors on extensions → make sure every target uses the same team and that your provisioning profiles include the Network Extensions entitlement.
• Realm migration errors on first run after pulling main → delete the app from the device; schema migrations are handled at launch but only for versions we've shipped.

fastlane test           # runs WindscribeTests on iPhone 16 Pro

Or from Xcode: select the WindscribeTests scheme and ⌘U.

swiftlint lint          # or: fastlane lint

Config lives in .swiftlint.yml. Pull/merge requests are gated on lint passing.

1. Fork the repo and open an issue describing the change.
2. Branch off main (feature/<slug> or fix/<slug>).
3. Keep commits focused; ensure lint + tests pass locally.
4. Open a pull request (or merge request, if working on the GitLab source) referencing the issue.

New code follows the patterns in AGENTS.md. In short: SwiftUI + @Observable + async/await for anything new; existing UIKit/Combine/Swinject/Realm stays until it's rewritten.

Semantic Versioning — Major.Minor.Patch (BuildNumber), e.g. 3.10.1 (22) on TestFlight.

Bump the marketing version in one place: Windscribe/Environments/Config.xcconfig.

MARKETING_VERSION       = 3.11.0    # iOS app + all extensions
TV_MARKETING_VERSION    = 1.0.4     # tvOS app (independent cadence)
CURRENT_PROJECT_VERSION = 1         # build number — overridden by CI

The xcconfig is the single source of truth; every target's Info.plist reads $(MARKETING_VERSION) / $(CURRENT_PROJECT_VERSION) from it. Do not edit version values inside project.pbxproj — those entries were removed during consolidation.

The build number is injected at archive time by fastlane iOSTestFlight via xcargs CURRENT_PROJECT_VERSION=$CI_PIPELINE_IID (with a TestFlight latest+1 fallback for local archives), so CI builds never mutate the project file.

Third-party licenses: ACKNOWLEDGEMENTS.md. License: LICENCE.md.