Skip to content

Commit a628a7f

Browse files
NLipatovNLipatov
authored
Merge pull request #230 from NLipatov/feature/multilanguage-docs
Multi-language documentation
2 parents 56ddda9 + 3696125 commit a628a7f

File tree

74 files changed

+4941
-684
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+4941
-684
lines changed

‎docs/TunGo/ReadMe.md‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Module dedication
2-
The Docs module serves as a knowledge base for working with the TunGo project, whether you’re using it as a user or contributing as a developer.
2+
The Docs module serves as a knowledge base for working with the TunGo project, whether you're using it as a user or contributing as a developer.
33

44
# Run Docs Project
55

@@ -9,16 +9,24 @@ npm install
99
```
1010

1111
## 2. Start the Server
12+
13+
**Development (single locale):**
14+
```bash
15+
npm start
16+
npm start -- --locale de # specific locale
17+
```
18+
19+
**Production preview (all locales):**
1220
```bash
13-
npm run start
21+
npm run build && npm run serve
1422
```
1523

1624
## 3. Open the Web UI
1725

1826
The project will be available at [http://localhost:3000](http://localhost:3000).
1927

20-
# Update deps
28+
# Update Dependencies
2129

2230
```bash
23-
npm update
31+
npx npm-check-updates -u && npm install
2432
```

‎docs/TunGo/docs/1. QuickStart.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ See <a href="/docs/Advanced/Linux/Setup server systemd unit">this guide</a> to r
7373
<TabItem value="macos-amd64" label="macOS Intel">
7474
```bash
7575
curl -L -o tungo https://github.com/NLipatov/TunGo/releases/latest/download/tungo-darwin-amd64
76-
chmod +x tungo
7776
sudo mkdir -p /usr/local/bin
77+
chmod +x tungo
7878
sudo mv tungo /usr/local/bin/
7979
```
8080
</TabItem>

‎docs/TunGo/docusaurus.config.js‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,19 @@ const config = {
3333
// may want to replace "en" with "zh-Hans".
3434
i18n: {
3535
defaultLocale: 'en',
36-
locales: ['en'],
36+
locales: ['en', 'zh-Hans', 'es', 'ar', 'pt', 'id', 'fr', 'ja', 'ru', 'de'],
37+
localeConfigs: {
38+
en: { label: 'English', direction: 'ltr' },
39+
'zh-Hans': { label: '简体中文', direction: 'ltr' },
40+
es: { label: 'Español', direction: 'ltr' },
41+
ar: { label: 'العربية', direction: 'rtl' },
42+
pt: { label: 'Português', direction: 'ltr' },
43+
id: { label: 'Bahasa Indonesia', direction: 'ltr' },
44+
fr: { label: 'Français', direction: 'ltr' },
45+
ja: { label: '日本語', direction: 'ltr' },
46+
ru: { label: 'Русский', direction: 'ltr' },
47+
de: { label: 'Deutsch', direction: 'ltr' },
48+
},
3749
},
3850

3951
presets: [
@@ -73,6 +85,10 @@ const config = {
7385
position: 'left',
7486
label: 'Tutorial',
7587
},
88+
{
89+
type: 'localeDropdown',
90+
position: 'right',
91+
},
7692
{
7793
href: 'https://github.com/NLipatov/TunGo',
7894
label: 'GitHub',

‎docs/TunGo/i18n/ar/code.json‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"homepage.cta": {
3+
"message": "ابدأ في دقائق"
4+
},
5+
"homepage.title": {
6+
"message": "VPN مفتوح المصدر بسيط وسريع وآمن"
7+
},
8+
"homepage.description": {
9+
"message": "أمّن اتصالك مع TunGo: VPN خفيف وسريع ومفتوح المصدر مبني بـ Go باستخدام تشفير حديث."
10+
},
11+
"feature.cpuFast.title": {
12+
"message": "سريع المعالجة"
13+
},
14+
"feature.cpuFast.description": {
15+
"message": "بدون تخصيصات ذاكرة وقت التشغيل. استخدام CPU ضئيل تحت الحمل."
16+
},
17+
"feature.ramEfficient.title": {
18+
"message": "فعال الذاكرة"
19+
},
20+
"feature.ramEfficient.description": {
21+
"message": "≈5–15 ميجابايت RSS تحت الحمل، ≈5–8 ميجابايت في الخمول"
22+
},
23+
"feature.secure.title": {
24+
"message": "آمن"
25+
},
26+
"feature.secure.description": {
27+
"message": "نفق من طرف إلى طرف مع تشفير ChaCha20"
28+
},
29+
"feature.multiTransport.title": {
30+
"message": "دعم النقل المتعدد"
31+
},
32+
"feature.multiTransport.description": {
33+
"message": "UDP — أداء عالي، TCP — بديل موثوق، WebSocket/WSS — وضع التخفي"
34+
},
35+
"feature.platforms.title": {
36+
"message": "المنصات المدعومة"
37+
},
38+
"feature.platforms.description": {
39+
"message": "Linux (عميل وخادم)، macOS (عميل)، Windows (عميل)"
40+
},
41+
"feature.openSource.title": {
42+
"message": "مفتوح المصدر"
43+
},
44+
"feature.openSource.description": {
45+
"message": "الرخصة: AGPLv3"
46+
}
47+
}

‎docs/TunGo/i18n/ar/docusaurus-plugin-content-docs/current/1. QuickStart.mdx‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
# 🚀 البدء السريع
5+
6+
قم بتشغيل خادم وعميل TunGo في دقائق.
7+
8+
---
9+
10+
## 🖥️ إعداد الخادم
11+
12+
1️⃣ **التحميل والتثبيت**
13+
<Tabs>
14+
<TabItem value="linux" label="Linux amd64" default>
15+
```bash
16+
wget https://github.com/NLipatov/TunGo/releases/latest/download/tungo-linux-amd64 -O tungo
17+
chmod +x tungo
18+
sudo mv tungo /usr/local/bin/
19+
```
20+
</TabItem>
21+
</Tabs>
22+
23+
2️⃣ **إنشاء إعدادات العميل**
24+
```bash
25+
sudo tungo s gen
26+
```
27+
> انسخ الإعدادات المطبوعة لعميلك.
28+
29+
3️⃣ **تشغيل الخادم**
30+
```bash
31+
sudo tungo
32+
```
33+
34+
:::tip خدمة systemd للخادم (Linux)
35+
راجع <a href="/docs/Advanced/Linux/Setup server systemd unit">هذا الدليل</a> لتشغيل TunGo كخدمة systemd (بدء تلقائي/إعادة تشغيل عند الإقلاع).
36+
:::
37+
---
38+
39+
## 🖥️ إعداد العميل
40+
41+
1️⃣ التحميل والتثبيت
42+
<Tabs>
43+
<TabItem value="linux-amd64" label="Linux amd64" default>
44+
```bash
45+
wget https://github.com/NLipatov/TunGo/releases/latest/download/tungo-linux-amd64 -O tungo
46+
chmod +x tungo
47+
sudo mv tungo /usr/local/bin/
48+
```
49+
50+
:::tip خدمة systemd للعميل (Linux)
51+
راجع <a href="/docs/Advanced/Linux/Setup client systemd unit">هذا الدليل</a> لتشغيل TunGo كخدمة systemd (بدء تلقائي/إعادة تشغيل عند الإقلاع).
52+
:::
53+
</TabItem>
54+
<TabItem value="linux-arm64" label="Linux arm64" default>
55+
```bash
56+
wget https://github.com/NLipatov/TunGo/releases/latest/download/tungo-linux-arm64 -O tungo
57+
chmod +x tungo
58+
sudo mv tungo /usr/local/bin/
59+
```
60+
61+
:::tip خدمة systemd للعميل (Linux)
62+
راجع <a href="/docs/Advanced/Linux/Setup client systemd unit">هذا الدليل</a> لتشغيل TunGo كخدمة systemd (بدء تلقائي/إعادة تشغيل عند الإقلاع).
63+
:::
64+
</TabItem>
65+
<TabItem value="macos-arm64" label="macOS Apple Silicon">
66+
```bash
67+
curl -L -o tungo https://github.com/NLipatov/TunGo/releases/latest/download/tungo-darwin-arm64
68+
sudo mkdir -p /usr/local/bin
69+
chmod +x tungo
70+
sudo mv tungo /usr/local/bin/
71+
```
72+
</TabItem>
73+
<TabItem value="macos-amd64" label="macOS Intel">
74+
```bash
75+
curl -L -o tungo https://github.com/NLipatov/TunGo/releases/latest/download/tungo-darwin-amd64
76+
sudo mkdir -p /usr/local/bin
77+
chmod +x tungo
78+
sudo mv tungo /usr/local/bin/
79+
```
80+
</TabItem>
81+
<TabItem value="windows amd64" label="Windows amd64">
82+
قم بالتحميل والتثبيت من [صفحة الإصدارات](https://github.com/NLipatov/TunGo/releases).
83+
</TabItem>
84+
</Tabs>
85+
86+
2️⃣ تشغيل النفق
87+
<Tabs>
88+
<TabItem value="unix" label="Linux/macOS" default>
89+
```bash
90+
sudo tungo
91+
```
92+
</TabItem>
93+
<TabItem value="windows" label="Windows">
94+
قم بتشغيل TunGo كمسؤول.
95+
</TabItem>
96+
</Tabs>
97+
98+
---
99+
100+
تهانينا! نفقك الآمن يعمل الآن.
101+

‎docs/TunGo/i18n/ar/docusaurus-plugin-content-docs/current/2. introduction to TunGo.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# TunGo: ما هو؟
6+
7+
<p align="center">
8+
<img alt="Two gophers dancing tango" src="https://i.ibb.co/GvSCJ01n/Tun-Go-logo.png" width="40%"/>
9+
</p>
10+
11+
**TunGo** هو VPN خفيف الوزن مصمم للاحتياجات الحديثة: **سريع**، **آمن**، و**مفتوح المصدر**.
12+
13+
### الميزات الرئيسية:
14+
- 🧩 **سهل النشر والإعداد**.
15+
- 🚀 **أداء عالي** — تخصيصات ذاكرة شبه معدومة في المسار الساخن (تم قياسها).
16+
- 📦 **بصمة ذاكرة صغيرة** — ≈5–15 ميجابايت **RSS** تحت الحمل، ≈5–8 ميجابايت في وضع الخمول.
17+
- 🔒 **تشفير من طرف إلى طرف** — X25519 (Curve25519 ECDH) لاتفاق المفاتيح؛ ChaCha20-Poly1305 (AEAD) لتشفير حركة المرور؛ Ed25519 للمصادقة.
18+
- ⚡ **مبني من الصفر** — بدون كود قديم، بدون تضخم. كود Go نظيف وقابل للقراءة.
19+
- 🌐 **جاهز لإنترنت الأشياء والأنظمة المدمجة** — محسّن للأجهزة الصغيرة والبيئات ذات الموارد المحدودة.
20+
- 🛡️ **مفتوح المصدر** — AGPL-3.0-only؛ تراخيص تجارية متاحة.

‎docs/TunGo/i18n/ar/docusaurus-plugin-content-docs/current/Advanced/Containerization/Docker/1. Server.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# خادم TunGo في Docker
2+
3+
**1️⃣ تحضير الصورة**
4+
- 🐳 الرسمية:
5+
```bash
6+
docker pull nlipatov/tungo:latest
7+
````
8+
9+
* 🛠 أو قم ببنائها بنفسك:
10+
11+
```bash
12+
cd src/
13+
docker buildx build -t nlipatov/tungo:latest .
14+
```
15+
16+
**2️⃣ تشغيل الحاوية**
17+
18+
```bash
19+
docker run -d \
20+
--name tungo \
21+
--restart always \
22+
--network host \
23+
--device /dev/net/tun \
24+
--cap-add NET_ADMIN \
25+
-e EnableUDP=true \
26+
-e EnableTCP=false \
27+
-v tungo_volume:/etc/tungo \
28+
nlipatov/tungo:latest
29+
```
30+
31+
**3️⃣ إنشاء إعدادات العميل**
32+
33+
```bash
34+
docker exec tungo bash -c "tungo s gen"
35+
```
36+
37+
> يمكنك أيضًا استخدام معرف الحاوية بدلاً من اسمها.
38+
39+
📖 راجع [إعداد العميل](/docs/QuickStart#%EF%B8%8F-client-setup) للخطوات التالية.

‎docs/TunGo/i18n/ar/docusaurus-plugin-content-docs/current/Advanced/Linux/1. Setup server systemd unit.mdx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
:::info
2+
ℹ️ استخدم وحدة systemd هذه لبدء TunGo تلقائيًا عند إعادة التشغيل.
3+
:::
4+
5+
## ⚙️ المتطلبات الأساسية
6+
7+
1) تم تثبيت TunGo كما هو موضح في [البدء السريع](/docs/QuickStart#%EF%B8%8F-server-setup).
8+
9+
10+
## 🛠️ الإعداد
11+
12+
1️⃣ **إنشاء ملف الخدمة**
13+
14+
```bash
15+
sudo vim /etc/systemd/system/tungo.service
16+
```
17+
18+
2️⃣ **لصق هذا التكوين**
19+
20+
```ini
21+
[Unit]
22+
Description=TunGo VPN Service
23+
After=network-online.target
24+
Wants=network-online.target
25+
26+
[Service]
27+
Type=simple
28+
ExecStart=tungo s
29+
User=root
30+
Restart=always
31+
RestartSec=5
32+
33+
[Install]
34+
WantedBy=multi-user.target
35+
```
36+
37+
3️⃣ **تفعيل الخدمة**
38+
39+
```bash
40+
sudo systemctl enable tungo.service
41+
```
42+
43+
4️⃣ **بدء الخدمة**
44+
45+
```bash
46+
sudo systemctl start tungo.service
47+
```
48+
49+
5️⃣ **التحقق من حالتها**
50+
51+
```bash
52+
sudo systemctl status tungo.service
53+
```

‎docs/TunGo/i18n/ar/docusaurus-plugin-content-docs/current/Advanced/Linux/2. Setup client systemd unit.mdx‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
:::info
2+
ℹ️ استخدم وحدة systemd هذه لبدء TunGo تلقائيًا عند إعادة التشغيل.
3+
:::
4+
5+
:::warning
6+
⚠️ تتطلب وحدة TunGo systemd التكوين الافتراضي (المستخدم آخر مرة).
7+
:::
8+
9+
## ⚙️ المتطلبات الأساسية
10+
11+
1) تم تثبيت TunGo كما هو موضح في [البدء السريع](/docs/QuickStart#%EF%B8%8F-client-setup).
12+
13+
## 🛠️ الإعداد
14+
15+
1️⃣ **إنشاء ملف الخدمة**
16+
```bash
17+
sudo vim /etc/systemd/system/tungo.service
18+
````
19+
20+
2️⃣ **لصق هذا التكوين**
21+
22+
```ini
23+
[Unit]
24+
Description=TunGo VPN Service
25+
After=network-online.target
26+
Wants=network-online.target
27+
28+
[Service]
29+
Type=simple
30+
ExecStart=tungo c
31+
User=root
32+
Restart=always
33+
RestartSec=5
34+
35+
[Install]
36+
WantedBy=multi-user.target
37+
```
38+
39+
3️⃣ **تفعيل الخدمة**
40+
41+
```bash
42+
sudo systemctl enable tungo.service
43+
```
44+
45+
4️⃣ **بدء الخدمة**
46+
47+
```bash
48+
sudo systemctl start tungo.service
49+
```
50+
51+
5️⃣ **التحقق من حالتها**
52+
53+
```bash
54+
sudo systemctl status tungo.service
55+
```

0 commit comments

Comments
 (0)