From d2618ca7a4a91ef45a9b330e14c9214febb1c378 Mon Sep 17 00:00:00 2001
From: Alexey <50312583+DigneZzZ@users.noreply.github.com>
Date: Sat, 12 Apr 2025 21:44:48 +0300
Subject: [PATCH] Add Remnawave Backup and Restore scripts to Awesome Remnawave

---
 docs/awesome-remnawave/index.md | 61 +++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/docs/awesome-remnawave/index.md b/docs/awesome-remnawave/index.md
index 2bd3cfe..1f6ad84 100644
--- a/docs/awesome-remnawave/index.md
+++ b/docs/awesome-remnawave/index.md
@@ -54,6 +54,67 @@ After install, use `remnanode help` for more information.
   <img src="/awesome/remnanode-script.webp" alt="RemnaNode script" width="600" />
 </div>
 
+---
+
+### Remnawave Backup Script
+
+A bash script to create backups of the Remnawave database and configurations. Backups are sent to a Telegram chat for easy access. The script backs up the following:
+
+- The Remnawave database as `db_backup.sql`
+- Either the entire specified folder (e.g., `/opt/remnawave` or user-defined) or specific files:
+  - `docker-compose.yml`
+  - `.env`
+  - `app-config.json` (custom file for the subscription page, see [instructions](https://remna.st/subscription-templating/client-configuration))
+
+Author: [DigneZzZ](https://github.com/DigneZzZ)
+
+#### Install and Run
+
+```bash
+sudo bash -c "$(curl -sL https://github.com/DigneZzZ/remnawave-scripts/raw/main/remnawave-backup.sh)"
+```
+
+<div style={{ display: 'flex', justifyContent: 'center', gap: '1rem' }}>
+  <Button label="Github repository" link="https://github.com/DigneZzZ/remnawave-scripts" variant="secondary" size="md" outline />
+</div>
+<br />
+
+<div style={{ display: 'flex', justifyContent: 'center' }}>
+  <img src="/awesome/remnawave-backup.webp" alt="Remnawave Backup Script" width="600" />
+</div>
+
+---
+
+### Remnawave Restore Script (BETA)
+
+A bash script to restore Remnawave backups, either fully (files and database) or database-only, from a `.tar.gz` archive to a specified directory. **Warning: This is a beta version. Use with extreme caution, especially on a live Remnawave panel, as it may overwrite critical data or cause instability.**
+
+The script performs the following:
+- Clears all existing data in the specified database and restores it from `db_backup.sql`
+- Restores files to the chosen directory (e.g., `/opt/remnawave` or user-defined), including:
+  - `docker-compose.yml`
+  - `.env`
+  - `app-config.json` (custom file for the subscription page, see [instructions](https://remna.st/subscription-templating/client-configuration))
+- Starts containers to ensure the restored setup is operational
+
+Author: [DigneZzZ](https://github.com/DigneZzZ)
+
+#### Install and Run
+
+```bash
+sudo bash -c "$(curl -sL https://github.com/DigneZzZ/remnawave-scripts/raw/main/restore.sh)"
+```
+
+<div style={{ display: 'flex', justifyContent: 'center', gap: '1rem' }}>
+  <Button label="Github repository" link="https://github.com/DigneZzZ/remnawave-scripts" variant="secondary" size="md" outline />
+</div>
+<br />
+
+<div style={{ display: 'flex', justifyContent: 'center' }}>
+  <img src="/awesome/remnawave-restore.webp" alt="Remnawave Restore Script" width="600" />
+</div>
+
+
 ---
 
 ## Add project to the list