Skip to content

Commit 0b02490

Browse files
committed
feat: add minimum requirements
1 parent 3ddbf7a commit 0b02490

16 files changed

Lines changed: 501 additions & 7 deletions

File tree

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: Overview
3+
description: Command-line and Text User Interface tools for PasarGuard
4+
icon: Terminal
5+
---
6+
7+
# PasarGuard Interfaces
8+
9+
Modern command-line and text-based user interface tools for managing PasarGuard with efficiency and style.
10+
11+
## Overview
12+
13+
PasarGuard provides two powerful interface options for managing your proxy infrastructure:
14+
15+
- **CLI (Command-Line Interface)** - A modern, secure command-line tool built with Typer
16+
- **TUI (Text User Interface)** - An interactive, visual terminal interface built with Textual
17+
18+
Both tools offer comprehensive admin management, system monitoring, and efficient operations without needing a web browser.
19+
20+
## Why Use PasarGuard Interfaces?
21+
22+
PasarGuard Interfaces are designed for efficiency and flexibility:
23+
24+
- **Quick Access** - Manage your system directly from the terminal
25+
- **Secure Operations** - Interactive prompts with confirmations for safety
26+
- **Beautiful Output** - Rich formatting, tables, and visual feedback
27+
- **No Browser Required** - Full functionality without web access
28+
- **Automation Ready** - Perfect for scripts and automated workflows
29+
30+
## Quick Start
31+
32+
<Cards>
33+
<Card title="CLI Guide" href="/interfaces/cli">
34+
Learn how to use the command-line interface for admin management and system operations
35+
</Card>
36+
37+
<Card title="TUI Guide" href="/interfaces/tui">
38+
Explore the interactive text user interface with mouse and keyboard support
39+
</Card>
40+
</Cards>
41+
42+
## Key Features
43+
44+
### CLI Features
45+
46+
- 🎯 **Secure CLI** with beautiful output formatting
47+
- 📊 **Beautiful tables and panels** for data display
48+
- 🔒 **Secure admin management** with interactive prompts
49+
- 📈 **System status monitoring** and problem detection
50+
- ⌨️ **Interactive prompts** with confirmations for enhanced security
51+
52+
### TUI Features
53+
54+
- 🎯 **Interactive TUI** with mouse and keyboard support
55+
- 📱 **Responsive design** with dark mode support
56+
- ⌨️ **Keyboard shortcuts** for quick navigation
57+
- 🔄 **Real-time updates** and live data refresh
58+
- 📊 **Visual data display** with colors and formatting
59+
- 🔒 **Secure admin management** with visual feedback
60+
61+
## Getting Started
62+
63+
To start using PasarGuard interfaces, you can access them directly:
64+
65+
```bash
66+
# Access CLI
67+
pasarguard cli --help
68+
69+
# Access TUI
70+
pasarguard tui
71+
```
72+
73+
Both tools are included with PasarGuard installation and ready to use immediately.
74+
75+
## Use Cases
76+
77+
- **Server Management** - Manage admins and monitor system status
78+
- **Quick Operations** - Fast admin creation, modification, and deletion
79+
- **Remote Access** - Full control via SSH without web interface
80+
- **Automation** - Integrate into scripts and automated workflows
81+
- **Troubleshooting** - Quick diagnostics and system information
82+
83+
---
84+
85+
Ready to get started? Check out our [CLI guide](/interfaces/cli) or [TUI guide](/interfaces/tui) to begin managing PasarGuard from the command line!
86+

content/docs/en/interfaces/meta.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
2-
"title": "CLI & TUI",
3-
"description": "Command-line and Text User Interface tools",
2+
"title": "Interfaces",
3+
"description": "Interfaces tools for PasarGuard",
44
"pages": [
5+
"index",
56
"cli",
67
"tui"
78
],

content/docs/en/node/installation.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ description: Install PasarGuard Node using various methods
44
icon: Download
55
---
66

7+
## System Requirements
8+
9+
### Minimum Requirements
10+
11+
- **RAM:** 1 GB
12+
- **CPU:** 1 core
13+
- **Storage:** 10 GB
14+
15+
### Recommended Requirements
16+
17+
- **RAM:** 2 GB
18+
- **CPU:** 2 cores
19+
- **Storage:** 20 GB
20+
21+
---
22+
723
## Installation Methods
824

