Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions content/docs/en/interfaces/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
97 changes: 97 additions & 0 deletions content/docs/en/panel/backup-restore.mdx
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion content/docs/en/panel/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions content/docs/en/panel/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"installation",
"configuration",
"settings",
"backup-restore",
"features",
"users",
"wireguard",
Expand Down
95 changes: 95 additions & 0 deletions content/docs/fa/panel/backup-restore.mdx
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion content/docs/fa/panel/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions content/docs/fa/panel/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"installation",
"configuration",
"settings",
"backup-restore",
"features",
"users",
"wireguard",
Expand Down
4 changes: 2 additions & 2 deletions content/docs/ru/learn/meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Learn",
"description": "Step-by-step guides for advanced configurations",
"title": "Руководства",
"description": "Пошаговые руководства по расширенной настройке",
"pages": [
"ssl-certificate-cli",
"ssl-activation-cli",
Expand Down
75 changes: 75 additions & 0 deletions content/docs/ru/panel/backup-restore.mdx
Original file line number Diff line number Diff line change
@@ -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-меню |
2 changes: 1 addition & 1 deletion content/docs/ru/panel/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions content/docs/ru/panel/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"installation",
"configuration",
"settings",
"backup-restore",
"features",
"users",
"wireguard",
Expand Down
4 changes: 2 additions & 2 deletions content/docs/zh/learn/meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Learn",
"description": "Step-by-step guides for advanced configurations",
"title": "教程指南",
"description": "高级配置逐步指南",
"pages": [
"ssl-certificate-cli",
"ssl-activation-cli",
Expand Down
Loading