Skip to content

Commit 2c4e07a

Browse files
committed
docs: update README files to reflect new subscription template branding and installation instructions
1 parent c148be5 commit 2c4e07a

File tree

6 files changed

+208
-133
lines changed

6 files changed

+208
-133
lines changed

README.fa.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,56 @@
1-
# قالب پاسارگارد
1+
# قالب اشتراک PasarGuard
22

3-
قالب داشبورد کاربری مدرن و واکنش‌گرا برای پاسارگارد با پشتیبانی چندزبانه (انگلیسی، فارسی، چینی، روسی).
3+
قالب صفحه اشتراک واکنش‌گرا برای PasarGuard.
44

55
<p align="center">
6-
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/en.png" alt="رابط کاربری انگلیسی" width="40%">
7-
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/fa.png" alt="رابط کاربری فارسی" width="30%">
6+
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/en.png" alt="English UI" width="40%">
7+
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/fa.png" alt="Persian UI" width="30%">
88
</p>
99

10-
ساخته شده با React + TypeScript + Vite، با ویژگی‌های به‌روزرسانی داده‌های بلادرنگ، تولید کد QR و کامپوننت‌های رابط کاربری زیبا.
10+
## امکانات
1111

12-
## ✨ ویژگی‌ها
12+
- زبان‌ها: `en`، `fa`، `zh`، `ru`
13+
- امکان تغییر زبان توسط کاربر
14+
- طراحی واکنش‌گرا
15+
- حالت تاریک
16+
- QR برای لینک‌های اتصال
17+
- کپی با یک کلیک
1318

14-
- 🌍 پشتیبانی چندزبانه (EN, FA, ZH, RU) - کاربران می‌توانند زبان را در رابط کاربری تغییر دهند
15-
- 📱 طراحی کاملاً واکنش‌گرا
16-
- 🎨 رابط کاربری مدرن با پشتیبانی از حالت تاریک
17-
- 🔄 به‌روزرسانی داده‌های بلادرنگ (فاصله ۱۰ ثانیه)
18-
- 📊 نمودارهای استفاده از ترافیک
19-
- 🔗 تولید کد QR برای لینک‌های اتصال
20-
- 📋 کپی یک‌کلیکی به کلیپ‌بورد
21-
- ⚡ سریع و سبک
19+
## نصب سریع (پیشنهادی)
2220

23-
---
24-
25-
## 📦 نصب
26-
27-
**۱. دانلود قالب**
28-
29-
هر نسخه شامل نسخه‌های پیش‌فرض با پیشوند زبان است. نسخه پیش‌فرض از فارسی به عنوان زبان پیش‌فرض استفاده می‌کند. کاربران می‌توانند زبان را در رابط کاربری تغییر دهند، اما می‌توانید یک پیش‌فرض دیگر تنظیم کنید:
21+
اجرای اسکریپت نصب (با انتخاب زبان پیش‌فرض):
3022

3123
```sh
32-
# دانلود نسخه پیش‌فرض (پیش‌فرض فارسی)
33-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/index.html
34-
35-
# یا دانلود یک زبان پیش‌فرض خاص (en, fa, zh, ru)
36-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/en.html
24+
curl -fsSL https://raw.githubusercontent.com/PasarGuard/subscription-template/main/install.sh | sudo bash -s -- --lang fa
3725
```
3826

39-
**۲. پیکربندی پاسارگارد**
27+
مقادیر معتبر `--lang`: `en`، `fa`، `zh`، `ru`
28+
29+
## نصب دستی
30+
31+
1. دانلود قالب:
4032

4133
```sh
42-
echo 'CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"' | sudo tee -a /opt/pasarguard/.env
43-
echo 'SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"' | sudo tee -a /opt/pasarguard/.env
34+
sudo mkdir -p /var/lib/pasarguard/templates/subscription
35+
sudo wget -O /var/lib/pasarguard/templates/subscription/index.html \
36+
https://github.com/PasarGuard/subscription-template/releases/latest/download/index.html
4437
```
4538

