Skip to content
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.

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

docs(marznode-marzneshin-config): farsi translation #9

Open
wants to merge 37 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
66dcff2
marzneshin.md
realartin Oct 12, 2024
1dc6d9b
marznode.md
realartin Oct 12, 2024
7c07401
Update marznode.md
realartin Oct 12, 2024
92c0cee
Update marznode.md
realartin Oct 12, 2024
2d7d4eb
Update hysteria.md
realartin Oct 12, 2024
18fa1d0
Update hysteria.md
realartin Oct 12, 2024
b9e84c3
Update hysteria.md
realartin Oct 12, 2024
d797566
Update hysteria.md
realartin Oct 12, 2024
01d11c0
Update marznode.md
realartin Oct 12, 2024
0555895
Create hysteria_Fa.md
realartin Oct 12, 2024
a80c7af
Create marznode_fa.md
realartin Oct 12, 2024
a560805
Update marznode_fa.md
realartin Oct 12, 2024
c2fb81b
Create marznehsin_fa.md
realartin Oct 12, 2024
8b5164d
Create codebase_fa.md
realartin Oct 12, 2024
223b0f7
Create donation_fa.md
realartin Oct 12, 2024
3af311c
Create api_fa.md
realartin Oct 12, 2024
c832260
Create _index_fa.md
realartin Oct 12, 2024
38d70b3
Create marzneshin_fa.md
realartin Oct 12, 2024
e9efc92
Create marznode_fa.md
realartin Oct 12, 2024
b32fc10
Create basic-install_fa.md
realartin Oct 12, 2024
b029bed
Create concepts_fa.md
realartin Oct 12, 2024
ea6be10
Delete content/docs/getting-started/advanced-install/concepts_fa.md
realartin Oct 12, 2024
3ac3a9e
Create concepts_fa.md
realartin Oct 12, 2024
bf21aa3
Create _index_fa.md
realartin Oct 12, 2024
2bcc446
Update marznode.md
realartin Oct 12, 2024
2f42122
Update marznode_fa.md
realartin Oct 13, 2024
046cedc
Rename marznehsin_fa.md to marznehsin.fa.md
realartin Oct 14, 2024
3967fbb
Rename marznode_fa.md to marznode.fa.md
realartin Oct 14, 2024
518f459
Rename hysteria_Fa.md to hysteria.fa.md
realartin Oct 14, 2024
2b6f1d8
Rename api_fa.md to api.fa.md
realartin Oct 14, 2024
9ff1bfc
Rename codebase_fa.md to codebase.fa.md
realartin Oct 14, 2024
2501bbf
Rename _index_fa.md to _index.fa.md
realartin Oct 14, 2024
128e38b
Rename _index_fa.md to _index.fa.md
realartin Oct 14, 2024
a339cb6
Rename marzneshin_fa.md to marzneshin.fa.md
realartin Oct 14, 2024
eeec244
Rename marznode_fa.md to marznode.fa.md
realartin Oct 14, 2024
e59c39a
Rename basic-install_fa.md to basic-install.fa.md
realartin Oct 14, 2024
90251da
Rename concepts_fa.md to concepts.fa.md
realartin Oct 14, 2024
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
98 changes: 98 additions & 0 deletions content/docs/configuration/marznehsin_fa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---

title: Marzneshin
weight: 1

---

> می‌توانید تنظیمات زیر را با استفاده از متغیرهای محیطی یا قرار دادن آن‌ها در فایل `.env` پیکربندی کنید.

## تنظیمات پایه

| متغیر | توضیحات |
| ----------------------------- | ------------------------------------------------------------------------------------------------------ |
| UVICORN_HOST | اتصال برنامه به این هاست (پیش‌فرض: `0.0.0.0`) |
| UVICORN_PORT | اتصال برنامه به این پورت (پیش‌فرض: `8000`) |
| UVICORN_UDS | اتصال برنامه به یک دامنه سوکت UNIX |
| UVICORN_SSL_CERTFILE | فایل گواهی SSL برای اجرای برنامه بر روی https |
| UVICORN_SSL_KEYFILE | فایل کلید SSL برای اجرای برنامه بر روی https |
| SQLALCHEMY_DATABASE_URL | آدرس URL پایگاه داده ([مستندات SQLAlchemy](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls)) |
| JWT_ACCESS_TOKEN_EXPIRE_MINUTES| زمان انقضای توکن‌های دسترسی به دقیقه (۰ به معنای بی‌نهایت) (پیش‌فرض: `1440`) |
| AUTH_GENERATION_ALGORITHM | الگوریتم رمزنگاری رمز عبور احراز هویت (پیش‌فرض: "xxh128"، گزینه‌ها: "xxh128"، "plain") |
| REVERSIBLE_KEY | پشتیبانی از کلید قابل برگشت (پیش‌فرض: False، گزینه‌ها: "False"، "True") |

