Files
amneziawg-windows-client/docs/buildrun.md
Roman Zakharchuk 83890fd474 Import WireGuard changes (#46)
* replace wg.exe with awg.exe

* update docs, update admin reg key

* rename awg modules

* build awg from source

* remove unused params

* improve work with tools

* safe rebranding: change upgrade code, windows class and name

* safe rebranding: wg -> awg

* update dependencies, fixed showing transfered KBs

* locales: sync with crowdin

Signed-off-by: Simon Rozman <simon@rozman.si>

* installer: update WiX Toolset download URL and version

The version 3.14.0.4118 we were using is no longer available for
download.

Signed-off-by: Simon Rozman <simon@rozman.si>

* build: make code signing method configurable

Existing code signing was hard-coded to use a locally installed
certificate (hardware security dongles included). However, signtool.exe
is extensible to allow any kind of digest signing plugin with /dlib and
/dmdf switches. This is used for cloud-based code signing (e.g.
Microsoft Trusted Signing).

Signed-off-by: Simon Rozman <simon@rozman.si>

* rename WireGuard to AmneziaWG in new localization files

---------

Signed-off-by: Simon Rozman <simon@rozman.si>
Co-authored-by: Simon Rozman <simon@rozman.si>
2025-03-10 19:59:44 +07:00

3.5 KiB

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://github.com/amnezia-vpn/amneziawg-windows-client
C:\Projects> cd amneziawg-windows-client
C:\Projects\amneziawg-windows-client> build

Running

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

C:\Projects\amneziawg-windows-client> amd64\amneziawg.exe

Alternatively, you can craft your own installer using the quickinstall.bat script.

Optional: Localizing

To translate AmneziaWG 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\amneziawg-windows-client> mkdir locales\<langID>
  1. Configure and run build to prepare initial locales\<langID>\messages.gotext.json file:

    C:\Projects\amneziawg-windows-client> set GoGenerate=yes
    C:\Projects\amneziawg-windows-client> build
    C:\Projects\amneziawg-windows-client> 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\amneziawg-windows-client> cd installer
C:\Projects\amneziawg-windows-client\installer> build

Optional: Signing Binaries

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

set SigningProvider=/sha1 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://github.com/amnezia-vpn/amneziawg-windows-client
$ cd amneziawg-windows-client
$ 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

awg(8) Support for Windows

The command line utility awg(8) works well on Windows. Being a Unix-centric project, it compiles with a build script:

$ git clone https://github.com/amnezia-vpn/amneziawg-tools
$ cd amneziawg-tools
$ build

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

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