mirror of
https://github.com/remnawave/panel.git
synced 2026-04-21 07:02:18 +00:00
docs: add PAGE_CONFIG_PROFILES.md
This commit is contained in:
kastov
64
_panel-docs/help-articles/en/PAGE_CONFIG_PROFILES.md
Normal file
64
_panel-docs/help-articles/en/PAGE_CONFIG_PROFILES.md
Normal file
@@ -0,0 +1,64 @@
|
||||
## Config Profiles
|
||||
|
||||
A Config Profile, in the context of Remnawave, represents a complete server configuration for the [Xray](https://xtls.github.io/en/config/) core.
|
||||
|
||||
In this configuration, you define _inbounds_ that your users will later connect to.
|
||||
|
||||
**The details of Xray configuration setup will not be described here, as this is a topic for independent study - use the official [Xray](https://xtls.github.io/en/config/) documentation to learn about all the capabilities of the core.**
|
||||
|
||||
When creating a new Config Profile, it is created by default with one _inbound_ of type **Shadowsocks**. After the Config Profile is created - you can modify this or add a new _inbound_.
|
||||
|
||||
_Tip: To add a new inbound, for example with the **VLESS** protocol - simply add another object inside the `inbounds:[]` array._
|
||||
|
||||
Currently, Remnawave supports protocols such as: `VLESS`, `Trojan`, `Shadowsocks` (`chacha20-ietf-poly1305`). And also the following transports: `RAW (TCP)`, `XHTTP`, `Websocket`, `HTTPUpgrade`.
|
||||
|
||||
It's important to note that Remnawave also supports protocols: `mixed(socks)`, `wireguard`, `http` - however, the panel will completely ignore them and user management for these protocols will be unavailable. These _inbounds_ will be passed to Xray in the exact form you specify them.
|
||||
|
||||
For the main protocols (`VLESS`, `Trojan`, `Shadowsocks`), Remnawave will manage the list of users that will be inside the server configuration. No additional actions are required on your part.
|
||||
|
||||
---
|
||||
|
||||
### Config Profiles List
|
||||
|
||||
In the general list of Config Profiles, a brief summary is available for each created Config Profile. Under the Config Profile name, you can see the number of active _inbounds_ within it, as well as the number of active **nodes** on which this Config Profile is active. Both icons are clickable - clicking on them will open the corresponding sections.
|
||||
|
||||
When clicking on _inbounds_ - a list of _inbounds_ will open, and for each inbound, it will show on how many internal squads this _inbound_ is activated.
|
||||
When clicking on _nodes_ - a list of _nodes_ where this specific Config Profile is active will open.
|
||||
|
||||
In the additional actions menu (down arrow), options for quick Config Profile viewing, viewing Config Profile with snippets, as well as other service options are available.
|
||||
|
||||
---
|
||||
|
||||
### Config Profile Editor
|
||||
|
||||
The Config Profile editor provides a full-featured JSON editor with syntax checking. Also, when hovering over certain objects, a tooltip with information from the Xray documentation will be available.
|
||||
|
||||
With any changes, the entire configuration is immediately validated by running a lightweight version of the core. Such validation helps prevent trivial errors and typos.
|
||||
|
||||
In the additional menu (at the very bottom, button with three bars), additional options are available. Let's skip the basic things: copy all, select all, and so on - these options are self-explanatory.
|
||||
|
||||
The "**Download from Github**" option will open an additional menu where you can download configuration examples from users. **These examples are not ready-to-use configurations, but are merely examples - keep this in mind.**
|
||||
|
||||
The "**Generate Keys**" option allows you to quickly and conveniently generate necessary key pairs right in the browser - for example, in the case of `Reality`, you will definitely need a `privateKey`, which can be generated in this menu. Other generation options are also available there, which will be useful for `Vless Encryption` - `ML-DSA65` and `ML-KEM768`.
|
||||
|
||||
---
|
||||
|
||||
### Snippets
|
||||
|
||||
When you have many Config Profiles - it can be quite difficult to quickly change small details that are present in all Config Profiles but differ in minor aspects.
|
||||
|
||||
For example, you have several profiles - let's say 10 pieces. In each of the 10, the routing section is the same and you would like to quickly and conveniently replace the rules in all profiles at once. With the snippets functionality, you only need to change the "rule" or "rules" in one place, and then they will automatically be pulled into the profiles.
|
||||
|
||||
Currently, you can predefine array elements for objects such as `outbounds` and `rules`. After creating a snippet, it will be available in one of these objects.
|
||||
|
||||
```
|
||||
{
|
||||
"outbounds": [
|
||||
{
|
||||
"snippet": "snippet-name"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Additional information about them is available by clicking on the question mark in the snippets menu.
|
||||
64
_panel-docs/help-articles/fa/PAGE_CONFIG_PROFILES.md
Normal file
64
_panel-docs/help-articles/fa/PAGE_CONFIG_PROFILES.md
Normal file
@@ -0,0 +1,64 @@
|
||||
## Config Profiles
|
||||
|
||||
A Config Profile, in the context of Remnawave, represents a complete server configuration for the [Xray](https://xtls.github.io/en/config/) core.
|
||||
|
||||
In this configuration, you define _inbounds_ that your users will later connect to.
|
||||
|
||||
**The details of Xray configuration setup will not be described here, as this is a topic for independent study - use the official [Xray](https://xtls.github.io/en/config/) documentation to learn about all the capabilities of the core.**
|
||||
|
||||
When creating a new Config Profile, it is created by default with one _inbound_ of type **Shadowsocks**. After the Config Profile is created - you can modify this or add a new _inbound_.
|
||||
|
||||
_Tip: To add a new inbound, for example with the **VLESS** protocol - simply add another object inside the `inbounds:[]` array._
|
||||
|
||||
Currently, Remnawave supports protocols such as: `VLESS`, `Trojan`, `Shadowsocks` (`chacha20-ietf-poly1305`). And also the following transports: `RAW (TCP)`, `XHTTP`, `Websocket`, `HTTPUpgrade`.
|
||||
|
||||
It's important to note that Remnawave also supports protocols: `mixed(socks)`, `wireguard`, `http` - however, the panel will completely ignore them and user management for these protocols will be unavailable. These _inbounds_ will be passed to Xray in the exact form you specify them.
|
||||
|
||||
For the main protocols (`VLESS`, `Trojan`, `Shadowsocks`), Remnawave will manage the list of users that will be inside the server configuration. No additional actions are required on your part.
|
||||
|
||||
---
|
||||
|
||||
### Config Profiles List
|
||||
|
||||
In the general list of Config Profiles, a brief summary is available for each created Config Profile. Under the Config Profile name, you can see the number of active _inbounds_ within it, as well as the number of active **nodes** on which this Config Profile is active. Both icons are clickable - clicking on them will open the corresponding sections.
|
||||
|
||||
When clicking on _inbounds_ - a list of _inbounds_ will open, and for each inbound, it will show on how many internal squads this _inbound_ is activated.
|
||||
When clicking on _nodes_ - a list of _nodes_ where this specific Config Profile is active will open.
|
||||
|
||||
In the additional actions menu (down arrow), options for quick Config Profile viewing, viewing Config Profile with snippets, as well as other service options are available.
|
||||
|
||||
---
|
||||
|
||||
### Config Profile Editor
|
||||
|
||||
The Config Profile editor provides a full-featured JSON editor with syntax checking. Also, when hovering over certain objects, a tooltip with information from the Xray documentation will be available.
|
||||
|
||||
With any changes, the entire configuration is immediately validated by running a lightweight version of the core. Such validation helps prevent trivial errors and typos.
|
||||
|
||||
In the additional menu (at the very bottom, button with three bars), additional options are available. Let's skip the basic things: copy all, select all, and so on - these options are self-explanatory.
|
||||
|
||||
The "**Download from Github**" option will open an additional menu where you can download configuration examples from users. **These examples are not ready-to-use configurations, but are merely examples - keep this in mind.**
|
||||
|
||||
The "**Generate Keys**" option allows you to quickly and conveniently generate necessary key pairs right in the browser - for example, in the case of `Reality`, you will definitely need a `privateKey`, which can be generated in this menu. Other generation options are also available there, which will be useful for `Vless Encryption` - `ML-DSA65` and `ML-KEM768`.
|
||||
|
||||
---
|
||||
|
||||
### Snippets
|
||||
|
||||
When you have many Config Profiles - it can be quite difficult to quickly change small details that are present in all Config Profiles but differ in minor aspects.
|
||||
|
||||
For example, you have several profiles - let's say 10 pieces. In each of the 10, the routing section is the same and you would like to quickly and conveniently replace the rules in all profiles at once. With the snippets functionality, you only need to change the "rule" or "rules" in one place, and then they will automatically be pulled into the profiles.
|
||||
|
||||
Currently, you can predefine array elements for objects such as `outbounds` and `rules`. After creating a snippet, it will be available in one of these objects.
|
||||
|
||||
```
|
||||
{
|
||||
"outbounds": [
|
||||
{
|
||||
"snippet": "snippet-name"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Additional information about them is available by clicking on the question mark in the snippets menu.
|
||||
64
_panel-docs/help-articles/ru/PAGE_CONFIG_PROFILES.md
Normal file
64
_panel-docs/help-articles/ru/PAGE_CONFIG_PROFILES.md
Normal file
@@ -0,0 +1,64 @@
|
||||
## Профили
|
||||
|
||||
Профиль, в контексте Remnawave, представляет из себя полную серверную конфигурацию ядра [Xray](https://xtls.github.io/ru/config/).
|
||||
|
||||
В этой конфигурации вы прописываете _инбаунды_, к которым потом будут подключаться ваши пользователи.
|
||||
|
||||
**Здесь не будут описаны детали настройки конфигурации Xray, так как это тема для самостоятельного изучения – воспользуйтесь официальной документацией [Xray](https://xtls.github.io/ru/config/) для изучения всех возможностей ядра.**
|
||||
|
||||
При создании нового профиля, профиль по умолчанию создается с одним _инбаундом_ типа **Shadowsocks**. После того, как профиль создан – вы можете изменить этот или добавить новый _инбаунд_.
|
||||
|
||||
_Совет: чтобы добавить новый инбаунд, например с протоколом **VLESS** – просто добавьте еще один объект внутрь массива `inbounds:[]`._
|
||||
|
||||
На данный момент, Remnawave поддерживает такие протоколы как: `VLESS`, `Trojan`,` Shadowsocks` (`chacha20-ietf-poly1305`). И так же следующие транспорты: `RAW (TCP)`, `XHTTP`, `Websocket`, `HTTPUpgrade`.
|
||||
|
||||
Важно отметить, что Remnawave так же поддерживает протоколы: `mixed(socks)`, `wireguard`,`http` – однако панель будет полностью их игнорировать и менеджмент пользователей для этих протоколов будет недоступен. Эти _инбаунды_ будет переданы в Xray в таком виде, в каком вы их укажите.
|
||||
|
||||
Для основных протоколов (`VLESS`, `Trojan`, `Shadowsocks`) Remnawave будет заниматься управлением списка пользователей, которые будут внутри серверной конфигурации. С вашей стороны никаких дополнительных действий не требуется.
|
||||
|
||||
---
|
||||
|
||||
### Список профилей
|
||||
|
||||
В общем списке профилей доступна краткая сводка по каждому созданному профилю. Под названием профиля вы можете увидеть количество активных _инбаундов_ внутри него, а так же количество активных **нод**, на которых этот профиль активен. Оба значка – кликабельны, при нажатии на них откроются соотвествующие разделы.
|
||||
|
||||
При клике на _инбаунды_ – будет открыт список _инбаундов_, и так же для каждого инбаунда будет написано, на скольких внутренних сквада этот _инбаунд_ активирован.
|
||||
При клике на _ноды_ – будет открыт список _нод_, который этот конкретный профиль активен.
|
||||
|
||||
В меню дополнительных действий (стрелочка вниз) доступны опции по быстрому просмотру конфигурации, просмотр конфигурации со сниппетами, а так же остальные сервисные опции.
|
||||
|
||||
---
|
||||
|
||||
### Редактор конфигурации
|
||||
|
||||
В редакторе конфигурации доступен полноценный JSON редактор, с проверкой синтаксиса, так же при наведении на некоторые объекты будет доступна всплывающая подсказка с информацией из документации Xray.
|
||||
|
||||
При любы изменений, вся конфигурация немедленно валидируется путем запуска облегченной версии ядра. Такая валидация поможет не допускать банальных ошибок и опечаток.
|
||||
|
||||
В дополнительном меню (в самом низу, кнопка с тремя полосками) доступны дополнительные опции. Опустим базовые вещи: скопировать все, выделить все и так далее – эти опции понятны и без объяснения.
|
||||
|
||||
Пункт "**Скачать с Github**" откроет дополнительное меню, в котором вы можете скачать примеры конфигурации от пользователей. **Эти примеры не представляют из себя готовую конфигурацию, а лишь являются примерами – имейте это в виду.**
|
||||
|
||||
Пункт "**Сгенерировать ключи**" позволит прямо в браузере быстро и удобно сгенерировать необходимые пары ключей – например, в случае с `Reality` вам гарантировано будет нужен `privateKey`, который как раз можно сгенерировать в этом меню. Там же доступны и другие варианты генерации, которые пригодятся для `Vless Encryption` - `ML-DSA65` и `ML-KEM768`.
|
||||
|
||||
---
|
||||
|
||||
### Сниппеты
|
||||
|
||||
Когда профилей (конфигураций) становится много – бывает довольно сложно быстро поменять какие мелочи, которые присутствуют во всех профилях, но отличаются в мелочах.
|
||||
|
||||
Например, у вас есть несколько профилей – допустим 10 штук, в каждом из 10 штук раздел роутинга у вас одинаковый и вы бы хотели быстро и удобно заменить правила во всех профилях сразу. С функционалом сниппетов вам будет достаточно изменить "правило" или "правила" в одном месте, а потом они автоматически подтянутся в профили.
|
||||
|
||||
На данный момент вы можете заранее предопределить элементы массивов для таких объектов как `outbounds` и `rules`. После создания сниппета он будет доступен в одном из этих объектов.
|
||||
|
||||
```
|
||||
{
|
||||
"outbounds": [
|
||||
{
|
||||
"snippet": "snippet-name"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Дополнительная информация по ним доступна при нажатии на знак вопроса в меню сниппетов.
|
||||
64
_panel-docs/help-articles/zh/PAGE_CONFIG_PROFILES.md
Normal file
64
_panel-docs/help-articles/zh/PAGE_CONFIG_PROFILES.md
Normal file
@@ -0,0 +1,64 @@
|
||||
## Config Profiles
|
||||
|
||||
A Config Profile, in the context of Remnawave, represents a complete server configuration for the [Xray](https://xtls.github.io/en/config/) core.
|
||||
|
||||
In this configuration, you define _inbounds_ that your users will later connect to.
|
||||
|
||||
**The details of Xray configuration setup will not be described here, as this is a topic for independent study - use the official [Xray](https://xtls.github.io/en/config/) documentation to learn about all the capabilities of the core.**
|
||||
|
||||
When creating a new Config Profile, it is created by default with one _inbound_ of type **Shadowsocks**. After the Config Profile is created - you can modify this or add a new _inbound_.
|
||||
|
||||
_Tip: To add a new inbound, for example with the **VLESS** protocol - simply add another object inside the `inbounds:[]` array._
|
||||
|
||||
Currently, Remnawave supports protocols such as: `VLESS`, `Trojan`, `Shadowsocks` (`chacha20-ietf-poly1305`). And also the following transports: `RAW (TCP)`, `XHTTP`, `Websocket`, `HTTPUpgrade`.
|
||||
|
||||
It's important to note that Remnawave also supports protocols: `mixed(socks)`, `wireguard`, `http` - however, the panel will completely ignore them and user management for these protocols will be unavailable. These _inbounds_ will be passed to Xray in the exact form you specify them.
|
||||
|
||||
For the main protocols (`VLESS`, `Trojan`, `Shadowsocks`), Remnawave will manage the list of users that will be inside the server configuration. No additional actions are required on your part.
|
||||
|
||||
---
|
||||
|
||||
### Config Profiles List
|
||||
|
||||
In the general list of Config Profiles, a brief summary is available for each created Config Profile. Under the Config Profile name, you can see the number of active _inbounds_ within it, as well as the number of active **nodes** on which this Config Profile is active. Both icons are clickable - clicking on them will open the corresponding sections.
|
||||
|
||||
When clicking on _inbounds_ - a list of _inbounds_ will open, and for each inbound, it will show on how many internal squads this _inbound_ is activated.
|
||||
When clicking on _nodes_ - a list of _nodes_ where this specific Config Profile is active will open.
|
||||
|
||||
In the additional actions menu (down arrow), options for quick Config Profile viewing, viewing Config Profile with snippets, as well as other service options are available.
|
||||
|
||||
---
|
||||
|
||||
### Config Profile Editor
|
||||
|
||||
The Config Profile editor provides a full-featured JSON editor with syntax checking. Also, when hovering over certain objects, a tooltip with information from the Xray documentation will be available.
|
||||
|
||||
With any changes, the entire configuration is immediately validated by running a lightweight version of the core. Such validation helps prevent trivial errors and typos.
|
||||
|
||||
In the additional menu (at the very bottom, button with three bars), additional options are available. Let's skip the basic things: copy all, select all, and so on - these options are self-explanatory.
|
||||
|
||||
The "**Download from Github**" option will open an additional menu where you can download configuration examples from users. **These examples are not ready-to-use configurations, but are merely examples - keep this in mind.**
|
||||
|
||||
The "**Generate Keys**" option allows you to quickly and conveniently generate necessary key pairs right in the browser - for example, in the case of `Reality`, you will definitely need a `privateKey`, which can be generated in this menu. Other generation options are also available there, which will be useful for `Vless Encryption` - `ML-DSA65` and `ML-KEM768`.
|
||||
|
||||
---
|
||||
|
||||
### Snippets
|
||||
|
||||
When you have many Config Profiles - it can be quite difficult to quickly change small details that are present in all Config Profiles but differ in minor aspects.
|
||||
|
||||
For example, you have several profiles - let's say 10 pieces. In each of the 10, the routing section is the same and you would like to quickly and conveniently replace the rules in all profiles at once. With the snippets functionality, you only need to change the "rule" or "rules" in one place, and then they will automatically be pulled into the profiles.
|
||||
|
||||
Currently, you can predefine array elements for objects such as `outbounds` and `rules`. After creating a snippet, it will be available in one of these objects.
|
||||
|
||||
```
|
||||
{
|
||||
"outbounds": [
|
||||
{
|
||||
"snippet": "snippet-name"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Additional information about them is available by clicking on the question mark in the snippets menu.
|
||||
Reference in New Issue
Block a user