46-
یا به صورت دستی فایل `/opt/pasarguard/.env` را ویرایش کرده و از حالت کامنت خارج کنید:
47-
```
39+
2. تنظیم PasarGuard در فایل `/opt/pasarguard/.env`:
40+
41+
```dotenv
4842
CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"
4943
SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"
5044
```
5145

52-
**۳. راه‌اندازی مجدد پاسارگارد**
46+
3. راه‌اندازی مجدد:
5347

5448
```sh
5549
pasarguard restart
5650
```
5751

52+
## زبان‌های دیگر
53+
54+
- [English](README.md)
55+
- [Русский (Russian)](README.ru.md)
56+
- [中文 (Chinese)](README.zh.md)

README.md

Lines changed: 26 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,56 @@
1-
# PasarGuard Template
1+
# PasarGuard Subscription Template
22

3-
A modern, responsive user dashboard template for PasarGuard with multi-language support (English, Persian, Chinese, Russian).
3+
Responsive subscription page template for PasarGuard.
44

55
<p align="center">
66
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/en.png" alt="English UI" width="40%">
77
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/fa.png" alt="Persian UI" width="30%">
88
</p>
99

10-
Built with React + TypeScript + Vite, featuring real-time data updates, QR code generation, and beautiful UI components.
10+
## Features
1111

12-
## ✨ Features
12+
- Languages: `en`, `fa`, `zh`, `ru`
13+
- User can switch language in UI
14+
- Responsive layout
15+
- Dark mode
16+
- QR code for connection links
17+
- One-click copy
1318

14-
- 🌍 Multi-language support (EN, FA, ZH, RU) - users can change language in the UI
15-
- 📱 Fully responsive design
16-
- 🎨 Modern UI with dark mode support
17-
- 🔄 Real-time data updates (10s interval)
18-
- 📊 Traffic usage charts
19-
- 🔗 QR code generation for connection links
20-
- 📋 One-click copy to clipboard
21-
- ⚡ Fast and lightweight
19+
## Quick Start (Recommended)
2220

23-
---
24-
25-
## 📦 Installation
26-
27-
**1. Download the template**
28-
29-
Each release includes language-prefixed fallback versions. The default version uses Persian (fa) as the fallback language. Users can change their language in the UI, but you can set a different fallback:
21+
Run installer script (choose your fallback language):
3022

3123
```sh
32-
# Download default version (Persian fallback)
33-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/index.html
34-
35-
# Or download a specific fallback language (en, fa, zh, ru)
36-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/en.html
24+
curl -fsSL https://raw.githubusercontent.com/PasarGuard/subscription-template/main/install.sh | sudo bash -s -- --lang fa
3725
```
3826

39-
**2. Configure PasarGuard**
27+
Supported values for `--lang`: `en`, `fa`, `zh`, `ru`
28+
29+
## Manual Install
30+
31+
1. Download template:
4032

4133
```sh
42-
echo 'CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"' | sudo tee -a /opt/pasarguard/.env
43-
echo 'SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"' | sudo tee -a /opt/pasarguard/.env
34+
sudo mkdir -p /var/lib/pasarguard/templates/subscription
35+
sudo wget -O /var/lib/pasarguard/templates/subscription/index.html \
36+
https://github.com/PasarGuard/subscription-template/releases/latest/download/index.html
4437
```
4538

46-
Or manually edit `/opt/pasarguard/.env` and uncomment:
47-
```
39+
2. Configure PasarGuard in `/opt/pasarguard/.env`:
40+
41+
```dotenv
4842
CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"
4943
SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"
5044
```
5145

52-
**3. Restart PasarGuard**
46+
3. Restart:
5347

5448
```sh
5549
pasarguard restart
5650
```
5751

58-
---
59-
60-
## 📖 Other Languages
52+
## Other Languages
6153

