You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- فایل های مرزبان در پوشه `/opt/marzban` قرار میگیرند
129
130
- فایل تنظیمات در مسیر `/opt/marzban/.env` قرار میگیرد ([تنظیمات](#تنظیمات) را مشاهده کنید)
130
131
- فایل های مهم (اطلاعات) مرزبان در مسیر `/usr/lib/marzban` قرار میگیرند
131
-
- شما از طریق آدرس `http://YOUR_SERVER_IP:8000/dashboard/` میتوانید وارد داشبورد مرزبان شوید (YOUR_SERVER_IP را با آیپی سرور خود عوض کنید)
132
+
به دلایل امنیتی، داشبورد مرزبان از طریق آیپی قابل دسترسی نیست. بنابراین، باید برای دامنه خود [گواهی SSL](https://gozargah.github.io/marzban/fa/examples/issue-ssl-certificate) بگیرید و از طریق آدرس https://YOUR_DOMAIN:8000/dashboard/ وارد داشبورد مرزبان شوید (نام دامنه خود را جایگزین YOUR_DOMAIN کنید)
133
+
- همچنین میتوانید از فوروارد کردن پورت SSH برای دسترسی لوکال به داشبورد مرزبان بدون دامنه استفاده کنید. نام کاربری و آیپی سرور خود را جایگزین `user@serverip` کنید و دستور زیر را اجرا کنید:
134
+
135
+
```bash
136
+
ssh -L 8000:localhost:8000 user@serverip
137
+
```
138
+
139
+
در نهایت، میتوانید لینک زیر را در مرورگر خود وارد کنید تا به داشبورد مرزبان دسترسی پیدا کنید:
140
+
141
+
http://localhost:8000/dashboard/
142
+
143
+
به محض بستن ترمینال SSH، دسترسی شما به داشبورد قطع خواهد شد. بنابراین، این روش تنها برای تست کردن توصیه میشود.
132
144
133
145
در مرحله بعد, باید یک ادمین سودو بسازید
134
146
@@ -286,6 +298,9 @@ server {
286
298
| فعال کردن کانفیگ سفارشی JSON فقط برای برنامهی V2rayN (پیشفرض: `False`) | USE_CUSTOM_JSON_FOR_V2RAYN |
287
299
288
300
301
+
# داکیومنت
302
+
[داکیومنت مرزبان](https://gozargah.github.io/marzban) تمامی آموزشهای ضروری برای شروع را فراهم میکند و در سه زبان فارسی، انگلیسی و روسی در دسترس است. این داکیومنت نیاز به تلاش زیادی دارد تا تمامی جنبههای پروژه را به طور کامل پوشش دهد. ما از کمک و همکاری شما برای بهبود آن استقبال و قدردانی میکنیم. میتوانید در این صفحه [گیتهاب](https://github.com/Gozargah/gozargah.github.io) مشارکت کنید.
303
+
289
304
# استفاده از API
290
305
مرزبان به توسعه دهندگانAPI REST ارائه می دهد. برای مشاهده اسناد API در قالب Swagger UI یا ReDoc، متغیر `DOCS=True` را در تنظیمات خود ست کنید و در مرورگر به مسیر `/docs` و `/redoc` بروید.
- Файлы Marzban будут размещены по адресу `/opt/marzban`.
130
131
- Файл конфигурации будет размещен по адресу `/opt/marzban/.env` (см. [Конфигурация](#конфигурация)).
131
132
- Файлы с данными будут размещены по адресу `/var/lib/marzban`.
132
-
- Вы можете получить доступ к панели управления, введя в адресной строке `http://YOUR_SERVER_IP:8000/dashboard/` (заменив YOUR_SERVER_IP на актуальный IP адрес вашего сервера).
133
+
- По соображениям безопасности, панель управления Marzban недоступна через IP-адрес. Поэтому вам необходимо [получить SSL-сертификат](https://gozargah.github.io/marzban/ru/examples/issue-ssl-certificate) и получить доступ к панели управления Marzban, открыв веб-браузер и перейдя по адресу `https://YOUR_DOMAIN:8000/dashboard/` (замените YOUR_DOMAIN на ваш фактический домен).
134
+
- Вы также можете использовать перенаправление портов SSH для локального доступа к панели управления Marzban без домена. Замените `user@serverip` на ваше фактическое имя пользователя SSH и IP-адрес сервера и выполните следующую команду:
135
+
136
+
```bash
137
+
ssh -L 8000:localhost:8000 user@serverip
138
+
```
139
+
140
+
Наконец, введите следующую ссылку в ваш браузер, чтобы получить доступ к панели управления Marzban:
141
+
142
+
http://localhost:8000/dashboard/
143
+
144
+
Вы потеряете доступ к панели управления, как только закроете терминал SSH. Поэтому этот метод рекомендуется использовать только для тестирования.
133
145
134
146
Далее, Вам нужно создать главного администратора для входа в панель управления Marzban, выполнив следующую команду:
135
147
@@ -313,6 +325,10 @@ server {
313
325
| USE_CUSTOM_JSON_FOR_STREISAND | Enable custom JSON config only for Streisand (default: `False`) |
314
326
| USE_CUSTOM_JSON_FOR_V2RAYN | Enable custom JSON config only for V2rayN (default: `False`) |
315
327
328
+
# документация
329
+
330
+
[Документация Marzban](https://gozargah.github.io/marzban/ru/) предоставляет все необходимые руководства для начала работы и доступна на трех языках: фарси, английском и русском. Для полного охвата всех аспектов проекта требуется значительное количество усилий. Мы приветствуем и ценим ваш вклад в улучшение документации. Вы можете внести свой вклад в этот [репозиторий на GitHub](https://github.com/Gozargah/gozargah.github.io).
331
+
316
332
# API
317
333
318
334
Marzban предоставляет REST API, позволяющий разработчикам программно взаимодействовать с сервисами Marzban. Для просмотра документации по API в Swagger UI или ReDoc установите переменную `DOCS=True` и перейдите по ссылкам `/docs` и `/redoc`.
Copy file name to clipboardExpand all lines: README-zh-cn.md
+17-1
Original file line number
Diff line number
Diff line change
@@ -66,6 +66,7 @@
66
66
-[特性](#特性)
67
67
-[安装指南](#安装指南)
68
68
-[配置](#配置)
69
+
-[文档](#文档)
69
70
-[如何使用 API](#如何使用-api)
70
71
-[如何备份 Marzban](#如何备份-marzban)
71
72
-[Telegram bot](#telegram-bot)
@@ -127,7 +128,18 @@ Once the installation is complete:
127
128
- The Marzban files will be located at `/opt/marzban`
128
129
- The configuration file can be found at `/opt/marzban/.env` (refer to [configurations](#configuration) section to see variables)
129
130
- The data files will be placed at `/usr/lib/marzban`
130
-
- You can access the Marzban dashboard by opening a web browser and navigating to `http://YOUR_SERVER_IP:8000/dashboard/` (replace YOUR_SERVER_IP with the actual IP address of your server)
131
+
- For security reasons, the Marzban dashboard is not accessible via IP address. Therefore, you must [obtain SSL certificate](https://gozargah.github.io/marzban/en/examples/issue-ssl-certificate) and access your Marzban dashboard by opening a web browser and navigating to `https://YOUR_DOMAIN:8000/dashboard/` (replace YOUR_DOMAIN with your actual domain)
132
+
- You can also use SSH port forwarding to access the Marzban dashboard locally without a domain. Replace `user@serverip` with your actual SSH username and server IP and Run the command below:
133
+
134
+
```bash
135
+
ssh -L 8000:localhost:8000 user@serverip
136
+
```
137
+
138
+
Finally, you can enter the following link in your browser to access your Marzban dashboard:
139
+
140
+
http://localhost:8000/dashboard/
141
+
142
+
You will lose access to the dashboard as soon as you close the SSH terminal. Therefore, this method is recommended only for testing purposes.
131
143
132
144
Next, you need to create a sudo admin for logging into the Marzban dashboard by the following command
133
145
@@ -301,6 +313,10 @@ server {
301
313
| USE_CUSTOM_JSON_FOR_V2RAYN | Enable custom JSON config only for V2rayN (default: `False`) |
Copy file name to clipboardExpand all lines: README.md
+20-1
Original file line number
Diff line number
Diff line change
@@ -66,6 +66,7 @@
66
66
-[Features](#features)
67
67
-[Installation guide](#installation-guide)
68
68
-[Configuration](#configuration)
69
+
-[Documentation](#documentation)
69
70
-[API](#api)
70
71
-[Backup](#backup)
71
72
-[Telegram Bot](#telegram-bot)
@@ -130,7 +131,18 @@ Once the installation is complete:
130
131
- The Marzban files will be located at `/opt/marzban`
131
132
- The configuration file can be found at `/opt/marzban/.env` (refer to [configurations](#configuration) section to see variables)
132
133
- The data files will be placed at `/var/lib/marzban`
133
-
- You can access the Marzban dashboard by opening a web browser and navigating to `http://YOUR_SERVER_IP:8000/dashboard/` (replace YOUR_SERVER_IP with the actual IP address of your server)
134
+
- For security reasons, the Marzban dashboard is not accessible via IP address. Therefore, you must [obtain SSL certificate](https://gozargah.github.io/marzban/en/examples/issue-ssl-certificate) and access your Marzban dashboard by opening a web browser and navigating to `https://YOUR_DOMAIN:8000/dashboard/` (replace YOUR_DOMAIN with your actual domain)
135
+
- You can also use SSH port forwarding to access the Marzban dashboard locally without a domain. Replace `user@serverip` with your actual SSH username and server IP and Run the command below:
136
+
137
+
```bash
138
+
ssh -L 8000:localhost:8000 user@serverip
139
+
```
140
+
141
+
Finally, you can enter the following link in your browser to access your Marzban dashboard:
142
+
143
+
http://localhost:8000/dashboard/
144
+
145
+
You will lose access to the dashboard as soon as you close the SSH terminal. Therefore, this method is recommended only for testing purposes.
134
146
135
147
Next, you need to create a sudo admin for logging into the Marzban dashboard by the following command
136
148
@@ -314,10 +326,17 @@ By default the app will be run on `http://localhost:8000/dashboard`. You can con
314
326
| USE_CUSTOM_JSON_FOR_STREISAND | Enable custom JSON config only for Streisand (default: `False`) |
315
327
| USE_CUSTOM_JSON_FOR_V2RAYN | Enable custom JSON config only for V2rayN (default: `False`) |
316
328
329
+
330
+
# Documentation
331
+
332
+
The [Marzban Documentation](https://gozargah.github.io/marzban) provides all the essential guides to get you started, available in three languages: Farsi, English, and Russian. This documentation requires significant effort to cover all aspects of the project comprehensively. We welcome and appreciate your contributions to help us improve it. You can contribute on this [GitHub repository](https://github.com/Gozargah/gozargah.github.io).
333
+
334
+
317
335
# API
318
336
319
337
Marzban provides a REST API that enables developers to interact with Marzban services programmatically. To view the API documentation in Swagger UI or ReDoc, set the configuration variable `DOCS=True` and navigate to the `/docs` and `/redoc`.
320
338
339
+
321
340
# Backup
322
341
323
342
It's always a good idea to backup your Marzban files regularly to prevent data loss in case of system failures or accidental deletion. Here are the steps to backup Marzban:
0 commit comments