Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mcfly722 committed Sep 15, 2024
1 parent cae8f42 commit d27037f
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,32 @@
![version](https://img.shields.io/badge/version-1.2-blue)
[![License: GPL3.0](https://img.shields.io/badge/License-GPL3.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
<br>
To configure new VPN Gateway, use: https://mcfly722.github.io/cloak-vpn-helper/
## Problem
Many devices (like Samsung Smart TV) has no proxy settings to configure it through v2rayN proxy, so for this kind devices separate VPN gateway required.<br>
<br>
This helper simplifies this IP VPN Gateway installation (Used <a href="https://github.com/cbeuw/Cloak">Cloak</a> + <a href="https://www.wireguard.com/">WireGuard</a>).
<br>
Many devices (like Samsung Smart TV) has no proxy settings to configure it using v2rayN tunneling, so for this kind devices separate VPN gateway required.<br>
This helper simplifies this installation using <a href="https://github.com/cbeuw/Cloak">Cloak</a> + <a href="https://www.wireguard.com/">WireGuard</a> VPN Tunnel.
<br>
Finally, data flows through the following chain:
- LAN: Smart TV or other device (in device network settings you should configure new VPN Gateway IP)
- LAN: VPN Gateway
- LAN: WireGuard client
- LAN: Cloak client
- Censored Internet
- Remote: Cloak server
- Remote: WireGuard server
- Free Internet

<br>
Helper generates required key pairs and gives you final bash scripts for final installation.<br>
Helper generates required key pairs and gives you final bash scripts for deployment.<br>
Note: <b>all keys generates on client side (by your internet browser) and not transmitted to any servers! (it is zero trust configurator)</b>

<br>
Helper site: <a href="https://mcfly722.github.io/cloak-vpn-helper">https://mcfly722.github.io/cloak-vpn-helper</a>




## Supported OS

| OS | bit | Architecture | Tested |
Expand Down

0 comments on commit d27037f

Please sign in to comment.