925
PasarGuard Node can be installed using multiple methods. Choose the one that best fits your needs.

content/docs/en/panel/installation.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@ description: Installation instructions for PasarGuard.
44
icon: Download
55
---
66

7+
## System Requirements
8+
9+
### Minimum Requirements
10+
11+
- **RAM:** 1 GB
12+
- **CPU:** 1 core
13+
- **Storage:** 10 GB
14+
15+
<Callout type="warning">
16+
**Important:** With minimum requirements, you may encounter issues with MySQL log files consuming disk space and running the TUI (Text User Interface). It's recommended to monitor disk usage regularly and consider upgrading if you experience problems.
17+
</Callout>
18+
19+
### Recommended Requirements
20+
21+
- **RAM:** 2 GB
22+
- **CPU:** 2 cores
23+
- **Storage:** 20 GB
24+
25+
---
26+
727
## Installation Options
828

929
PasarGuard Panel supports multiple database backends:
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: نمای کلی
3+
description: ابزارهای خط فرمان و رابط کاربری متنی برای PasarGuard
4+
icon: Terminal
5+
---
6+
7+
# رابط‌های PasarGuard
8+
9+
ابزارهای مدرن خط فرمان و رابط کاربری متنی برای مدیریت PasarGuard با کارایی و زیبایی.
10+
11+
## نمای کلی
12+
13+
PasarGuard دو گزینه رابط قدرتمند برای مدیریت زیرساخت پروکسی شما ارائه می‌دهد:
14+
15+
- **CLI (رابط خط فرمان)** - یک ابزار خط فرمان مدرن و امن ساخته شده با Typer
16+
- **TUI (رابط کاربری متنی)** - یک رابط ترمینال تعاملی و بصری ساخته شده با Textual
17+
18+
هر دو ابزار مدیریت جامع ادمین، مانیتورینگ سیستم و عملیات کارآمد را بدون نیاز به مرورگر وب ارائه می‌دهند.
19+
20+
## چرا از رابط‌های PasarGuard استفاده کنیم؟
21+
22+
رابط‌های PasarGuard برای کارایی و انعطاف‌پذیری طراحی شده‌اند:
23+
24+
- **دسترسی سریع** - مدیریت سیستم مستقیماً از ترمینال
25+
- **عملیات امن** - پرامپت‌های تعاملی با تأیید برای امنیت
26+
- **خروجی زیبا** - فرمت‌بندی غنی، جداول و بازخورد بصری
27+
- **بدون نیاز به مرورگر** - عملکرد کامل بدون دسترسی وب
28+
- **آماده خودکارسازی** - مناسب برای اسکریپت‌ها و گردش‌های کاری خودکار
29+
30+
## شروع سریع
31+
32+
<Cards>
33+
<Card title="راهنمای CLI" href="/interfaces/cli">
34+
یاد بگیرید چگونه از رابط خط فرمان برای مدیریت ادمین و عملیات سیستم استفاده کنید
35+
</Card>
36+
37+
<Card title="راهنمای TUI" href="/interfaces/tui">
38+
رابط کاربری متنی تعاملی با پشتیبانی از ماوس و صفحه کلید را کاوش کنید
39+
</Card>
40+
</Cards>
41+
42+
## ویژگی‌های کلیدی
43+
44+
### ویژگی‌های CLI
45+
46+
- 🎯 **CLI امن** با فرمت‌بندی خروجی زیبا
47+
- 📊 **جداول و پنل‌های زیبا** برای نمایش داده‌ها
48+
- 🔒 **مدیریت امن ادمین‌ها** با پرامپت‌های تعاملی
49+
- 📈 **مانیتورینگ وضعیت سیستم** و تشخیص مشکلات
50+
- ⌨️ **پرامپت‌های تعاملی** با تأیید برای امنیت بیشتر
51+
52+
### ویژگی‌های TUI
53+
54+
- 🎯 **TUI تعاملی** با پشتیبانی از ماوس و صفحه کلید
55+
- 📱 **طراحی واکنش‌گرا** با پشتیبانی از حالت تاریک
56+
- ⌨️ **میانبرهای صفحه کلید** برای ناوبری سریع
57+
- 🔄 **به‌روزرسانی لحظه‌ای** و رفرش زنده داده‌ها
58+
- 📊 **نمایش بصری داده‌ها** با رنگ‌ها و فرمت‌بندی
59+
- 🔒 **مدیریت امن ادمین‌ها** با بازخورد بصری
60+
61+
## شروع کار
62+
63+
برای شروع استفاده از رابط‌های PasarGuard، می‌توانید مستقیماً به آن‌ها دسترسی داشته باشید:
64+
65+
```bash
66+
# دسترسی به CLI
67+
pasarguard cli --help
68+
69+
# دسترسی به TUI
70+
pasarguard tui
71+
```
72+
73+
هر دو ابزار همراه با نصب PasarGuard گنجانده شده‌اند و بلافاصله آماده استفاده هستند.
74+
75+
## موارد استفاده
76+
77+
- **مدیریت سرور** - مدیریت ادمین‌ها و مانیتورینگ وضعیت سیستم
78+
- **عملیات سریع** - ایجاد، تغییر و حذف سریع ادمین
79+
- **دسترسی از راه دور** - کنترل کامل از طریق SSH بدون رابط وب
80+
- **خودکارسازی** - ادغام در اسکریپت‌ها و گردش‌های کاری خودکار
81+
- **عیب‌یابی** - تشخیص سریع و اطلاعات سیستم
82+
83+
---
84+
85+
آماده شروع هستید؟ [راهنمای CLI](/interfaces/cli) یا [راهنمای TUI](/interfaces/tui) ما را بررسی کنید تا مدیریت PasarGuard از خط فرمان را شروع کنید!
86+

