github.com/amnezia-vpn/amneziawg-go@v0.2.8/README.md (about)

     1  # Go Implementation of AmneziaWG
     2  
     3  AmneziaWG is a contemporary version of the WireGuard protocol. It's a fork of WireGuard-Go and offers protection against detection by Deep Packet Inspection (DPI) systems. At the same time, it retains the simplified architecture and high performance of the original.
     4  
     5  The precursor, WireGuard, is known for its efficiency but had issues with detection due to its distinctive packet signatures.
     6  AmneziaWG addresses this problem by employing advanced obfuscation methods, allowing its traffic to blend seamlessly with regular internet traffic.
     7  As a result, AmneziaWG maintains high performance while adding an extra layer of stealth, making it a superb choice for those seeking a fast and discreet VPN connection.
     8  
     9  ## Usage
    10  
    11  Simply run:
    12  
    13  ```
    14  $ amneziawg-go wg0
    15  ```
    16  
    17  This will create an interface and fork into the background. To remove the interface, use the usual `ip link del wg0`, or if your system does not support removing interfaces directly, you may instead remove the control socket via `rm -f /var/run/amneziawg/wg0.sock`, which will result in amneziawg-go shutting down.
    18  
    19  To run amneziawg-go without forking to the background, pass `-f` or `--foreground`:
    20  
    21  ```
    22  $ amneziawg-go -f wg0
    23  ```
    24  When an interface is running, you may use [`amneziawg-tools `](https://github.com/amnezia-vpn/amneziawg-tools) to configure it, as well as the usual `ip(8)` and `ifconfig(8)` commands.
    25  
    26  To run with more logging you may set the environment variable `LOG_LEVEL=debug`.
    27  
    28  ## Platforms
    29  
    30  ### Linux
    31  
    32  This will run on Linux; you should run amnezia-wg instead of using default linux kernel module.
    33  
    34  ### macOS
    35  
    36  This runs on macOS using the utun driver. It does not yet support sticky sockets, and won't support fwmarks because of Darwin limitations. Since the utun driver cannot have arbitrary interface names, you must either use `utun[0-9]+` for an explicit interface name or `utun` to have the kernel select one for you. If you choose `utun` as the interface name, and the environment variable `WG_TUN_NAME_FILE` is defined, then the actual name of the interface chosen by the kernel is written to the file specified by that variable.
    37  This runs on MacOS, you should use it from [amneziawg-apple](https://github.com/amnezia-vpn/amneziawg-apple)
    38  
    39  ### Windows
    40  
    41  This runs on Windows, you should use it from [amneziawg-windows](https://github.com/amnezia-vpn/amneziawg-windows), which uses this as a module.
    42  
    43  
    44  ## Building
    45  
    46  This requires an installation of the latest version of [Go](https://go.dev/).
    47  
    48  ```
    49  $ git clone https://github.com/amnezia-vpn/amneziawg-go
    50  $ cd amneziawg-go
    51  $ make
    52  ```