From 3a4088020a1f7e5731ad23c86a22278c37da7e27 Mon Sep 17 00:00:00 2001 From: Mahdi Butcher Date: Sat, 1 Aug 2026 22:29:41 +0000 Subject: [PATCH 1/2] fix(docs): site audit cleanup - update canonical domain, fix SSL links, and localize navigation --- content/docs/en/panel/installation.mdx | 2 +- content/docs/fa/panel/installation.mdx | 2 +- content/docs/ru/learn/meta.json | 4 ++-- content/docs/ru/panel/installation.mdx | 2 +- content/docs/zh/learn/meta.json | 4 ++-- content/docs/zh/panel/installation.mdx | 2 +- src/app/[lang]/[...slug]/page.tsx | 2 +- src/app/[lang]/page.tsx | 4 ++-- src/app/layout.tsx | 6 +++--- src/data/community-projects.ts | 2 +- src/lib/og-image-utils.ts | 4 ++-- 11 files changed, 17 insertions(+), 17 deletions(-) diff --git a/content/docs/en/panel/installation.mdx b/content/docs/en/panel/installation.mdx index 777f135..1326265 100644 --- a/content/docs/en/panel/installation.mdx +++ b/content/docs/en/panel/installation.mdx @@ -77,7 +77,7 @@ Once the installation is complete: - The PasarGuard files will be located at `/opt/pasarguard` - The configuration file can be found at `/opt/pasarguard/.env` (refer to [configurations](#configuration) section to see variables) - The data files will be placed at `/var/lib/pasarguard` -- For security reasons, the PasarGuard dashboard is not accessible via IP address. Therefore, you must [obtain SSL certificate](https://PasarGuard.github.io/PasarGuard/en/examples/issue-ssl-certificate) and access your PasarGuard dashboard by opening a web browser and navigating to `https://YOUR_DOMAIN:8000/dashboard/` (replace YOUR_DOMAIN with your actual domain) +- For security reasons, the PasarGuard dashboard is not accessible via IP address. Therefore, you must [obtain SSL certificate](/en/learn/ssl-certificate-cli) and access your PasarGuard dashboard by opening a web browser and navigating to `https://YOUR_DOMAIN:8000/dashboard/` (replace YOUR_DOMAIN with your actual domain) - You can also use SSH port forwarding to access the PasarGuard dashboard locally without a domain. Replace `user@serverip` with your actual SSH username and server IP and Run the command below: ```bash diff --git a/content/docs/fa/panel/installation.mdx b/content/docs/fa/panel/installation.mdx index b087e39..ba4e435 100644 --- a/content/docs/fa/panel/installation.mdx +++ b/content/docs/fa/panel/installation.mdx @@ -77,7 +77,7 @@ icon: Download - فایل‌های PasarGuard تو `/opt/pasarguard` قرار می‌گیرن - فایل تنظیمات رو می‌تونید تو `/opt/pasarguard/.env` پیدا کنید (برای دیدن متغیرها به بخش [پیکربندی](#configuration) مراجعه کنید) - فایل‌های دیتا تو `/var/lib/pasarguard` ذخیره می‌شن -- برای امنیت، داشبورد PasarGuard با IP قابل دسترسی نیست. پس باید [گواهی SSL بگیرید](https://PasarGuard.github.io/PasarGuard/en/examples/issue-ssl-certificate) و بعد با مرورگر وب به `https://YOUR_DOMAIN:8000/dashboard/` برید (YOUR_DOMAIN رو با دامنه واقعی خودتون جایگزین کنید) +- برای امنیت، داشبورد PasarGuard با IP قابل دسترسی نیست. پس باید [گواهی SSL بگیرید](/fa/learn/ssl-certificate-cli) و بعد با مرورگر وب به `https://YOUR_DOMAIN:8000/dashboard/` برید (YOUR_DOMAIN رو با دامنه واقعی خودتون جایگزین کنید) - می‌تونید از SSH port forwarding هم استفاده کنید تا بدون دامنه به داشبورد دسترسی داشته باشید. `user@serverip` رو با یوزرنیم SSH و IP سرورتون عوض کنید و این دستور رو بزنید: ```bash diff --git a/content/docs/ru/learn/meta.json b/content/docs/ru/learn/meta.json index 843495a..bfea6c7 100644 --- a/content/docs/ru/learn/meta.json +++ b/content/docs/ru/learn/meta.json @@ -1,6 +1,6 @@ { - "title": "Learn", - "description": "Step-by-step guides for advanced configurations", + "title": "Руководства", + "description": "Пошаговые руководства по расширенной настройке", "pages": [ "ssl-certificate-cli", "ssl-activation-cli", diff --git a/content/docs/ru/panel/installation.mdx b/content/docs/ru/panel/installation.mdx index a0b748b..eb00e98 100644 --- a/content/docs/ru/panel/installation.mdx +++ b/content/docs/ru/panel/installation.mdx @@ -77,7 +77,7 @@ PasarGuard Panel поддерживает несколько бэкендов б - Файлы PasarGuard будут расположены в `/opt/pasarguard` - Файл конфигурации можно найти в `/opt/pasarguard/.env` (обратитесь к разделу [конфигурации](#configuration) для просмотра переменных) - Файлы данных будут размещены в `/var/lib/pasarguard` -- По соображениям безопасности, панель управления PasarGuard недоступна по IP-адресу. Поэтому вы должны [получить SSL-сертификат](https://PasarGuard.github.io/PasarGuard/en/examples/issue-ssl-certificate) и получить доступ к панели управления PasarGuard, открыв веб-браузер и перейдя по адресу `https://YOUR_DOMAIN:8000/dashboard/` (замените YOUR_DOMAIN на ваш фактический домен) +- По соображениям безопасности, панель управления PasarGuard недоступна по IP-адресу. Поэтому вы должны [получить SSL-сертификат](/ru/learn/ssl-certificate-cli) и получить доступ к панели управления PasarGuard, открыв веб-браузер и перейдя по адресу `https://YOUR_DOMAIN:8000/dashboard/` (замените YOUR_DOMAIN на ваш фактический домен) - Вы также можете использовать переадресацию портов SSH для доступа к панели управления PasarGuard локально без домена. Замените `user@serverip` на ваше фактическое имя пользователя SSH и IP-адрес сервера и выполните команду ниже: ```bash diff --git a/content/docs/zh/learn/meta.json b/content/docs/zh/learn/meta.json index 843495a..c2f977a 100644 --- a/content/docs/zh/learn/meta.json +++ b/content/docs/zh/learn/meta.json @@ -1,6 +1,6 @@ { - "title": "Learn", - "description": "Step-by-step guides for advanced configurations", + "title": "教程指南", + "description": "高级配置逐步指南", "pages": [ "ssl-certificate-cli", "ssl-activation-cli", diff --git a/content/docs/zh/panel/installation.mdx b/content/docs/zh/panel/installation.mdx index d2fa5f8..bf00210 100644 --- a/content/docs/zh/panel/installation.mdx +++ b/content/docs/zh/panel/installation.mdx @@ -77,7 +77,7 @@ PasarGuard 面板支持多个数据库后端： - PasarGuard 文件将位于 `/opt/pasarguard` - 配置文件可以在 `/opt/pasarguard/.env` 找到（请参考[配置](#configuration)部分查看变量） - 数据文件将放置在 `/var/lib/pasarguard` -- 出于安全考虑，PasarGuard 仪表板无法通过 IP 地址访问。因此，您必须[获取 SSL 证书](https://PasarGuard.github.io/PasarGuard/en/examples/issue-ssl-certificate)并通过打开网页浏览器并导航到 `https://YOUR_DOMAIN:8000/dashboard/` 来访问您的 PasarGuard 仪表板（将 YOUR_DOMAIN 替换为您的实际域名） +- 出于安全考虑，PasarGuard 仪表板无法通过 IP 地址访问。因此，您必须[获取 SSL 证书](/zh/learn/ssl-certificate-cli)并通过打开网页浏览器并导航到 `https://YOUR_DOMAIN:8000/dashboard/` 来访问您的 PasarGuard 仪表板（将 YOUR_DOMAIN 替换为您的实际域名） - 您也可以使用 SSH 端口转发在没有域名的情况下本地访问 PasarGuard 仪表板。将 `user@serverip` 替换为您的实际 SSH 用户名和服务器 IP，然后运行以下命令： ```bash diff --git a/src/app/[lang]/[...slug]/page.tsx b/src/app/[lang]/[...slug]/page.tsx index 7898b9f..8fb6f7b 100644 --- a/src/app/[lang]/[...slug]/page.tsx +++ b/src/app/[lang]/[...slug]/page.tsx @@ -79,7 +79,7 @@ export async function generateMetadata(props: { const canonicalUrl = `/${lang}${slug}`; return { - metadataBase: new URL('https://pasarguard.github.io'), + metadataBase: new URL('https://docs.pasarguard.org'), title: pageTitle, description: pageDescription, icons: { diff --git a/src/app/[lang]/page.tsx b/src/app/[lang]/page.tsx index fd5daa6..641c256 100644 --- a/src/app/[lang]/page.tsx +++ b/src/app/[lang]/page.tsx @@ -118,7 +118,7 @@ export async function generateMetadata({ params }: { params: Promise<{ lang: str // Default to English if invalid language const translations = loadTranslations('en'); return { - metadataBase: new URL('https://pasarguard.github.io'), + metadataBase: new URL('https://docs.pasarguard.org'), title: translations.appName, description: translations.appDescription, icons: { @@ -153,7 +153,7 @@ export async function generateMetadata({ params }: { params: Promise<{ lang: str const translations = loadTranslations(lang); return { - metadataBase: new URL('https://pasarguard.github.io'), + metadataBase: new URL('https://docs.pasarguard.org'), title: translations.appName, description: translations.appDescription, icons: { diff --git a/src/app/layout.tsx b/src/app/layout.tsx index d7f7cb5..00e1b46 100644 --- a/src/app/layout.tsx +++ b/src/app/layout.tsx @@ -2,7 +2,7 @@ import './global.css'; import { Metadata } from 'next'; export const metadata: Metadata = { - metadataBase: new URL('https://pasarguard.github.io'), + metadataBase: new URL('https://docs.pasarguard.org'), title: { default: 'PasarGuard - Unified GUI Censorship Resistant Solution', template: '%s | PasarGuard Documentation' @@ -31,7 +31,7 @@ export const metadata: Metadata = { openGraph: { type: 'website', locale: 'en_US', - url: 'https://pasarguard.github.io', + url: 'https://docs.pasarguard.org', siteName: 'PasarGuard', title: 'PasarGuard - Unified GUI Censorship Resistant Solution', description: 'PasarGuard is a proxy management tool that provides a simple and easy-to-use user interface for managing hundreds of proxy accounts powered by Xray-core.', @@ -52,7 +52,7 @@ export const metadata: Metadata = { creator: '@pasarguard', }, alternates: { - canonical: 'https://pasarguard.github.io', + canonical: 'https://docs.pasarguard.org', languages: { 'en': '/en', 'fa': '/fa', diff --git a/src/data/community-projects.ts b/src/data/community-projects.ts index 2caef26..487494a 100644 --- a/src/data/community-projects.ts +++ b/src/data/community-projects.ts @@ -58,7 +58,7 @@ export const communityCategories: CommunityCategory[] = [ repo: 'MatinDehghanian/LightWaySub', name: 'LightWaySub', description: - 'Lightweight and fast subscription page template built with React, shadcn/ui, and Tailwind CSS.', + 'An optimized, high-performance subscription template leveraging modern web technologies for speed.', }, ], }, diff --git a/src/lib/og-image-utils.ts b/src/lib/og-image-utils.ts index 524b268..ea4ac6f 100644 --- a/src/lib/og-image-utils.ts +++ b/src/lib/og-image-utils.ts @@ -3,7 +3,7 @@ */ export function getOGImagePath(lang: string, slug?: string[]): string { - const baseUrl = 'https://pasarguard.github.io'; + const baseUrl = 'https://docs.pasarguard.org'; if (!slug || slug.length === 0) { // Home page @@ -21,7 +21,7 @@ export function getOGImagePath(lang: string, slug?: string[]): string { } export function getOGImagePathForPage(lang: string, pageTitle: string, pageDescription?: string): string { - const baseUrl = 'https://pasarguard.github.io'; + const baseUrl = 'https://docs.pasarguard.org'; // For dynamic pages, we'll use a fallback to the logo // In a real implementation, you might want to generate images on-demand From b2736fa67f1f1a9434611c09dceb46624c3ab1d7 Mon Sep 17 00:00:00 2001 From: Mahdi Butcher Date: Sat, 1 Aug 2026 22:36:34 +0000 Subject: [PATCH 2/2] docs(panel): add comprehensive Backup & Restore documentation guide --- content/docs/en/interfaces/cli.mdx | 15 ++++ content/docs/en/panel/backup-restore.mdx | 97 ++++++++++++++++++++++++ content/docs/en/panel/meta.json | 1 + content/docs/fa/panel/backup-restore.mdx | 95 +++++++++++++++++++++++ content/docs/fa/panel/meta.json | 1 + content/docs/ru/panel/backup-restore.mdx | 75 ++++++++++++++++++ content/docs/ru/panel/meta.json | 1 + content/docs/zh/panel/backup-restore.mdx | 75 ++++++++++++++++++ content/docs/zh/panel/meta.json | 1 + 9 files changed, 361 insertions(+) create mode 100644 content/docs/en/panel/backup-restore.mdx create mode 100644 content/docs/fa/panel/backup-restore.mdx create mode 100644 content/docs/ru/panel/backup-restore.mdx create mode 100644 content/docs/zh/panel/backup-restore.mdx diff --git a/content/docs/en/interfaces/cli.mdx b/content/docs/en/interfaces/cli.mdx index 072d8f8..a18553e 100644 --- a/content/docs/en/interfaces/cli.mdx +++ b/content/docs/en/interfaces/cli.mdx @@ -32,3 +32,18 @@ pasarguard cli generate-temp-key The command prints a temporary key and its expiration time. The key is valid for 5 minutes and can only be used once. The dashboard setup form can use this key to create the first owner account, reset the owner password, delete the owner, or promote an existing admin to owner. + +## System Maintenance & Backups + +For database backup and restoration commands, refer to the [Backup & Restore Guide](/en/panel/backup-restore). + +```bash +# Manual database backup +sudo pasarguard backup + +# Restore database from backup +sudo pasarguard restore /path/to/backup.tar.gz + +# Start interactive TUI menu +sudo pasarguard tui +``` diff --git a/content/docs/en/panel/backup-restore.mdx b/content/docs/en/panel/backup-restore.mdx new file mode 100644 index 0000000..f0605e2 --- /dev/null +++ b/content/docs/en/panel/backup-restore.mdx @@ -0,0 +1,97 @@ +--- +title: Backup & Restore +description: Complete guide to backing up, restoring, and managing PasarGuard data using the management script. +--- + +# Backup & Restore Guide + +PasarGuard includes a comprehensive management script (`pasarguard.sh`) that automates database backups, restoration, service updates, and system maintenance. + +--- + +## 💾 Backing Up PasarGuard + +Regular backups ensure your user accounts, inbound configurations, and admin settings remain safe during server migrations or system failures. + +### 1. Manual Backup Command + +To trigger an immediate backup of your PasarGuard installation: + +```bash +sudo pasarguard backup +``` + +This command creates a compressed archive containing: +- **Database Dump**: Complete export of your database (SQLite, MySQL, MariaDB, PostgreSQL, or TimescaleDB). +- **Environment Settings**: Copy of your `/opt/pasarguard/.env` configuration. +- **SSL Certificates & Keys**: Relevant security credentials. + +Backups are saved locally under: +``` +/var/lib/pasarguard/backups/ +``` + +### 2. Automated Backups + +You can automate daily or weekly backups using `cron`. To schedule a daily backup at 3:00 AM: + +```bash +(crontab -l 2>/dev/null; echo "0 3 * * * sudo pasarguard backup > /dev/null 2>&1") | crontab - +``` + +--- + +## 🔄 Restoring PasarGuard + +To restore a PasarGuard database from a previously generated backup file: + +```bash +sudo pasarguard restore /path/to/backup-file.tar.gz +``` + +### Restoration Workflow + +1. **Stop Panel Services**: + ```bash + sudo pasarguard down + ``` +2. **Execute Restoration**: + ```bash + sudo pasarguard restore /var/lib/pasarguard/backups/pasarguard-backup-YYYY-MM-DD.tar.gz + ``` +3. **Restart Panel Services**: + ```bash + sudo pasarguard restart + ``` +4. **Verify System Health**: + ```bash + sudo pasarguard status + ``` + +--- + +## 🛠️ Management Script Reference (`pasarguard.sh`) + +The `pasarguard` command provides administrative tools for managing your server. + +### Primary Service Commands + +| Command | Description | +| :--- | :--- | +| `pasarguard up` | Starts all PasarGuard Docker containers | +| `pasarguard down` | Stops all PasarGuard Docker containers | +| `pasarguard restart` | Restarts all PasarGuard services | +| `pasarguard status` | Displays container status and resource usage | +| `pasarguard logs` | View live system logs (`-f` to follow) | +| `pasarguard update` | Updates PasarGuard panel to the latest version | +| `pasarguard tui` | Opens the interactive terminal user interface | + +### Interactive TUI Menu + +For an easy-to-use menu-driven experience, launch the TUI interface: + +```bash +sudo pasarguard tui +``` + +The TUI allows you to perform backups, restorations, SSL configurations, and database switches without remembering individual shell commands. diff --git a/content/docs/en/panel/meta.json b/content/docs/en/panel/meta.json index cfcd1f2..288c4a2 100644 --- a/content/docs/en/panel/meta.json +++ b/content/docs/en/panel/meta.json @@ -8,6 +8,7 @@ "installation", "configuration", "settings", + "backup-restore", "features", "users", "wireguard", diff --git a/content/docs/fa/panel/backup-restore.mdx b/content/docs/fa/panel/backup-restore.mdx new file mode 100644 index 0000000..eaaf40c --- /dev/null +++ b/content/docs/fa/panel/backup-restore.mdx @@ -0,0 +1,95 @@ +--- +title: پشتیبان‌گیری و بازیابی +description: راهنمای کامل پشتیبان‌گیری، بازیابی و مدیریت داده‌های PasarGuard با استفاده از اسکریپت مدیریت. +--- + +# راهنمای پشتیبان‌گیری و بازیابی + +پنل PasarGuard شامل یک اسکریپت مدیریت کامل (`pasarguard.sh`) است که فرآیند پشتیبان‌گیری از دیتابیس، بازیابی، بروزرسانی سرویس‌ها و نگهداری سیستم را خودکار می‌کند. + +--- + +## 💾 پشتیبان‌گیری از PasarGuard + +پشتیبان‌گیری منظم باعث می‌شود حساب‌های کاربران، پیکربندی‌ها و تنظیمات مدیران هنگام انتقال سرور یا بروز خطا امن باقی بمانند. + +### ۱. دستور پشتیبان‌گیری دستی + +برای اجرای پشتیبان‌گیری فوری از نصب PasarGuard خود: + +```bash +sudo pasarguard backup +``` + +این دستور یک فایل فشرده شامل موارد زیر ایجاد می‌کند: +- **خروجی دیتابیس**: خروجی کامل دیتابیس (SQLite، MySQL، MariaDB، PostgreSQL یا TimescaleDB). +- **تنظیمات محیطی**: کپی از فایل پیکربندی `/opt/pasarguard/.env`. +- **گواهی‌های SSL و کلیدها**: کلیدهای امنیتی مربوطه. + +فایل‌های پشتیبان در مسیر زیر ذخیره می‌شوند: +``` +/var/lib/pasarguard/backups/ +``` + +### ۲. پشتیبان‌گیری خودکار + +می‌توانید پشتیبان‌گیری روزانه یا هفتگی را با استفاده از `cron` خودکار کنید. برای زمان‌بندی پشتیبان‌گیری روزانه در ساعت ۳:۰۰ صبح: + +```bash +(crontab -l 2>/dev/null; echo "0 3 * * * sudo pasarguard backup > /dev/null 2>&1") | crontab - +``` + +--- + +## 🔄 بازیابی PasarGuard + +برای بازیابی دیتابیس PasarGuard از یک فایل پشتیبان قبلی: + +```bash +sudo pasarguard restore /path/to/backup-file.tar.gz +``` + +### مراحل بازیابی + +۱. **متوقف کردن سرویس‌های پنل**: + ```bash + sudo pasarguard down + ``` +۲. **اجرای دستور بازیابی**: + ```bash + sudo pasarguard restore /var/lib/pasarguard/backups/pasarguard-backup-YYYY-MM-DD.tar.gz + ``` +۳. **راه‌اندازی مجدد سرویس‌ها**: + ```bash + sudo pasarguard restart + ``` +۴. **بررسی وضعیت سیستم**: + ```bash + sudo pasarguard status + ``` + +--- + +## 🛠️ راهنمای اسکریپت مدیریت (`pasarguard.sh`) + +دستور `pasarguard` ابزارهای مدیریتی مختلفی را برای سرور شما فراهم می‌کند. + +### دستورات اصلی سرویس + +| دستور | توضیح | +| :--- | :--- | +| `pasarguard up` | اجرای تمام کانتینرهای داکر PasarGuard | +| `pasarguard down` | متوقف کردن تمام کانتینرهای داکر PasarGuard | +| `pasarguard restart` | راه‌اندازی مجدد تمام سرویس‌های PasarGuard | +| `pasarguard status` | نمایش وضعیت کانتینرها و مصرف منابع | +| `pasarguard logs` | مشاهده لاگ‌های زنده سیستم (`-f` برای دنبال کردن) | +| `pasarguard update` | بروزرسانی پنل PasarGuard به آخرین نسخه | +| `pasarguard tui` | باز کردن رابط متنی تعاملی کاربر (TUI) | + +### منوی تعاملی TUI + +برای استفاده آسان‌تر از طریق منوی متنی، محیط TUI را اجرا کنید: + +```bash +sudo pasarguard tui +``` diff --git a/content/docs/fa/panel/meta.json b/content/docs/fa/panel/meta.json index 36c2f2c..6f15c8e 100644 --- a/content/docs/fa/panel/meta.json +++ b/content/docs/fa/panel/meta.json @@ -7,6 +7,7 @@ "installation", "configuration", "settings", + "backup-restore", "features", "users", "wireguard", diff --git a/content/docs/ru/panel/backup-restore.mdx b/content/docs/ru/panel/backup-restore.mdx new file mode 100644 index 0000000..8a33f74 --- /dev/null +++ b/content/docs/ru/panel/backup-restore.mdx @@ -0,0 +1,75 @@ +--- +title: Резервное копирование и восстановление +description: Полное руководство по резервному копированию, восстановлению и управлению данными PasarGuard с помощью управляющего скрипта. +--- + +# Руководство по резервному копированию и восстановлению + +PasarGuard включает в себя управляющий скрипт (`pasarguard.sh`), который автоматизирует резервное копирование базы данных, восстановление, обновление служб и обслуживание системы. + +--- + +## 💾 Резервное копирование PasarGuard + +Регулярные резервные копии гарантируют сохранность ваших учетных записей пользователей, настроек и параметров администратора при миграции сервера или сбоях системы. + +### 1. Команда ручного резервного копирования + +Чтобы запустить немедленное резервное копирование: + +```bash +sudo pasarguard backup +``` + +Эта команда создает сжатый архив, содержащий: +- **Дамп базы данных**: Полный экспорт вашей базы данных (SQLite, MySQL, MariaDB, PostgreSQL или TimescaleDB). +- **Файл конфигурации**: Копию файла `/opt/pasarguard/.env`. +- **SSL-сертификаты и ключи**: Соответствующие учетные данные безопасности. + +Резервные копии сохраняются по адресу: +``` +/var/lib/pasarguard/backups/ +``` + +--- + +## 🔄 Восстановление PasarGuard + +Чтобы восстановить базу данных PasarGuard из ранее созданного файла резервной копии: + +```bash +sudo pasarguard restore /path/to/backup-file.tar.gz +``` + +### Процесс восстановления + +1. **Остановите службы панели**: + ```bash + sudo pasarguard down + ``` +2. **Выполните восстановление**: + ```bash + sudo pasarguard restore /var/lib/pasarguard/backups/pasarguard-backup-YYYY-MM-DD.tar.gz + ``` +3. **Перезапустите службы**: + ```bash + sudo pasarguard restart + ``` +4. **Проверьте статус системы**: + ```bash + sudo pasarguard status + ``` + +--- + +## 🛠️ Справочник команд скрипта (`pasarguard.sh`) + +| Команда | Описание | +| :--- | :--- | +| `pasarguard up` | Запускает все контейнеры Docker | +| `pasarguard down` | Останавливает все контейнеры Docker | +| `pasarguard restart` | Перезапускает все службы PasarGuard | +| `pasarguard status` | Отображает статус контейнеров | +| `pasarguard logs` | Просмотр логов системы | +| `pasarguard update` | Обновляет панель PasarGuard до последней версии | +| `pasarguard tui` | Открывает интерактивное TUI-меню | diff --git a/content/docs/ru/panel/meta.json b/content/docs/ru/panel/meta.json index f5d7131..9c2c956 100644 --- a/content/docs/ru/panel/meta.json +++ b/content/docs/ru/panel/meta.json @@ -7,6 +7,7 @@ "installation", "configuration", "settings", + "backup-restore", "features", "users", "wireguard", diff --git a/content/docs/zh/panel/backup-restore.mdx b/content/docs/zh/panel/backup-restore.mdx new file mode 100644 index 0000000..4b1b51f --- /dev/null +++ b/content/docs/zh/panel/backup-restore.mdx @@ -0,0 +1,75 @@ +--- +title: 备份与恢复 +description: 使用管理脚本备份、恢复和管理 PasarGuard 数据的完整指南。 +--- + +# 备份与恢复指南 + +PasarGuard 包含一个全面的管理脚本 (`pasarguard.sh`)，可自动执行数据库备份、恢复、服务更新和系统维护。 + +--- + +## 💾 备份 PasarGuard + +定期备份可确保您的用户帐户、入站配置和管理员设置在服务器迁移或系统故障期间保持安全。 + +### 1. 手动备份命令 + +要立即触发 PasarGuard 安装的备份： + +```bash +sudo pasarguard backup +``` + +此命令将创建一个压缩包，其中包含： +- **数据库转储**：导出您的完整数据库（SQLite、MySQL、MariaDB、PostgreSQL 或 TimescaleDB）。 +- **环境设置**：`/opt/pasarguard/.env` 配置文件的副本。 +- **SSL 证书和密钥**：相关的安全凭据。 + +备份文件保存在本地： +``` +/var/lib/pasarguard/backups/ +``` + +--- + +## 🔄 恢复 PasarGuard + +要从先前生成的备份文件恢复 PasarGuard 数据库： + +```bash +sudo pasarguard restore /path/to/backup-file.tar.gz +``` + +### 恢复步骤 + +1. **停止面板服务**： + ```bash + sudo pasarguard down + ``` +2. **执行恢复**： + ```bash + sudo pasarguard restore /var/lib/pasarguard/backups/pasarguard-backup-YYYY-MM-DD.tar.gz + ``` +3. **重启面板服务**： + ```bash + sudo pasarguard restart + ``` +4. **检查系统状态**： + ```bash + sudo pasarguard status + ``` + +--- + +## 🛠️ 管理脚本参考 (`pasarguard.sh`) + +| 命令 | 描述 | +| :--- | :--- | +| `pasarguard up` | 启动所有 PasarGuard Docker 容器 | +| `pasarguard down` | 停止所有 PasarGuard Docker 容器 | +| `pasarguard restart` | 重启所有 PasarGuard 服务 | +| `pasarguard status` | 显示容器状态和资源使用情况 | +| `pasarguard logs` | 查看实时系统日志 | +| `pasarguard update` | 将 PasarGuard 面板更新至最新版本 | +| `pasarguard tui` | 打开交互式终端用户界面 (TUI) | diff --git a/content/docs/zh/panel/meta.json b/content/docs/zh/panel/meta.json index 41c65bb..40eb9e0 100644 --- a/content/docs/zh/panel/meta.json +++ b/content/docs/zh/panel/meta.json @@ -7,6 +7,7 @@ "installation", "configuration", "settings", + "backup-restore", "features", "users", "wireguard",