content/docs/fa/interfaces/meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
2-
"title": "CLI و TUI",
2+
"title": "رابط‌ها",
33
"description": "ابزارهای خط فرمان و رابط کاربری متنی",
44
"pages": [
5+
"index",
56
"cli",
67
"tui"
78
],

content/docs/fa/node/installation.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@ description: نصب نود PasarGuard با روش‌های مختلف
44
icon: Download
55
---
66

7+
## نیازمندی‌های سیستم
8+
9+
### حداقل نیازمندی‌ها
10+
11+
- **RAM:** 1 GB
12+
- **CPU:** 1 هسته
13+
- **فضای ذخیره‌سازی:** 10 GB
14+
15+
16+
### نیازمندی‌های پیشنهادی
17+
18+
- **RAM:** 2 GB
19+
- **CPU:** 2 هسته
20+
- **فضای ذخیره‌سازی:** 20 GB
21+
22+
---
23+
724
## روش‌های نصب
825

926
نود PasarGuard رو می‌تونی با چند روش مختلف نصب کنی. اون روشی رو انتخاب کن که بیشتر برات راحته.

content/docs/fa/panel/installation.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@ description: دستورالعمل‌های نصب PasarGuard.
44
icon: Download
55
---
66

7+
## نیازمندی‌های سیستم
8+
9+
### حداقل نیازمندی‌ها
10+
11+
- **RAM:** 1 GB
12+
- **CPU:** 1 هسته
13+
- **فضای ذخیره‌سازی:** 10 GB
14+
15+
<Callout type="warning">
16+
**مهم:** با حداقل نیازمندی‌ها، ممکن است با مشکلات فایل‌های لاگ MySQL که فضای دیسک را مصرف می‌کنند و اجرای TUI (رابط کاربری متنی) مواجه شوید. توصیه می‌شود استفاده از دیسک را به طور منظم بررسی کنید و در صورت بروز مشکل، ارتقا را در نظر بگیرید.
17+
</Callout>
18+
19+
### نیازمندی‌های پیشنهادی
20+
21+
- **RAM:** 2 GB
22+
- **CPU:** 2 هسته
23+
- **فضای ذخیره‌سازی:** 20 GB
24+
25+
---
26+
727
## گزینه‌های نصب
828

