Skip to content

Add backup guide and translations for Marzneshin documentation #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add backup guide and translations for Marzneshin documentation #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions content/docs/how-to-guides/_index.fa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: راهنماهای آموزشی
next:
---

راهنماهای آموزشی برای مرزنشین
39 changes: 39 additions & 0 deletions content/docs/how-to-guides/backup.fa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "پشتیبان‌گیری"
---

### مراحل پشتیبان‌گیری از مرزنشین

{{< callout type="info" >}}
پشتیبان‌گیری منظم از فایل‌های مرزنشین یک راه عالی برای جلوگیری از از دست دادن داده‌ها در صورت خرابی سیستم است.
{{< /callout >}}

1. به طور پیش‌فرض، تمام فایل‌های مهم مرزنشین در `/var/lib/marzneshin` (نسخه‌های Docker) ذخیره می‌شوند. کافی است کل
دایرکتوری `/var/lib/marzneshin` را به یک مکان پشتیبان از انتخاب خود، مانند یک هارد دیسک خارجی یا فضای ذخیره‌سازی ابری
کپی کنید.
2. همچنین، حتماً فایل env خود را که حاوی متغیرهای پیکربندی شما است، پشتیبان‌گیری کنید. اگر مرزنشین را با استفاده از اسکریپت نصب کرده‌اید (روش نصب توصیه‌شده)، env و سایر پیکربندی‌ها باید
در دایرکتوری `/etc/opt/marzneshin/` باشند.

{{< callout type="error" >}}
اگر پشتیبان‌گیری منظم انجام ندهید، ممکن است داده‌های خود را از دست بدهید و نتوانید آنها را بازیابی کنید. پس حتماً پشتیبان‌های خود را به‌طور مکرر نگه دارید تا از داده‌های خود محافظت کنید.
{{< /callout >}}

### ساختار دایرکتوری پشتیبان

{{< filetree/container >}}
{{< filetree/folder name="var" >}}
{{< filetree/folder name="lib" >}}
{{< filetree/folder name="marzneshin" >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< filetree/folder name="etc" >}}
{{< filetree/folder name="opt" >}}
{{< filetree/folder name="marzneshin" >}}
{{< filetree/file name="env" >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/container >}}

با دنبال کردن این مراحل، می‌توانید مطمئن باشید که یک نسخه پشتیبان از تمام فایل‌ها و داده‌های مرزنشین خود، همچنین متغیرهای پیکربندی و پیکربندی Xray خود دارید، در صورت نیاز به بازیابی آنها در آینده. به یاد داشته باشید که بکاپ های خود را به‌طور منظم به‌روزرسانی کنید تا همیشه به‌روز باشند.
44 changes: 35 additions & 9 deletions content/docs/how-to-guides/backup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,41 @@
title: "Backup"
---

### Steps to Backup Marzneshin Files

{{< callout type="info" >}}
It's good practice to backup your Marzneshin files regularly to prevent data loss in case of system failures.
{{< /callout >}}

1. **Backup Important Files:**
- By default, all Marzneshin important files are saved in `/var/lib/marzneshin` (Docker versions).
- Copy the entire `/var/lib/marzneshin` directory to a backup location of your choice, such as an external hard drive or cloud storage.

2. **Backup Configuration Files:**
- Make sure to backup your env file, which contains your configuration variables.
- If you installed Marzneshin using the script (recommended installation approach), the env and other configurations should be inside `/etc/opt/marzneshin/` directory.

{{< callout type="error" >}}
Failure to perform regular backups may result in data loss, which is not recoverable. Ensure you maintain frequent backups to safeguard your data.
{{< /callout >}}

### Backup Directory Structure

{{< filetree/container >}}
{{< filetree/folder name="var" >}}
{{< filetree/folder name="lib" >}}
{{< filetree/folder name="marzneshin" >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< filetree/folder name="etc" >}}
{{< filetree/folder name="opt" >}}
{{< filetree/folder name="marzneshin" >}}
{{< filetree/file name="env" >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/container >}}

1. By default, all Marzneshin important files are saved in `/var/lib/marzneshin` (Docker versions). Copy the
entire `/var/lib/marzneshin` directory to a backup location of your choice, such as an external hard drive or cloud
storage.
2. Additionally, make sure to backup your env file, which contains your configuration variables. If you installed
Marzneshin using the script (recommended installation approach), the env and other configurations should be
inside `/etc/opt/marzneshin/` directory.
By following these steps, you can ensure that you have a backup of all your Marzneshin files and data, as well as your configuration variables and Xray configuration, in case you need to restore them in the future. Remember to update your backups regularly to keep them up-to-date.

By following these steps, you can ensure that you have a backup of all your Marzneshin files and data, as well as your
configuration variables and Xray configuration, in case you need to restore them in the future. Remember to update your
backups regularly to keep them up-to-date.