improve: marzneshin install (#13)

* improve: marzneshin install * chore: rename cards
MarzneshinsCommunity · Dec 25, 2024 · f7c9026 · f7c9026
1 parent f5901c5
commit f7c9026
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 102 deletions.
diff --git a/content/_index.fa.md b/content/_index.fa.md
@@ -9,6 +9,6 @@ toc: false
 این مستند نسخه کامیونیتی مستندات اصلی مرزنشین است که با هدف ارائه توضیحات شفاف‌تر و اطلاعات دقیق‌تر ایجاد و توسعه داده شده است. برای جزئیات بیشتر، بخش‌های زیر را بررسی کنید.
 
 {{< cards >}}
-  {{< card link="docs/marzneshin" title="نصب مرزنشین">}}
-  {{< card link="docs/marznode" title="نصب مرزنود">}}
+  {{< card link="docs/marzneshin" title="مرزنشین">}}
+  {{< card link="docs/marznode" title="مرزنود">}}
 {{< /cards >}}
diff --git a/content/_index.md b/content/_index.md
@@ -10,6 +10,6 @@ This document serves as the community version of the main Marzneshin documentati
 
 
 {{< cards >}}
-  {{< card link="docs/marzneshin" title="Install Marzneshin">}}
-  {{< card link="docs/marznode" title="Install Marznode">}}
+  {{< card link="docs/marzneshin" title="Marzneshin">}}
+  {{< card link="docs/marznode" title="Marznode">}}
 {{< /cards >}}
diff --git a/content/docs/_index.fa.md b/content/docs/_index.fa.md
@@ -0,0 +1,9 @@
+---
+title: داکیومنت
+toc: false
+---
+
+{{< cards >}}
+  {{< card link="marzneshin" title="مرزنشین">}}
+  {{< card link="marznode" title="مرزنود">}}
+{{< /cards >}}
diff --git a/content/docs/_index.md b/content/docs/_index.md
@@ -0,0 +1,9 @@
+---
+title: Docs
+toc: false
+---
+
+{{< cards >}}
+  {{< card link="marzneshin" title="Marzneshin">}}
+  {{< card link="marznode" title="Marznode">}}
+{{< /cards >}}
diff --git a/content/docs/marzneshin/_index.fa.md b/content/docs/marzneshin/_index.fa.md
@@ -1,68 +1,52 @@
----
-title: مرزنشین
-toc: False
-weight: 1
----
-
-برای شروع، به یک سرور لینوکس (هردستگاهی که توانایی اجرای داکر دارد) نیاز دارید.
-
-{{< callout type="info" >}}
-ما اوبونتو را به دلیل سهولت استفاده توصیه می‌کنیم، اگرچه مرزنشین می‌تواند بر روی هر توزیع لینوکس اجرا شود.
-{{< /callout >}}
-
-مرزنشین از هر دو معماری ARM و x86 پشتیبانی می‌کند. Docker نیز پشتیبانی می‌شود.
-
-{{< callout type="info" >}}
-نصب سریع:
-
-```bash
-sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install
-```
-
-پس از آن، یک ادمین ایجاد کنید:
-
-```bash
-marzneshin cli admin create --sudo
-```
-
-{{< /callout >}}
-
-مرزنشین از پایگاه‌های داده زیر پشتیبانی می‌کند. SQLite برای تنظیمات کوچک ترجیح داده می‌شود، در حالی که MariaDB برای پردازش های بیشتر توصیه می شود.
-{{< tabs items="mariadb,mysql,sqlite" >}}
-
-{{< tab >}}```bash
-sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install --database mariadb
-```{{< /tab >}}
-{{< tab >}}```bash
-sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install --database mysql
-```{{< /tab >}}
-{{< tab >}}```bash
-sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install
-```{{< /tab >}}
-
-{{< /tabs >}}
-
-{{< callout type="warning" >}}
-برای نصب آخرین نسخه **nightly**، از فلگ `--nightly` استفاده کنید.
-{{< /callout >}}
-
-پس از اتمام نصب:
-
-- شما لاگ‌ها را مشاهده خواهید کرد که می‌توانید با فشار دادن `Ctrl+C` مشاهده آن‌ها را متوقف کنید. فرآیند به طور عادی ادامه خواهد یافت.
-- فایل پیکربندی در مسیر `/etc/opt/marzneshin/.env` قرار دارد (به صفحه [پیکربندی](/docs/configuration/marzneshin) مراجعه کنید).
-- فایل‌های داده در مسیر `/var/lib/marzneshin` قرار خواهند گرفت، به عنوان مثال، پایگاه داده SQLite.
-- شما می‌توانید به داشبورد مرزنشین با باز کردن یک مرورگر وب و رفتن به `http://<SERVER_IP>:8000/dashboard/` دسترسی پیدا کنید.
-
-سپس، یک ادمین سودو برای ورود به داشبورد مرزنشین با استفاده از فرمان زیر ایجاد کنید:
-
-```bash
-marzneshin cli admin create --sudo
-```
-
-همین! شما می‌توانید با استفاده از این credentials به داشبورد خود وارد شوید.
-
-برای مشاهده پیام راهنمای اسکریپت مرزنشین، فرمان زیر را اجرا کنید:
-
-```bash
-marzneshin --help
-```
+---  
+title: نصب  
+toc: False  
+weight: 1  
+---  
+
+برای شروع، به یک دستگاه لینوکسی نیاز دارید. مرزنشین از هر دو معماری ARM و x86 پشتیبانی می‌کند. Docker نیز پشتیبانی می‌شود. مرزنشین از پایگاه‌های داده زیر پشتیبانی می‌کند. برای تنظیمات کوچک، **SQLite** مناسب است و برای کانفیگ‌های بزرگ‌تر، **MariaDB** توصیه می‌شود. 
+
+{{< tabs items="mariadb,mysql,sqlite" >}}  
+
+{{< tab >}}  
+```bash  
+sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install --database mariadb  
+```  
+{{< /tab >}}  
+{{< tab >}}  
+```bash  
+sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install --database mysql  
+```  
+{{< /tab >}}  
+{{< tab >}}  
+```bash  
+sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install  
+```  
+{{< /tab >}}  
+
+{{< /tabs >}}  
+
+{{< callout type="warning" >}}  
+برای نصب آخرین نسخه **nightly** (حالت توسعه)، از فلگ `--nightly` استفاده کنید.  
+{{< /callout >}}  
+
+پس از اتمام نصب:  
+
+- لاگ‌ها نمایش داده خواهند شد که با فشار دادن `Ctrl+C` می‌توانید مشاهده آن‌ها را متوقف کنید.  
+- فایل تنظیمات در مسیر `/etc/opt/marzneshin/.env` قرار می‌گیرد.  
+- فایل‌های داده در مسیر `/var/lib/marzneshin` ذخیره می‌شوند.  
+- برای دسترسی به داشبورد مرزنشین، مرورگر وب خود را باز کرده و به آدرس `http://<SERVER_IP>:8000/dashboard/` بروید.  
+
+در مرحله بعد، یک کاربر ادمین با دسترسی سودو برای ورود به داشبورد مرزنشین ایجاد کنید:  
+
+```bash  
+marzneshin cli admin create --sudo  
+```  
+
+همین! اکنون می‌توانید با استفاده از اطلاعات لاگین خود وارد داشبورد شوید.  
+
+برای مشاهده پیام راهنما، دستور زیر را اجرا کنید:  
+
+```bash  
+marzneshin --help  
+```
diff --git a/content/docs/marzneshin/_index.md b/content/docs/marzneshin/_index.md
@@ -1,34 +1,12 @@
 ---
-title: Basic install Marzneshin 
+title: Install 
 linkTitle : Marzneshin
 toc: False
 weight: 1
 ---
 
-To get started, you need a Linux machine.
+To get started, you need a Linux machine. Marzneshin supports both ARM and x86 architectures. Docker is also supported. Marzneshin supports the following databases. SQLite is preferred for small setups, while MariaDB is recommended for larger configurations.
 
-{{< callout type="info" >}}
-We recommend Ubuntu for its ease of use, though Marzneshin can run on any Linux distribution.
-{{< /callout >}}
-
-Marzneshin supports both ARM and x86 architectures. Docker is also supported.
-
-{{< callout type="info" >}}
-Quick installation:
-
-```bash
-sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/script.sh)" @ install
-```
-
-After that, create an admin:
-
-```bash
-marzneshin cli admin create --sudo
-```
-
-{{< /callout >}}
-
-Marzneshin supports the following databases. SQLite is preferred for small setups, while MariaDB is recommended for larger configurations.
 {{< tabs items="mariadb,mysql,sqlite" >}}
 
 {{< tab >}}```bash
@@ -44,14 +22,14 @@ sudo bash -c "$(curl -sL https://github.com/marzneshin/Marzneshin/raw/master/scr
 {{< /tabs >}}
 
 {{< callout type="warning" >}}
-To install the latest **nightly** release, use the `--nightly` flag.
+To install the latest **nightly** (dev mode) release, use the `--nightly` flag.
 {{< /callout >}}
 
 Once the installation is complete:
 
 - You'd notice the logs, which you can stop watching by pressing `Ctrl+C`. The process will continue running normally.
-- The configuration file can be found at `/etc/opt/marzneshin/.env` (refer to the [configuration](/docs/configuration/marzneshin) page).
-- Data files will be placed at `/var/lib/marzneshin`, e.g., the SQLite database.
+- The configuration file can be found at `/etc/opt/marzneshin/.env`.
+- Data files will be placed at `/var/lib/marzneshin`
 - You can access the Marzneshin dashboard by opening a web browser and navigating to `http://<SERVER_IP>:8000/dashboard/`.
 
 Next, create a sudo admin for logging into the Marzneshin dashboard using the following command:
@@ -60,9 +38,7 @@ Next, create a sudo admin for logging into the Marzneshin dashboard using the fo
 marzneshin cli admin create --sudo
 ```
 
-That's it! You can log in to your dashboard using these credentials.
-
-To see the help message of the Marzneshin script, run the following command:
+That's it! You can log in to your dashboard using these credentials. To see the help message of the Marzneshin script, run the following command:
 
 ```bash
 marzneshin --help