929
پنل PasarGuard از چندین دیتابیس پشتیبانی می‌کنه:
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: Обзор
3+
description: Инструменты командной строки и текстового пользовательского интерфейса для PasarGuard
4+
icon: Terminal
5+
---
6+
7+
# Интерфейсы PasarGuard
8+
9+
Современные инструменты командной строки и текстового пользовательского интерфейса для управления PasarGuard с эффективностью и стилем.
10+
11+
## Обзор
12+
13+
PasarGuard предоставляет два мощных варианта интерфейса для управления вашей прокси-инфраструктурой:
14+
15+
- **CLI (Интерфейс командной строки)** - Современный, безопасный инструмент командной строки, созданный с помощью Typer
16+
- **TUI (Текстовый пользовательский интерфейс)** - Интерактивный, визуальный интерфейс терминала, созданный с помощью Textual
17+
18+
Оба инструмента предлагают комплексное управление администраторами, мониторинг системы и эффективные операции без необходимости веб-браузера.
19+
20+
## Зачем использовать интерфейсы PasarGuard?
21+
22+
Интерфейсы PasarGuard разработаны для эффективности и гибкости:
23+
24+
- **Быстрый доступ** - Управляйте системой напрямую из терминала
25+
- **Безопасные операции** - Интерактивные запросы с подтверждениями для безопасности
26+
- **Красивый вывод** - Расширенное форматирование, таблицы и визуальная обратная связь
27+
- **Без браузера** - Полная функциональность без веб-доступа
28+
- **Готовность к автоматизации** - Идеально для скриптов и автоматизированных рабочих процессов
29+
30+
## Быстрый старт
31+
32+
<Cards>
33+
<Card title="Руководство по CLI" href="/interfaces/cli">
34+
Узнайте, как использовать интерфейс командной строки для управления администраторами и системными операциями
35+
</Card>
36+
37+
<Card title="Руководство по TUI" href="/interfaces/tui">
38+
Изучите интерактивный текстовый пользовательский интерфейс с поддержкой мыши и клавиатуры
39+
</Card>
40+
</Cards>
41+
42+
## Ключевые возможности
43+
44+
### Возможности CLI
45+
46+
- 🎯 **Безопасный CLI** с красивым форматированием вывода
47+
- 📊 **Красивые таблицы и панели** для отображения данных
48+
- 🔒 **Безопасное управление администраторами** с интерактивными запросами
49+
- 📈 **Мониторинг состояния системы** и обнаружение проблем
50+
- ⌨️ **Интерактивные запросы** с подтверждениями для повышения безопасности
51+
52+
### Возможности TUI
53+
54+
- 🎯 **Интерактивный TUI** с поддержкой мыши и клавиатуры
55+
- 📱 **Адаптивный дизайн** с поддержкой темного режима
56+
- ⌨️ **Горячие клавиши** для быстрой навигации
57+
- 🔄 **Обновления в реальном времени** и живое обновление данных
58+
- 📊 **Визуальное отображение данных** с цветами и форматированием
59+
- 🔒 **Безопасное управление администраторами** с визуальной обратной связью
60+
61+
## Начало работы
62+
63+
Чтобы начать использовать интерфейсы PasarGuard, вы можете получить к ним доступ напрямую:
64+
65+
```bash
66+
# Доступ к CLI
67+
pasarguard cli --help
68+
69+
# Доступ к TUI
70+
pasarguard tui
71+
```
72+
73+
Оба инструмента включены в установку PasarGuard и готовы к использованию сразу.
74+
75+
## Случаи использования
76+
77+
- **Управление сервером** - Управление администраторами и мониторинг состояния системы
78+
- **Быстрые операции** - Быстрое создание, изменение и удаление администраторов
79+
- **Удаленный доступ** - Полный контроль через SSH без веб-интерфейса
80+
- **Автоматизация** - Интеграция в скрипты и автоматизированные рабочие процессы
81+
- **Устранение неполадок** - Быстрая диагностика и информация о системе
82+
83+
---
84+
85+
Готовы начать? Ознакомьтесь с нашим [руководством по CLI](/interfaces/cli) или [руководством по TUI](/interfaces/tui), чтобы начать управлять PasarGuard из командной строки!
86+

content/docs/ru/interfaces/meta.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
2-
"title": "CLI & TUI",
3-
"description": "Command-line and Text User Interface tools",
2+
"title": "Интерфейсы",
3+
"description": "Инструменты командной строки и текстового пользовательского интерфейса",
44
"pages": [
5+
"index",
56
"cli",
67
"tui"
78
],

0 commit comments

Comments
 (0)