Amnezia VPN
The best client for self-hosted VPN
Amnezia is an open-source VPN client, with a key feature that enables you to deploy your own VPN server on your server.
[!TIP]
If the Amnezia website is blocked in your region, you can use an Alternative website link.
All releases
Features
- Very easy to use - enter your IP address, SSH login, password and Amnezia will automatically install VPN docker containers to your server and connect to the VPN.
- Classic VPN-protocols: OpenVPN, WireGuard and IKEv2 protocols.
- Protocols with traffic Masking (Obfuscation): OpenVPN over Cloak plugin, Shadowsocks (OpenVPN over Shadowsocks), AmneziaWG and XRay.
- Split tunneling support - add any sites to the client to enable VPN only for them or add Apps (only for Android and Desktop).
- Windows, MacOS, Linux, Android, iOS releases.
- Support for AmneziaWG protocol configuration on Keenetic beta firmware.
Links
Tech
AmneziaVPN uses several open-source projects to work:
Help us with translations
Download the most actual translation files.
Go to "Actions" tab, click on the first line.
Then scroll down to the "Artifacts" section and download "AmneziaVPN_translations".
Unzip this file.
Each *.ts file contains strings for one corresponding language.
Translate or correct some strings in one or multiple *.ts files and commit them back to this repository into the client/translations folder.
You can do it via a web-interface or any other method you're familiar with.
Checking out the source code
Make sure to pull all submodules after checking out the repo.
git submodule update --init --recursive
Hacking guide
Want to contribute? Welcome!
Build requirements
CMake- Compiler and underlying build system, depending on the target:
Qt 6.10+ with the following modules:
- Core module for targeting platform (Desktop/Android/iOS)
- Qt 5 Compatibility module
- Qt Remote Objects
Conan package manager
- On MacOS is enough just to use
homebrew or install it in .venv in project root
- Other systems must have it in
PATH
- (Optional) Installer dependencies:
Building the project using scripts
- Run scripts located in
deploy directory
- Basically, if dependencies are located in default installation paths, the scripts will find them automatically.
- If they differ, specify them using the following variables:
QT_INSTALL_DIR - Qt root installation folderQT_ROOT_PATH - Qt framework root directoryQIF_ROOT_PATH - Qt Installer Framework root pathANDROID_HOME - Path to Android SDK root folder- and others. Check scripts for more
Unix-like:
# Build executables for the host platform
deploy/build.sh
# Or just
deploy/build.sh
# Build executables and installers for the host platform
deploy/build.sh --installer all
# Build Android APK and AAB
deploy/build.sh -t android --aab
# Call for help
deploy/build.sh -h
Windows:
:: Build executables for Windows
deploy/build.bat
:: Build executables with IFW installer for Windows
deploy/build.bat --installer ifw
:: Build executables with IFW and WIX installer for Windows
deploy/build.bat --installer ifw --installer wix
:: Or just
deploy/build.bat --installer all
Developing the project in IDEs
Basically, you can use any IDE that handles CMake and Qt kits properly to run configure and build steps, and to navigate through the code nicely. For example:
Qt CreatorVisual Studio Code with Qt Extension Pack- and so on
To use Xcode, you have to configure project first by using cmake. The easiest way to do it is to use Qt Creator for configuration. Then open AmneziaVPN.xcodeproj file from the build folder by using Xcode. Note that none of the files changed are saved - the files actually getting changed in build directory. Copy them manually if necessary
Android studio could be used in the same way - just configure the project by using cmake manually or by using Qt Creator. Open <build-dir>/client/android-build in Android studio then. Do not forget to copy the changes - everything you do is saved under the build directory actually.
Installing Android SDK
- Android SDK could be installed using the following methods:
- Using
Qt Creator. Use Preferences->SDKs
- Using
Android studio. By default it installs necessary SDKs automatically during the installation
- Manually by using
sdk-manager. Check this page for details
License
This project is licensed under the GNU General Public License v3.0 (see LICENSE) and also includes third-party components distributed under their own terms (see THIRD_PARTY_LICENSES.md).
Donate
Patreon: https://www.patreon.com/amneziavpn
Bitcoin: bc1qmhtgcf9637rl3kqyy22r2a8wa8laka4t9rx2mf
USDT BEP20: 0x6abD576765a826f87D1D95183438f9408C901bE4
USDT TRC20: TELAitazF1MZGmiNjTcnxDjEiH5oe7LC9d
XMR: 48spms39jt1L2L5vyw2RQW6CXD6odUd4jFu19GZcDyKKQV9U88wsJVjSbL4CfRys37jVMdoaWVPSvezCQPhHXUW5UKLqUp3
TON: UQDpU1CyKRmg7L8mNScKk9FRc2SlESuI7N-Hby4nX-CcVmns
Acknowledgments
This project is tested with BrowserStack.
We express our gratitude to BrowserStack for supporting our project.
Amnezia 是一款免费开源的 VPN 客户端，支持桌面和移动端，它的核心特色是能在你自己的服务器上搭建 VPN 服务器，然后连接上去。