aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: b532110b7bdef320a330d142a06e4950321b6988 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# [WireGuard](https://www.wireguard.com/) for iOS

This is the sourcecode of the WireGuard iOS app. With this app you should be able to create device wide WireGuard VPN connections.

Feel free to clone, experiment and modify. Just know that the Network Extension bits will only work on an actual iOS device. To do so, it is required to fully provision both the app and network extension. This is NOT straighforward.

Get in touch on Freenode IRC channel wireguard.

## To get started...

Make sure you have Go available. A homebrew install will do. `brew install go`

- Clone this repo.
  - `git clone https://git.zx2c4.com/wireguard-ios`
  - Init and update submodule: `git submodule init && git submodule update`
- Prepare WireGuard Go bindings
  - `cd wireguard-go-bridge && make`
- Prepare Xcode project
  - Run `pod install`
  - Open `WireGuard.xcworkspace`

## License

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2 as
    published by the Free Software Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

    ---------------------------------------------------------------------------
    Additional Permissions For Submission to Apple App Store: Provided that you
    are otherwise in compliance with the GPLv2 for each covered work you convey
    (including without limitation making the Corresponding Source available in
    compliance with Section 3 of the GPLv2), you are granted the additional
    the additional permission to convey through the Apple App Store
    non-source executable versions of the Program as incorporated into each
    applicable covered work as Executable Versions only under the Mozilla
    Public License version 2.0 (https://www.mozilla.org/en-US/MPL/2.0/).