amnezia-client README

The project's README from github.com/amnezia-vpn/amnezia-client. As one markdown file: README.md.

Amnezia VPN

The best client for self-hosted VPN

Build Status Gitpod ready-to-code

English | Русский

Amnezia is an open-source VPN client, with a key feature that enables you to deploy your own VPN server on your server.

Image

[!TIP] If the Amnezia website is blocked in your region, you can use an Alternative website link.

All releases


Features

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

Building the project using scripts

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

Installing Android SDK

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-client (amnezia-vpn/amnezia-client)

shadowsocks
Searching Database…

15.5K ·GitHub
Amnezia-client
What is this?Amnezia is a free, open-source VPN client for desktop and mobile whose key feature is deploying a VPN server on your own server and then connecting to it.
Is this the VPN app, the server, or both?One app does both jobs: it is a client for your device that can also install the server side onto your own machine over SSH. The VPN you connect to is the one it builds for you.
How do I turn my server into a VPN with it?Install the app for your OS, then enter your server's IP address, SSH login and password — Amnezia automatically installs VPN docker containers on the server and connects you to the VPN.
Do I need to rent a server first, or does Amnezia give me one?You bring the server: any machine you can log into via SSH works, typically a rented VPS. Everything on the server side is installed by the app itself.
Will regular VPN protocols work everywhere, or do some networks block them?Plain OpenVPN, WireGuard and IKEv2 can be detected in censored networks; for those cases Amnezia ships traffic-masking protocols: OpenVPN over Cloak, OpenVPN over Shadowsocks, AmneziaWG and XRay.
Does it run on phones too, or just desktops?Both — there are releases for Windows, macOS and Linux desktops as well as Android and iOS apps.
Does my traffic pass through Amnezia's servers?No — the VPN endpoint is a server you deploy and control yourself, so your traffic exits from your own machine rather than a provider's shared servers.
Can I route only some sites or apps through the VPN?Yes — split tunneling lets you add sites that should use the VPN, or tunnel individual apps; per-app rules are available on Android and Desktop only.
Can I use it on my router?The only router support mentioned is AmneziaWG protocol configuration on Keenetic beta firmware.
Is there a paid option?The client itself is free; the README links to a Premium offering on the project website sold for 6 or 12 months.
Why self-host a VPN instead of paying for a commercial one?The project's pitch is 'The best client for self-hosted VPN': you own the endpoint, so your traffic is not handed to a provider's shared servers, and you choose the server location and protocol yourself.
What are similar projects?algo, mlmvpn_android, hiddify-app, streisand, fanqiang, SoftEtherVPN, Xray-core, v2rayNG
Which topics is it in?openvpn, vpn-server, xray, vpn-client, wireguard, gfw, shadowsocks, censorship-circumvention, ssh, vpn, mobile-app, c++
Creator
amnezia-vpn
Size
395.9 MB
Stars
15.5K
Updated
CommitOct 17Release5.0.3.0Sep 18
Age
5y
Commits · 90 Days