6254
- [فارسی (Persian)](README.fa.md)
63-
- [中文 (Chinese)](README.zh.md)
6455
- [Русский (Russian)](README.ru.md)
56+
- [中文 (Chinese)](README.zh.md)

README.ru.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,56 @@
1-
# Шаблон PasarGuard
1+
# Шаблон подписки PasarGuard
22

3-
Современный адаптивный шаблон пользовательской панели для PasarGuard с поддержкой нескольких языков (английский, персидский, китайский, русский).
3+
Адаптивный шаблон страницы подписки для PasarGuard.
44

55
<p align="center">
6-
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/en.png" alt="Английский интерфейс" width="40%">
7-
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/fa.png" alt="Персидский интерфейс" width="30%">
6+
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/en.png" alt="English UI" width="40%">
7+
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/fa.png" alt="Persian UI" width="30%">
88
</p>
99

10-
Построен на React + TypeScript + Vite, с функциями обновления данных в реальном времени, генерации QR-кодов и красивыми компонентами интерфейса.
10+
## Возможности
1111

12-
## ✨ Возможности
12+
- Языки: `en`, `fa`, `zh`, `ru`
13+
- Пользователь может менять язык в интерфейсе
14+
- Адаптивная верстка
15+
- Темный режим
16+
- QR-код для ссылок подключения
17+
- Копирование в один клик
1318

14-
- 🌍 Поддержка нескольких языков (EN, FA, ZH, RU) - пользователи могут изменить язык в интерфейсе
15-
- 📱 Полностью адаптивный дизайн
16-
- 🎨 Современный интерфейс с поддержкой темной темы
17-
- 🔄 Обновление данных в реальном времени (интервал 10 секунд)
18-
- 📊 Графики использования трафика
19-
- 🔗 Генерация QR-кодов для ссылок подключения
20-
- 📋 Одним кликом копирование в буфер обмена
21-
- ⚡ Быстрый и легкий
19+
## Быстрый старт (рекомендуется)
2220

23-
---
24-
25-
## 📦 Установка
26-
27-
**1. Загрузите шаблон**
28-
29-
Каждый релиз включает версии по умолчанию с языковыми префиксами. Версия по умолчанию использует персидский (fa) в качестве языка по умолчанию. Пользователи могут изменить язык в интерфейсе, но вы можете установить другой язык по умолчанию:
21+
Запустите скрипт установки (выберите язык по умолчанию):
3022

3123
```sh
32-
# Загрузить версию по умолчанию (персидский по умолчанию)
33-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/index.html
34-
35-
# Или загрузить конкретный язык по умолчанию (en, fa, zh, ru)
36-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/ru.html
24+
curl -fsSL https://raw.githubusercontent.com/PasarGuard/subscription-template/main/install.sh | sudo bash -s -- --lang ru
3725
```
3826

39-
**2. Настройте PasarGuard**
27+
Поддерживаемые значения `--lang`: `en`, `fa`, `zh`, `ru`
28+
29+
## Установка вручную
30+
31+
1. Скачайте шаблон:
4032

4133
```sh
42-
echo 'CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"' | sudo tee -a /opt/pasarguard/.env
43-
echo 'SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"' | sudo tee -a /opt/pasarguard/.env
34+
sudo mkdir -p /var/lib/pasarguard/templates/subscription
35+
sudo wget -O /var/lib/pasarguard/templates/subscription/index.html \
36+
https://github.com/PasarGuard/subscription-template/releases/latest/download/ru.html
4437
```
4538

