Skip to content

Commit

Permalink
Update host-settings.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iamtheted authored Mar 15, 2024
1 parent 5eccbb5 commit bfef252
Showing 1 changed file with 47 additions and 60 deletions.
107 changes: 47 additions & 60 deletions marzban/en/docs/host-settings.md
Original file line number Diff line number Diff line change
@@ -1,87 +1,74 @@
# تنظیمات هاست
# Host Settings

هدف از تنظیمات هاست، سفارشی سازی کانفیگ ها است.
به کمک تنظیمات هاست، شما میتوانید کانفیگ های خاصی برای هر اینباند بسازید. هر کانفیگ میتواند تنظیمات خاصی داشته باشد. در تنظیمات هاست فیلد های زیر قابل ویرایش هستند.
The purpose of host settings is to customize configurations.
With host settings, you can create specific configurations for each inbound. Each configuration can have its own settings. The following fields can be modified in host settings.

- Remark
- Address
- Port
- SNI
- Host
- Path
- Security Layer (TLS, None)
- ALPN (h2, http/1.1)
- Fingerprint

با تنظیماتی که در این بخش انجام میدهید، شما میتوانید برای هر اینباند، چندین آدرس یا دامین با نام های مختلف تعیین کنید. یکی از کاربرد های این بخش این است که اگر سرور شما با تنظیمات خاصی نگهداری میشود، ممکن است لازم باشد پورت اتصال کاربر با پورت اینباند متفاوت باشد. با تنظیمات این بخش شما میتونید پورت اتصال، SNI، هاست و... را سفارشی سازی کنید.
The settings provided in this section lets you assign multiple addresses or domains with different names for each inbound. One use of this section is that if your server is maintained with specific settings, it may be necessary for the user's connection port to be different from the inbound port. Using these settings, you can customize the connection port, SNI, Host, Path, etc.

به طور پیشفرض، آیپی سرور به عنوان Address و تنظیمات پیشفرض اینباند (پورت و...) برای هر کانفیگ تنظیم میشود. برای سفارشی سازی کانفیگ ها، لازم است این بخش را ویرایش کنید.
By default, the server's IP is set as the address, and default inbound settings (such as port, etc.) are applied to each configuration. To customize configurations, you need to edit this section.

::: info نکته
تنظیمات هاست الویت بالاتری نسبت به تنظیمات دیگر دارد. فیلد هایی که در این این بخش تنظیم می شوند، با بالاترین الویت در تولید کانفیگ ها اعمال میشوند.
::: info Tip
The host settings have higher priority compared to other settings. The fields configured in this section are prioritized over other settings in generating configurations.
:::

## متغیرها
برای سفارشی سازی حداکثری کانفیگ ها متغییر هایی برای هرکدام طراحی شده است. در هر فیلد لازم است از متغیر های همان فیلد استفاده شود.
## Variables
To customize configurations, variables have been designed for each field. It is necessary to use variables specific to each field. You can use the following varibles either in Remark section or Address.

::: warning توجه
دقت کنید که متغیر ها حتما باید همراه با `}‍` و `{` در فیلد ها قرار داده شوند.
::: warning Attention
Please note that variables must be used with `{}` in the fields.
:::

### Remark

| نام متغیر | توضیحات |
| -------------- | ---------------------------------------------------------- |
| `{SERVER_IP}` | آیپی ورژن ۴ سرور |
| `{USERNAME}` | نام کاربری کاربر |
| `{DATA_USAGE}` | میزان مصرف کاربر |
| `{DATA_LEFT}` | میزان حجم باقی مانده کاربر |
| `{DATA_LIMIT}` | میزان حجم کلی کاربر |
| `{DAYS_LEFT}` | روز های باقی مانده از اشتراک کاربر |
| `{PROTOCOL}` | پروتکل کانفیگ مثلا: VMess, VLESS, Trojan و... |
| `{TRANSPORT}` | روش ترنسپورت کانفیگ(Transport Method) ، مثلا: ws, tcp و... |


به عنوان مثال:

| فیلد remark | خروجی |
| ------------------------------------------------------ | ------------------------------- |
| 🚀 سرور ‍‍۱ (\{USERNAME\}) [\{PROTOCOL\} - \{TRANSPORT\}] | 🚀 سرور ۱ (user102) [VMess - ws] |
| \{DAYS_LEFT\} روز باقی مانده | 24 روز باقی مانده |
| حجم مصرفی: \{DATA_LEFT\}/\{DATA_LIMIT\} | حجم مصرفی: 16.5GB/30GB |


