|
1 | 1 |  |
2 | 2 | [](https://codecov.io/gh/NLipatov/TunGo) |
3 | | - |
| 3 | +[](./LICENSE) |
4 | 4 |  |
5 | 5 |  |
6 | 6 |  |
|
11 | 11 | <img alt="Two gophers dancing tango" src="https://i.ibb.co/K7yzDf6/DALL-E-2024-10-04-20-18-51-A-minimalist-logo-featuring-two-Go-language-mascots-dancing-tango-togethe.webp" width="40%"/> |
12 | 12 | </p> |
13 | 13 |
|
14 | | -**TunGo** is a lightweight VPN designed for modern needs: **fast**, **secure**, and **easy to understand**. |
| 14 | +**TunGo** is a lightweight VPN designed for modern needs: **fast**, **secure**, and **open-source**. |
15 | 15 |
|
16 | 16 | ### Key features: |
17 | | -- 🚀 **High Performance** — negligible CPU usage and no allocations under load. |
18 | | -- 📦 **Tiny Memory Footprint** — ~8 MB idle, ~14 MB under traffic. |
| 17 | +- 🧩 **Easy to deploy & configure**. |
| 18 | +- 🚀 **High Performance** — near-zero allocations on the hot path (benchmarked). |
| 19 | +- 📦 **Tiny Memory Footprint** — ≈5–15 MB **RSS** under load, ≈5–8 MB idle. |
19 | 20 | - 🔒 **End-to-End Encryption** — X25519 (Curve25519 ECDH) for key agreement; ChaCha20-Poly1305 (AEAD) for traffic encryption; Ed25519 for authentication. |
20 | 21 | - ⚡ **Built from Scratch** — no legacy, no bloat. Clean, readable Go code. |
21 | | -- 🌐 **IoT and Embedded Ready** — optimized for small devices and constrained environments. |
22 | | -- 🛡️ **Open Source** — AGPLv3 licensed, free for community use, commercial licenses available. |
23 | | - |
24 | | ---- |
25 | | - |
26 | | -TunGo is engineered for developers who value **transparency**, **efficiency**, and **freedom**. |
27 | | -Simple to deploy, easy to audit, ready to adapt. |
28 | | - |
29 | | ---- |
30 | | - |
31 | | - |
32 | | -## 📑 Table of Contents |
33 | | - |
34 | | -* [License](#-license) |
35 | | -* [QuickStart](#-quickstart) |
36 | | - |
37 | | - * [Server Setup](#%EF%B8%8F-server-setup-linux-only) |
38 | | - * [Client Setup](#%EF%B8%8F-client-setup) |
39 | | -* [Advanced Use Cases](#-advanced-use-cases) |
40 | | - |
41 | | ---- |
42 | | - |
43 | | -## 📜 License |
44 | | - |
45 | | -**Free for non-commercial use** |
46 | | - |
47 | | -Use for personal privacy, censorship bypassing, and educational purposes. |
48 | | - |
49 | | -**Commercial licensing** |
50 | | - |
51 | | -This project is licensed under the [GNU AGPLv3](./LICENSE). |
52 | | -For commercial use, contact Nikita Lipatov at [6stringsohei@gmail.com](mailto:6stringsohei@gmail.com). |
| 22 | +- 🌐 **IoT & Embedded Ready** — optimized for small devices and constrained environments. |
| 23 | +- 🛡️ **Open Source** — AGPL-3.0-only; commercial licenses available. |
53 | 24 |
|
54 | 25 | --- |
55 | 26 |
|
56 | 27 | ## 🚀 QuickStart |
57 | 28 |
|
58 | | -Get TunGo server and client up and running in minutes! |
59 | | - |
60 | | -### 🖥️ Server Setup (Linux only) |
61 | | - |
62 | | -1. **Install TunGo** |
63 | | - |
64 | | - ```bash |
65 | | - wget https://github.com/NLipatov/TunGo/releases/latest/download/tungo-linux-amd64 -O tungo |
66 | | - chmod +x tungo |
67 | | - sudo mv tungo /usr/local/bin/ |
68 | | - ``` |
69 | | - |
70 | | -2. **Generate Client Config** |
71 | | - |
72 | | - ```bash |
73 | | - sudo tungo s gen |
74 | | - ``` |
75 | | - |
76 | | - > Copy the displayed configuration for your client. |
77 | | -
|
78 | | -3. **Start Server** |
79 | | - |
80 | | - ```bash |
81 | | - sudo tungo |
82 | | - ``` |
83 | | - |
84 | | - > In the TUI menu, select **server → start server**. |
| 29 | +Refer to: [QuickStart](https://tungo.ethacore.com/docs/QuickStart) |
85 | 30 |
|
86 | 31 | --- |
87 | 32 |
|
88 | | -### 🖥️ Client Setup |
89 | | - |
90 | | -#### Linux (x64) |
91 | | - |
92 | | -```bash |
93 | | -wget https://github.com/NLipatov/TunGo/releases/latest/download/tungo-linux-amd64 -O tungo && \ |
94 | | -chmod +x tungo && \ |
95 | | -sudo mv tungo /usr/local/bin/ |
96 | | -``` |
97 | | - |
98 | | -#### macOS (Apple Silicon) |
99 | | - |
100 | | -```bash |
101 | | -wget https://github.com/NLipatov/TunGo/releases/latest/download/tungo-darwin-arm64 -O tungo && \ |
102 | | -chmod +x tungo && \ |
103 | | -sudo mv tungo /usr/local/bin/ |
104 | | -``` |
105 | | - |
106 | | -#### macOS (x64) |
107 | | - |
108 | | -```bash |
109 | | -wget https://github.com/NLipatov/TunGo/releases/latest/download/tungo-darwin-amd64 -O tungo |
110 | | -chmod +x tungo |
111 | | -sudo mv tungo /usr/local/bin/ |
112 | | -``` |
| 33 | +## 🔧 Advanced Use Cases |
113 | 34 |
|
114 | | -#### Windows (x64) |
| 35 | +See more use cases at https://tungo.ethacore.com, for example: |
115 | 36 |
|
116 | | -Download the installer from the [release page](https://github.com/NLipatov/TunGo/releases). |
| 37 | +1) [How to run the server in a Docker container](https://tungo.ethacore.com/docs/Advanced/Containerization/Docker/Server) |
| 38 | +2) [How to set up a server systemd unit (auto-start on boot)](https://tungo.ethacore.com/docs/Advanced/Linux/Setup%20server%20systemd%20unit) |
| 39 | +3) [How to set up a client systemd unit (auto-start on boot)](https://tungo.ethacore.com/docs/Advanced/Linux/Setup%20client%20systemd%20unit) |
117 | 40 |
|
118 | 41 | --- |
119 | 42 |
|
120 | | -**Launch Tunnel:** |
| 43 | +## 📜 License — AGPL-3.0-only |
121 | 44 |
|
122 | | -* **Linux/macOS:** `sudo tungo` |
123 | | -* **Windows:** Run as Administrator. |
| 45 | +**TL;DR:** You can use TunGo privately or commercially. |
124 | 46 |
|
125 | | -🎉 You're all set! |
| 47 | +If users interact with your (modified or unmodified) TunGo over a network (SaaS/hosted), you must provide them the complete corresponding source code of TunGo, including your changes and the scripts used to control compilation and installation. |
| 48 | +Independent services that only communicate with TunGo over standard protocols (HTTP/gRPC, queues, etc.) do not have to be open-sourced (unless they are part of a derivative work). |
126 | 49 |
|
127 | | ---- |
| 50 | +### 🔒 Need a closed integration? |
| 51 | +If you need to **embed/link** TunGo into a proprietary product without sharing source, contact <mailto:6stringsohei@gmail.com> for a **commercial license**. |
128 | 52 |
|
129 | | -## 🔧 Advanced Use Cases |
| 53 | +### ✅ You can |
| 54 | +- Run TunGo for personal or commercial use. |
| 55 | +- Modify it and keep changes private **as long as no users access it over a network**. |
| 56 | +- Host it as a paid service (SaaS). |
| 57 | +- Combine it with separate services via clean network boundaries. |
| 58 | + |
| 59 | +### 🧾 You must (when applicable) |
| 60 | +- For hosted/SaaS use: offer users a link to download the **source of the TunGo version you run**, incl. your patches and build/install scripts. |
| 61 | +- For binary distribution: ship or offer the source for the distributed TunGo parts. |
| 62 | +- Keep copyright notices and the AGPL-3.0 license text. |
130 | 63 |
|
131 | | -See https://tungo.ethacore.com for more use cases, like: |
132 | | -1) [How to run server in docker container](https://tungo.ethacore.com/docs/Advanced/Containerization/Docker/Server) |
133 | | -2) [How to setup server systemd daemon (for automated start on system startup)](https://tungo.ethacore.com/docs/Advanced/Linux/Setup%20server%20systemd%20unit) |
134 | | -3) [How to setup client systemd daemon (for automated start on system startup)](https://tungo.ethacore.com/docs/Advanced/Linux/Setup%20client%20systemd%20unit) |
| 64 | +### ❗ You don’t have to |
| 65 | +- Open-source unrelated services, databases, infra, or monitoring—unless they become a **derivative work** of TunGo. |
0 commit comments