This repo contains the complete source code for the Windscribe 2.0 app. This includes installer, service/helper, and GUI.
- Windows 10/11.
- Install git. When installing Git, you can stick with all the default options presented to you by the installer.
- Clone the repository.
- Install Visual Studio Community Edition 2019 (run
install_vs.bat
from/tools/prepare_build_environment/windows
). - Install Python 3 via either the Microsoft Store or from here. Minimum tested version is 3.6.8.
- Install Active Perl.
- Alternately, you can install Strawberry Perl.
- Install CMake v3.23.x or newer from here (
install_cmake.bat
intools/prepare_build_environment/windows
will download and install CMake v3.23.2 for you). - Verify the following entries are in your System
PATH
environment variable. If they are not, add them to the SystemPATH
environment variable and reboot.C:\Perl64\site\bin
(or equivalent Strawberry Perlsite\bin
folder)C:\Perl64\bin
(or equivalent Strawberry Perlbin
folder)C:\Program Files\Git\cmd
- Verify that
python3
is available in your SystemPATH
environment variable.- If you installed Python from the Microsoft Store, enable the
python3.exe
execution alias in System SettingsManage App Execution Aliases
. - If you installed Python from python.org, you can
mklink /path/to/your/python3.exe /path/to/your/python.exe
- If you installed Python from the Microsoft Store, enable the
- You will have to go to
Manage App Execution Aliases
in System Settings and disable app installer forpython.exe
andpython3.exe
python3 -m pip install -r tools/requirements.txt
- Copy your PFX code signing file to
installer/windows/signing/code_signing.pfx
. - Edit (create)
tools/notarize.yml
and add the following line:
windows-signing-cert-password: password-for-code-signing-pfx
- Edit
client/common/utils/executable_signature/executable_signature_defs.h
and set theWINDOWS_CERT_SUBJECT_NAME
entry to match your certficate's name of signer field.
Go to subfolder tools/deps
and run the following scripts in order. Libraries will be placed in build-libs
.
install_jom
install_openssl
install_openssl_ech_draft
install_qt
install_cares
install_zlib
install_curl
install_boost
install_lzo
install_openvpn
install_wireguard
install_stunnel
Go to subfolder tools
and run build_all
. Assuming all goes well with the build, the installer will be placed in build-exe
. You can run build_all --sign --use-local-secrets
for a code-signed build, using the certificate from the Install signing certificate section above, which will perform run-time signature verification checks on the executables. Note that an unsigned build must be installed on your PC if you intend to debug the project.
See build_all --help
for other build options.
You will find the application logs in C:/Users/USER/AppData/Local/Windscribe/Windscribe2
.
- macOS Big Sur, Monterey, or Ventura
- Install Xcode 13.2.1 (If on Monterey/Ventura, you may use a newer version of Xcode 13/14, but 13.2.1 is the last version to support Big Sur)
- Note: these downloads will require you to first login to your Apple account.
- https://download.developer.apple.com/Developer_Tools/Xcode_13.2.1/Xcode_13.2.1.xip
- Install brew (brew.sh)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
- Install git. This step is optional, as git is bundled with Xcode.
brew install git
- Install Auto-Tools and 7-Zip:
brew install libtool
brew install automake
brew install p7zip
- Install Python 3:
- Minimum tested version is Python 3.6.8. You may do this however you like, however
pyenv
is recommended:
- Minimum tested version is Python 3.6.8. You may do this however you like, however
brew install pyenv
echo 'if command -v pyenv 1>/dev/null 2>&1; then eval "$(pyenv init --path)"; fi"' >> ~/.zshrc
pyenv install 3.11.0
pyenv global 3.11.0
- Install dmgbuild:
python3 -m pip install dmgbuild
- Install CMake v3.23.x or newer from here
- Clone the repository.
- Install python deps:
python3 -m pip install -r tools/requirements.txt
- Install your Developer ID Application signing certificate from your Apple Developer account in Keychain Access.
- Edit
client/common/utils/executable_signature/executable_signature_defs.h
and set theMACOS_CERT_DEVELOPER_ID
entry to match your Developer ID Application signing certificate.
Go to subfolder tools/deps
and run the following scripts in order. Libraries will be placed in build-libs
.
install_openssl
install_openssl_ech_draft
install_qt
install_cares
install_curl
install_boost
install_lzo
install_openvpn
install_wireguard
install_stunnel
Go to subfolder tools
and run build_all
. Assuming all goes well with the build, the installer will be placed in build-exe
.
See build_all --help
for other build options.
You will find the application logs in ~/Library/Application Support/Windscribe/Windscribe2
.
- If you make any changes to the helper source code
backend/mac/helper/src
, you must increase theCFBundleVersion
inbackend/mac/helper/src/helper-info.plist
. The installer only updates the helper if this bundle version number has changed. - The IKEv2 protocol will only function in builds produced by Windscribe. It's implementation on macOS utilizes the NEVPNManager API, which requires the 'Personal VPN' entitlement (
com.apple.developer.networking.vpn.api
) and an embedded provisioning profile file. If you wish to enable IKEv2 functionality, you will have to create an embedded provisioning file in your Apple Developer account and use it in the client project (Search forembedded.provisionprofile
inclient/CMakeLists.txt
for details on where to place the embedded provisioning profile).
Build process tested on Ubuntu 20.04/ZorinOS 16 (gcc 9.3.0).
- Install build requirements:
sudo apt-get install build-essential git curl patchelf libpam0g-dev software-properties-common libgl1-mesa-dev fakeroot python3-pip zip unzip
sudo apt-get update
sudo apt-get install wget autoconf libtool
# install cmake 3.23.x (default for Ubuntu 20.04 is 3.16.3)
wget -qO /etc/apt/trusted.gpg.d/kitware-key.asc https://apt.kitware.com/keys/kitware-archive-latest.asc
echo "deb https://apt.kitware.com/ubuntu/ focal main" | tee /etc/apt/sources.list.d/kitware.list
sudo apt-get -y update
sudo apt-get -y install cmake
- Clone the repository.
- Install python deps:
python3 -m pip install -r tools/requirements.txt
Go to subfolder tools/deps
and run the following scripts in order. Libraries will be placed in build-libs
.
install_openssl
install_openssl_ech_draft
install_qt
install_cares
install_curl
install_boost
install_lzo
install_openvpn
install_wireguard
install_stunnel
Go to subfolder tools
and run build_all
. Assuming all goes well with the build, the installer will be placed in build-exe
.
See build_all --help
for other build options.
The application installs to /opt/windscribe
. You will find the application logs in ~/.local/share/Windscribe/Windscribe2
.
Please see our Contributing Guidelines
The Windscribe Desktop Client app License