46-
Или вручную отредактируйте `/opt/pasarguard/.env` и раскомментируйте:
47-
```
39+
2. Настройте PasarGuard в `/opt/pasarguard/.env`:
40+
41+
```dotenv
4842
CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"
4943
SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"
5044
```
5145

52-
**3. Перезапустите PasarGuard**
46+
3. Перезапустите:
5347

5448
```sh
5549
pasarguard restart
5650
```
5751

52+
## Другие языки
53+
54+
- [English](README.md)
55+
- [فارسی (Persian)](README.fa.md)
56+
- [中文 (Chinese)](README.zh.md)

README.zh.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,56 @@
1-
# PasarGuard 模板
1+
# PasarGuard 订阅模板
22

3-
适用于 PasarGuard 的现代化响应式用户仪表板模板,支持多语言(英语、波斯语、中文、俄语)
3+
PasarGuard 的响应式订阅页面模板
44

55
<p align="center">
6-
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/en.png" alt="英文界面" width="40%">
7-
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/fa.png" alt="波斯语界面" width="30%">
6+
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/en.png" alt="English UI" width="40%">
7+
<img src="https://raw.githubusercontent.com/PasarGuard/subscription-template/refs/heads/main/screenshots/fa.png" alt="Persian UI" width="30%">
88
</p>
99

10-
使用 React + TypeScript + Vite 构建,具有实时数据更新、QR 码生成和美观的 UI 组件。
10+
## 功能
1111

12-
## ✨ 功能
12+
- 语言:`en``fa``zh``ru`
13+
- 用户可在界面中切换语言
14+
- 响应式布局
15+
- 深色模式
16+
- 连接链接 QR 码
17+
- 一键复制
1318

14-
- 🌍 多语言支持(EN, FA, ZH, RU)- 用户可在界面中更改语言
15-
- 📱 完全响应式设计
16-
- 🎨 支持深色模式的现代 UI
17-
- 🔄 实时数据更新(10 秒间隔)
18-
- 📊 流量使用图表
19-
- 🔗 连接链接的 QR 码生成
20-
- 📋 一键复制到剪贴板
21-
- ⚡ 快速轻量
19+
## 快速安装(推荐)
2220

23-
---
24-
25-
## 📦 安装
26-
27-
**1. 下载模板**
28-
29-
每个版本都包含带语言前缀的默认版本。默认版本使用波斯语(fa)作为默认语言。用户可以在界面中更改语言,但您可以设置不同的默认语言:
21+
运行安装脚本(选择默认语言):
3022

3123
```sh
32-
# 下载默认版本(波斯语默认)
33-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/index.html
34-
35-
# 或下载特定默认语言(en, fa, zh, ru)
36-
sudo wget -N -O /var/lib/pasarguard/templates/subscription/index.html https://github.com/PasarGuard/subscription-template/releases/latest/download/zh.html
24+
curl -fsSL https://raw.githubusercontent.com/PasarGuard/subscription-template/main/install.sh | sudo bash -s -- --lang zh
3725
```
3826

39-
**2. 配置 PasarGuard**
27+
`--lang` 支持:`en``fa``zh``ru`
28+
29+
## 手动安装
30+
31+
1. 下载模板:
4032

4133
```sh
42-
echo 'CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"' | sudo tee -a /opt/pasarguard/.env
43-
echo 'SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"' | sudo tee -a /opt/pasarguard/.env
34+
sudo mkdir -p /var/lib/pasarguard/templates/subscription
35+
sudo wget -O /var/lib/pasarguard/templates/subscription/index.html \
36+
https://github.com/PasarGuard/subscription-template/releases/latest/download/zh.html
4437
```
4538

46-
或手动编辑 `/opt/pasarguard/.env` 并取消注释:
47-
```
39+
2.`/opt/pasarguard/.env` 中配置 PasarGuard:
40+
41+
```dotenv
4842
CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"
4943
SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"
5044
```
5145

52-
**3. 重启 PasarGuard**
46+
3. 重启
5347

5448
```sh
5549
pasarguard restart
5650
```
5751

52+
## 其他语言
53+
54+
- [English](README.md)
55+
- [فارسی (Persian)](README.fa.md)
56+
- [Русский (Russian)](README.ru.md)

0 commit comments

Comments
 (0)