Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 3.79 KB

buildrun.md

File metadata and controls

98 lines (64 loc) · 3.79 KB
Raw

Building, Running, and Developing

Building

Windows 10 64-bit or Windows Server 2019, and Git for Windows is required. The build script will take care of downloading, verifying, and extracting the right versions of the various dependencies:

C:\Projects> git clone https://git.zx2c4.com/wireguard-windows
C:\Projects> cd wireguard-windows
C:\Projects\wireguard-windows> build

Running

After you've built the application, run amd64\wireguard.exe or x86\wireguard.exe to install the manager service and show the UI.

C:\Projects\wireguard-windows> amd64\wireguard.exe

Since WireGuard requires a driver to be installed, and this generally requires a valid Microsoft signature, you may benefit from first installing a release of WireGuard for Windows from the official wireguard.com builds, which bundles a Microsoft-signed driver, and then subsequently run your own wireguard.exe. Alternatively, you can craft your own installer using the quickinstall.bat script.

Optional: Localizing

To translate WireGuard UI to your language:

  1. Upgrade resources.rc accordingly. Follow the pattern.

  2. Make a new directory in locales\ containing the language ID:

C:\Projects\wireguard-windows> mkdir locales\<langID>

  1. Configure and run build to prepare initial locales\<langID>\messages.gotext.json file:

    C:\Projects\wireguard-windows> set GoGenerate=yes
C:\Projects\wireguard-windows> build
C:\Projects\wireguard-windows> copy locales\<langID>\out.gotext.json locales\<langID>\messages.gotext.json

  2. Translate locales\<langID>\messages.gotext.json. See other language message files how to translate messages and how to tackle plural. For this step, the project is currently using CrowdIn; please make sure your translations make it there in order to be added here.

  3. Run build from the step 3 again, and test.

  4. Repeat from step 4.

Optional: Creating the Installer

The installer build script will take care of downloading, verifying, and extracting the right versions of the various dependencies:

C:\Projects\wireguard-windows> cd installer
C:\Projects\wireguard-windows\installer> build

Optional: Signing Binaries

Add a file called sign.bat in the root of this repository with these contents, or similar:

set SigningCertificate=8BC932FDFF15B892E8364C49B383210810E4709D
set TimestampServer=http://timestamp.entrust.net/rfc3161ts2

After, run the above build commands as usual, from a shell that has signtool.exe in its PATH, such as the Visual Studio 2017 command prompt.

Alternative: Building from Linux

You must first have Mingw and ImageMagick installed.

$ sudo apt install mingw-w64 imagemagick
$ git clone https://git.zx2c4.com/wireguard-windows
$ cd wireguard-windows
$ make

You can deploy the 64-bit build to an SSH host specified by the DEPLOYMENT_HOST environment variable (default "winvm") to the remote directory specified by the DEPLOYMENT_PATH environment variable (default "Desktop") by using the deploy target:

$ make deploy

wg(8) Support for Windows

The command line utility wg(8) works well on Windows. Being a Unix-centric project, it compiles with a Makefile and MingW:

$ git clone https://git.zx2c4.com/wireguard-tools
$ PLATFORM=windows make -C wireguard-tools/src
$ stat wireguard-tools/src/wg.exe

It interacts with WireGuard instances run by the main WireGuard for Windows program.

When building on Windows, the aforementioned build.bat script takes care of building this.