### Address

| نام متغیر | توضیحات |
| -------------- | ---------------------------------------------------------- |
| `{SERVER_IP}` | آیپی ورژن ۴ سرور |
| `{USERNAME}` | نام کاربری کاربر |
| `{DATA_USAGE}` | میزان مصرف کاربر |
| `{DATA_LEFT}` | میزان حجم باقی مانده کاربر |
| `{DATA_LIMIT}` | میزان حجم کلی کاربر |
| `{DAYS_LEFT}` | روز های باقی مانده از اشتراک کاربر |
| `{PROTOCOL}` | پروتکل کانفیگ مثلا: VMess, VLESS, Trojan و... |
| `{TRANSPORT}` | روش ترنسپورت کانفیگ(Transport Method) ، مثلا: ws, tcp و... |

## ایجاد عبارت تصادفی

در بعضی مواقع نیاز است بخشی از فیلد های SNI و Host به صورت تصادفی تولید شوند. این تکنیک در بعضی مواقع برای جلوگیری از اتصال های زیاد به یک ساب دامین خاص استفاده میشود. در این صورت هر کاربر به یک ساب دامین تصادفی متصل میشود.

برای استفاده از این قابلیت، در فیلد های SNI و Host از کاراکتر `*` استفاده کنید.


::: warning نکته
توجه داشته باشید که در این صورت لازم است تنظیمات مربوط به wildcard دامنه انجام شده باشد.
| Variables | Description |
| ----------------------- | ------------------------------------------------------------------- |
| `{SERVER_IP}` | Master Server's IPv4 |
| `{USERNAME}` | User's Username |
| `{DATA_USAGE}` | User's Data Usage |
| `{DATA_LEFT}` | User's Remaining Data |
| `{DATA_LIMIT}` | User's Total Data Limit |
| `{DAYS_LEFT}` | Remaining Days of the User's Subscription |
| `{TIME_LEFT}` | Remaining Days, Hours, Minutes, Seconds of the User's Subscription |
| `{EXPIRE_DATE}` | User's Expiration Date in English Calendar |
| `{JALALI_EXPIRE_DATE}` | User's Expiration Date in Persian Calendar |
| `{STATUS_EMOJI}` | User Status as an Emoji (✅,⌛️,🪫,❌,🔌) |
| `{PROTOCOL}` | Configuration Protocols: Vless, Vmess ,Trojan, Shadowsocks, ... |
| `{TRANSPORT}` | Transport Method for the Configuration: TCP, WS, gRPC, ... |

Example:

| Remark field | Output |
| ----------------------------------------------------------- | ------------------------------------ |
| 🚀 Server 1 (\{USERNAME\}) [\{PROTOCOL\} - \{TRANSPORT\}] | 🚀 Server 1 (user102) [VMess - ws] |
| Days Left: \{DAYS_LEFT\} | Dayy Left: 24 |
| Data Used: \{DATA_LEFT\}/\{DATA_LIMIT\} | Data Used: 16.5GB/30GB |

## Generating Random Phrases

Sometimes, there's a need to generate a random part of the SNI and Host fields. This technique is used in some cases to prevent excessive connections to a specific subdomain. In this scenario, each user connects to a random subdomain.

To utilize this feature, use the `*` character in the SNI and Host fields.

::: warning Attention
Please note that, it is necessary to generate wildcard SSL certificate for your domain in order for this to work.
:::


به عنوان مثال:
Example:

| فیلد host یا SNI | نمونه عبارت تولید شده در کانفیگ به ازای این فیلد ها |
| SNI or Host field | Configuration's output in the fields |
| ---------------------- | --------------------------------------------------- |
| `*.example.com` | 32ks0ef23402.example.com |
| `access-*.example.com` | access-laks038fn201.example.com |

### چندین Host و SNI
### Multiple Host or SNI

در صورتی که لازم است چندین آدرس مختلف برای Host و SNI تنظیم شود می توانید آن آدرس ها را با `,` از هم جدا کنید. برای هر کاربر به صورت تصادفی یکی از این آدرس ها انتخاب خواهد شد.
In case you want to set multiple addresses for Host and SNI, you can separate those addresses with commas. Then, for each user, one of these addresses will be randomly selected.

0 comments on commit bfef252

Please sign in to comment.