## سفارشی‌سازی اشتراک و VPN

| متغیر | توضیحات |
| ---------------------------| --------------------------------------------------------------------------------------- |
| CUSTOM_TEMPLATES_DIRECTORY | دایرکتوری قالب‌های سفارشی (پیش‌فرض: `app/templates`) |
| CLASH_SUBSCRIPTION_TEMPLATE | قالب مورد استفاده برای تولید تنظیمات Clash (پیش‌فرض: `clash/default.yml`) |
| SUBSCRIPTION_PAGE_TEMPLATE | قالب مورد استفاده برای تولید صفحه اطلاعات اشتراک (پیش‌فرض: `subscription/index.html`) |
| SUBSCRIPTION_URL_PREFIX | پیشوند URL‌های اشتراک |
| HOME_PAGE_TEMPLATE | قالب صفحه نمایشی تقلبی (پیش‌فرض: `home/index.html`) |

## تنظیمات تلگرام

| متغیر | توضیحات |
| ------------------- | -------------------------------------------------------------------------------------------------- |
| TELEGRAM_API_TOKEN | توکن API ربات تلگرام (توکن را از [@botfather](https://t.me/botfather) دریافت کنید) |
| TELEGRAM_ADMIN_ID | شناسه عددی تلگرام ادمین (برای پیدا کردن شناسه خود از [@userinfobot](https://t.me/userinfobot) استفاده کنید) |
| TELEGRAM_PROXY_URL | اجرای ربات تلگرام از طریق پروکسی |

## اعلان و وب‌هوک

| متغیر | توضیحات |
| ---------------------------------| ---------------------------------------------------------------------------------------------------- |
| WEBHOOK_ADDRESS | آدرس وب‌هوک برای ارسال اعلان‌ها. اعلان‌های وب‌هوک اگر این مقدار تنظیم شود، ارسال خواهند شد. |
| WEBHOOK_SECRET | راز وب‌هوک که با هر درخواست به‌عنوان `x-webhook-secret` در هدر ارسال می‌شود (پیش‌فرض: `None`) |
| NUMBER_OF_RECURRENT_NOTIFICATIONS | تعداد تکرار اعلان‌ها در صورت بروز خطا در ارسال (پیش‌فرض: `3`) |
| RECURRENT_NOTIFICATIONS_TIMEOUT | زمان انتظار بین هر تلاش مجدد در صورت بروز خطا در ارسال اعلان‌ها به ثانیه (پیش‌فرض: `180`) |
| NOTIFY_REACHED_USAGE_PERCENT | درصد استفاده‌ای که در آن اعلان هشدار ارسال شود (پیش‌فرض: `80`) |
| NOTIFY_DAYS_LEFT | زمان ارسال اعلان هشدار در مورد انقضا به تعداد روزهای باقیمانده (پیش‌فرض: `3`) |

## توسعه و مستندات

| متغیر | توضیحات |
| ------ | ----------------------------------------------------------------------------------------- |
| DOCS | آیا مستندات API در دسترس باشد یا خیر (پیش‌فرض: `False`) |
| DEBUG | حالت دیباگ برای توسعه (پیش‌فرض: `False`) |

## نمونه فایل .env

```sh
SQLALCHEMY_DATABASE_URL=
UVICORN_HOST=
UVICORN_PORT=
UVICORN_UDS=
UVICORN_SSL_CERTFILE=
UVICORN_SSL_KEYFILE=
SUBSCRIPTION_URL_PREFIX=
CUSTOM_TEMPLATES_DIRECTORY=
CLASH_SUBSCRIPTION_TEMPLATE=
SUBSCRIPTION_PAGE_TEMPLATE=
HOME_PAGE_TEMPLATE=
TELEGRAM_API_TOKEN=
TELEGRAM_ADMIN_ID=
TELEGRAM_PROXY_URL=
JWT_ACCESS_TOKEN_EXPIRE_MINUTES=
AUTH_GENERATION_ALGORITHM="xxh128"
REVERSIBLE_KEY="False"
DOCS=true
DEBUG=true
WEBHOOK_ADDRESS="http://localhost:9000"
WEBHOOK_SECRET="dont-tell-anybody"
NUMBER_OF_RECURRENT_NOTIFICATIONS=
RECURRENT_NOTIFICATIONS_TIMEOUT=
NOTIFY_REACHED_USAGE_PERCENT=
NOTIFY_DAYS_LEFT=
```

## کنترل متغیرهای Marzneshin از طریق خط فرمان

| متغیر | توضیحات |
| ---------------------| -------------------------------------|
| marzneshin update | می‌توانید Marzneshin را به‌راحتی به‌روزرسانی کنید. |
| marzneshin stop | می‌توانید Marzneshin را متوقف کنید. |
| marzneshin start | می‌توانید Marzneshin را شروع کنید. |

---
7 changes: 7 additions & 0 deletions content/docs/configuration/marzneshin.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,10 @@ RECURRENT_NOTIFICATIONS_TIMEOUT=
NOTIFY_REACHED_USAGE_PERCENT=
NOTIFY_DAYS_LEFT=
```
## Marzneshin Control variables via shell

| Variable | Description |
| -------- | ------------------------------------------------------------------------------------------- |
| marzneshin update | you can update Marzneshin easily with |
| marzneshin stop | you can stop Marzneshin |
| marzneshin start | you can start Marzneshin |
91 changes: 90 additions & 1 deletion content/docs/configuration/marznode.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,93 @@
---
title: Marznode

title: Marznode
weight: 2

---

### Easy Installation Method:

1. Installing Docker and pulling Marznode with this command:

```bash
apt-get update -y && apt-get upgrade -y && curl -fsSL https://get.docker.com | sh && git clone https://github.com/marzneshin/marznode && cd marznode && docker compose up -d
```

2. Copy the Marznode certificate from settings in the Marzneshin panel and paste it into this file:

```bash
nano /var/lib/marznode/client.pem
```

3. Downloading the Xray core in this directory:
*Files we are downloading now are the latest version of Xray Core. If you want, you can download any version you desire by just putting the version number in the command!*

```bash
cd && mkdir -p /var/lib/marznode/data && cd /var/lib/marznode/data
```

```bash
wget https://github.com/XTLS/Xray-core/releases/download/v24.9.30/Xray-linux-64.zip && unzip Xray-linux-64.zip && rm Xray-linux-64.zip
```

4. Moving `xray_config.json` file to the Marznode directory:

```bash
cp /root/marznode/xray_config.json /var/lib/marznode/xray_config.json
```

5. Moving Xray files to the Marznode directory:

```bash
cp /var/lib/marznode/data/xray /var/lib/marznode/xray
```

6. Editing the Compose file:

```bash
cd && cd marznode
```

```bash
rm -rf compose.yml && nano compose.yml
```

7. Copy and paste this code into your `compose.yml` file and save it:

```yaml
services:
marznode:
image: dawsh/marznode:latest
restart: always
network_mode: host

environment:
SERVICE_PORT: "5566"
XRAY_EXECUTABLE_PATH: "/var/lib/marznode/xray"
XRAY_ASSETS_PATH: "/var/lib/marznode/data"
XRAY_CONFIG_PATH: "/var/lib/marznode/xray_config.json"
SSL_CLIENT_CERT_FILE: "/var/lib/marznode/client.pem"
SSL_KEY_FILE: "./server.key"
SSL_CERT_FILE: "./server.cert"

volumes:
- /var/lib/marznode:/var/lib/marznode
```

8. Now, just stop the Docker service and start it again:

```bash
docker compose down --remove-orphans; docker compose up -d
```

9. Now, go to the Marzneshin panel, then go to the Node section. Create a new node, add the node's IP and port `5566`, and save it. Done!

**Note:** You have to whitelist your node's IP in the master server, whitelist the master IP in your node, and also open the port of the API as well as the ports that you need for configuration inside `xray_core.json`:

```bash
ufw allow 5566
```

For more information on changing and modifying Xray Core settings, you can go to the Node section in the Marzneshin panel.

---
93 changes: 93 additions & 0 deletions content/docs/configuration/marznode_fa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---

title: Marznode
weight: 2

---

### روش نصب آسان:

1. نصب داکر و پول کردن ایمیج مرزنود با این دستور:

```bash
apt-get update -y && apt-get upgrade -y && curl -fsSL https://get.docker.com | sh && git clone https://github.com/khodedawsh/marznode && cd marznode && docker compose up -d
```

2. کپی کردن گواهی مرزنود از تنظیمات در پنل مرزنشین و قرار دادن آن در این فایل:

```bash
nano /var/lib/marznode/client.pem
```

3. دانلود هسته Xray در این دایرکتوری:
*فایلی که در حال حاضر دانلود می‌کنیم آخرین نسخه هسته Xray است. اگر می‌خواهید، می‌توانید هر نسخه دیگری را با تغییر شماره نسخه در دستور دانلود کنید!*

```bash
cd && mkdir -p /var/lib/marznode/data && cd /var/lib/marznode/data
```

```bash
wget https://github.com/XTLS/Xray-core/releases/download/v24.9.30/Xray-linux-64.zip && unzip Xray-linux-64.zip && rm Xray-linux-64.zip
```

4. انتقال فایل `xray_config.json` به دایرکتوری مرزنود :

```bash
cp /root/marznode/xray_config.json /var/lib/marznode/xray_config.json
```

5. انتقال فایل‌های Xray به دایرکتوری مرزنود :

```bash
cp /var/lib/marznode/data/xray /var/lib/marznode/xray
```

6. ویرایش فایل کامپوز :

```bash
cd && cd marznode
```

```bash
rm -rf compose.yml && nano compose.yml
```

7. این کد را در فایل `compose.yml` خود کپی و جای‌گذاری کنید و سپس ذخیره کنید:

```yaml
services:
marznode:
image: dawsh/marznode:latest
restart: always
network_mode: host

environment:
SERVICE_PORT: "5566"
XRAY_EXECUTABLE_PATH: "/var/lib/marznode/xray"
XRAY_ASSETS_PATH: "/var/lib/marznode/data"
XRAY_CONFIG_PATH: "/var/lib/marznode/xray_config.json"
SSL_CLIENT_CERT_FILE: "/var/lib/marznode/client.pem"
SSL_KEY_FILE: "./server.key"
SSL_CERT_FILE: "./server.cert"

volumes:
- /var/lib/marznode:/var/lib/marznode
```

8. اکنون، فقط سرویس داکر را متوقف کرده و دوباره شروع کنید:

```bash
docker compose down --remove-orphans; docker compose up -d
```

9. حالا به پنل مرزنشین بروید، سپس به بخش نود ها بروید. یک نود جدید ایجاد کنید، ایپی و پورت نود `5566` را اضافه کنید و ذخیره کنید. تمام!

**نکته:** شما باید ایپی نود خود را در سرور اصلی به لیست سفید اضافه کنید، ایپی سرور اصلی را در نود خود سفید کنید و همچنین پورت API و پورت‌هایی که برای پیکربندی در `xray_core.json` نیاز دارید را باز کنید:

```bash
ufw allow 5566
```

برای اطلاعات بیشتر در مورد تغییر و اصلاح تنظیمات هسته Xray، می‌توانید به بخش نود در پنل مرزنشین مراجعه کنید.

---
95 changes: 95 additions & 0 deletions content/docs/configuration/vpn-backends/hysteria.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@

---

title: Hysteria 2
weight: 2

---

In this tutorial, we will make basic Hysteria 2 core configurations and add it to the user subscription services.

For adding Hysteria 2 in Marznode:

1. Make a certificate using these commands:

```bash
cd /var/lib/marznode/
```

```bash
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=CommonNameOrHostname"
```

2. Go back to the Marznode default directory:

```bash
cd && cd marznode
```

3. Edit the `compose.yml` file:

```bash
nano compose.yml
```

4. Add Hysteria variables in `compose.yml`:

```yaml
HYSTERIA_EXECUTABLE_PATH: "/usr/local/bin/hysteria"
HYSTERIA_CONFIG_PATH: "./hysteria.yaml"
HYSTERIA_ENABLED: "True"
```

The docker compose should look like this:

```yaml
services:
marznode:
image: dawsh/marznode:latest
restart: always
network_mode: host

environment:
SERVICE_PORT: "5566"
XRAY_EXECUTABLE_PATH: "/var/lib/marznode/xray"
XRAY_ASSETS_PATH: "/var/lib/marznode/data"
XRAY_CONFIG_PATH: "/var/lib/marznode/xray_config.json"
SSL_CLIENT_CERT_FILE: "/var/lib/marznode/client.pem"
SSL_KEY_FILE: "./server.key"
SSL_CERT_FILE: "./server.cert"
HYSTERIA_EXECUTABLE_PATH: "/usr/local/bin/hysteria"
HYSTERIA_CONFIG_PATH: "./hysteria.yaml"
HYSTERIA_ENABLED: "True"

volumes:
- /var/lib/marznode:/var/lib/marznode
```

Then save the files and restart `compose.yml`:

```bash
docker compose down --remove-orphans; docker compose up -d
```

Now, go to the Node section in the Marzban panel, open the Hysteria section, and add these configurations:

```yaml
listen: :4443
tls:
cert: /var/lib/marznode/cert.pem
key: /var/lib/marznode/key.pem
auth:
type: command
command: echo
masquerade:
type: proxy
proxy:
url: https://news.ycombinator.com/
rewriteHost: true
```

*Keep in mind: In the host settings, you must allow insecure connections (because you made a self-hosted TLS certificate for this Hysteria 2 core). For more configuration add-ons, you can visit the Hysteria configuration tutorials at: [https://v2.hysteria.network/docs/getting-started/Server/](https://v2.hysteria.network/docs/getting-started/Server/).

After saving the core, you're done. To add this simple Hysteria 2 setup to your user subscription URL, go to the Services section in the Marzban panel, and then in the services you want to add, just click the inbound you just made!

---
Loading