chore: new help articles

This commit is contained in:
kastov
2025-11-09 18:12:22 +03:00
parent bba7a56927
commit b1d1e256c6
15 changed files with 293 additions and 87 deletions

View File

@@ -0,0 +1,17 @@
## OAuth2: GitHub
### Creating an OAuth Application
First, you need to create an OAuth application.
Follow the link to create an application: [https://github.com/settings/applications/new](https://github.com/settings/applications/new)
```bash title="Authorization callback URL"
# Replace YOUR_PANEL_DOMAIN with your panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/github
```
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
### OAuth2 Settings in Remnawave
After creating the OAuth2 application copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.

View File

@@ -0,0 +1,17 @@
## OAuth2: PocketID
### Creating an OIDC Client
Log in to the PocketID admin panel and navigate to: `Settings``OIDC Clients``Add OIDC Client`
```
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/pocketid
```
### OAuth2 Settings in Remnawave
After creating the OAuth2 application copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.
In the `Plain Domain` field, enter the domain address where your PocketID is located.
Just enter the domain name without the path and `https://`, for example: `pocketid.your-domain.com`

View File

@@ -0,0 +1,20 @@
## OAuth2: Yandex
The Yandex authentication method is not recommended for use.
### Creating an OAuth Application
You need to create an OAuth application in Yandex.
Follow the link to create an application: https://oauth.yandex.com/client/new
On the second step of application creation, select the "Web application" option and enter the `Callback URL`
```
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/yandex
```
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
On the third step of creation make sure to check the box next to `Access to email address`, no other permissions are required.

View File

@@ -0,0 +1,17 @@
## OAuth2: GitHub
### Creating an OAuth Application
First, you need to create an OAuth application.
Follow the link to create an application: [https://github.com/settings/applications/new](https://github.com/settings/applications/new)
```bash title="Authorization callback URL"
# Replace YOUR_PANEL_DOMAIN with your panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/github
```
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
### OAuth2 Settings in Remnawave
After creating the OAuth2 application copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.

View File

@@ -0,0 +1,17 @@
## OAuth2: PocketID
### Creating an OIDC Client
Log in to the PocketID admin panel and navigate to: `Settings``OIDC Clients``Add OIDC Client`
```
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/pocketid
```
### OAuth2 Settings in Remnawave
After creating the OAuth2 application copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.
In the `Plain Domain` field, enter the domain address where your PocketID is located.
Just enter the domain name without the path and `https://`, for example: `pocketid.your-domain.com`

View File

@@ -0,0 +1,39 @@
## Telegram OAuth2
To configure the "Login via Telegram" feature, you need a Telegram bot. Additionally, you need to configure the bot for the feature to work correctly.
### Bot Configuration
1. Open @BotFather (https://t.me/botfather)
2. Send the `/mybots` command and select the required bot
3. Select the option `Bot settings``Domain`
4. Select the option `Set domain`
Now send the bot a message containing the domain name used to access Remnawave.
```
https://panel.domain.com
```
### Access Configuration
After entering the bot token, you need to specify a list of administrator IDs who will have access to login.
1. From the required account, launch the bot https://t.me/Get_myidrobot
2. In response, the bot will send you your ID, enter it in the corresponding field.
---
### Known Error Solutions
###### Error: BOT_DOMAIN_INVALID
This error occurs due to incorrect bot domain configuration review the "Bot Configuration" section (above). If necessary, repeat this step-by-step process.
###### Error: Telegram confirmation code not received during login
Unfortunately, this issue cannot be resolved from the Remnawave side. Try using a bot that was created a while ago or use a different browser.
Alternatively, you can try logging in on one of the "official" resources for example, https://fragment.com. Since the Telegram session within the browser will be shared you can try logging into the panel.

View File

@@ -0,0 +1,20 @@
## OAuth2: Yandex
The Yandex authentication method is not recommended for use.
### Creating an OAuth Application
You need to create an OAuth application in Yandex.
Follow the link to create an application: https://oauth.yandex.com/client/new
On the second step of application creation, select the "Web application" option and enter the `Callback URL`
```
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/yandex
```
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
On the third step of creation make sure to check the box next to `Access to email address`, no other permissions are required.

View File

@@ -0,0 +1,17 @@
## OAuth2: Github
### Создание OAuth приложения
Для начала вам необходимо создать OAuth приложение.
Перейдите по ссылке для создания приложения: [https://github.com/settings/applications/new](https://github.com/settings/applications/new)
```bash title="Authorization callback URL"
# Замените YOUR_PANEL_DOMAIN на адрес вашей панели
https://YOUR_PANEL_DOMAIN/oauth2/callback/github
```
Не забудьте заменить `YOUR_PANEL_DOMAIN` на корректный адрес панели.
### Настройки OAuth2 в Remnawave
После создания OAuth2 приложения скопируйте `Client ID` и `Client Secret`. Вставьте эти данные в соответствующем разделе. А чуть ниже введите список email-адресов для которых будет разрешен вход.

View File

@@ -0,0 +1,16 @@
## OAuth2: PocketID
### Создание OIDC Client
Зайдите в админ-панели PocketID и перейдите: `Settings``OIDC Clients``Add OIDC Client`
```
# Замените YOUR_PANEL_DOMAIN на ваш адрес панели Remnawave
https://YOUR_PANEL_DOMAIN/oauth2/callback/pocketid
```
### Настройки OAuth2 в Remnawave
После создания OAuth2 приложения скопируйте `Client ID` и `Client Secret`. Вставьте эти данные в соответствующем разделе. А чуть ниже введите список email-адресов для которых будет разрешен вход.
В поле `Домен` (`Plain Domain`) введите доменный адрес, на котором у вас расположен PocketID. Достаточно ввести просто доменное имя без пути и https://, например: `pocketid.your-domain.com`

View File

@@ -0,0 +1,20 @@
## OAuth2: Yandex
Метод аутентификации через Яндекс не рекомендуется к использованию.
### Создание OAuth приложения
Вам необходимо создать Oauth-приложение в Яндексе.
Перейдите по ссылке для создания приложения: https://oauth.yandex.com/client/new
На втором шаге создания приложения выберите опцию "Веб-приложени" и впишите `Callback URL`
```
# Замените YOUR_PANEL_DOMAIN на ваш адрес панели Remnawave
https://YOUR_PANEL_DOMAIN/oauth2/callback/yandex
```
Не забудьте заменить `YOUR_PANEL_DOMAIN` на корректный адрес панели.
На третьем шаге создания обязательно поставьте галочку возле пункта `Access to email address` (`Доступ к email адресу`), никаких других разрешений не требуется.

View File

@@ -0,0 +1,17 @@
## OAuth2: GitHub
### Creating an OAuth Application
First, you need to create an OAuth application.
Follow the link to create an application: [https://github.com/settings/applications/new](https://github.com/settings/applications/new)
```bash title="Authorization callback URL"
# Replace YOUR_PANEL_DOMAIN with your panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/github
```
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
### OAuth2 Settings in Remnawave
After creating the OAuth2 application copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.

View File

@@ -0,0 +1,17 @@
## OAuth2: PocketID
### Creating an OIDC Client
Log in to the PocketID admin panel and navigate to: `Settings``OIDC Clients``Add OIDC Client`
```
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/pocketid
```
### OAuth2 Settings in Remnawave
After creating the OAuth2 application copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.
In the `Plain Domain` field, enter the domain address where your PocketID is located.
Just enter the domain name without the path and `https://`, for example: `pocketid.your-domain.com`

View File

@@ -0,0 +1,39 @@
## Telegram OAuth2
To configure the "Login via Telegram" feature, you need a Telegram bot. Additionally, you need to configure the bot for the feature to work correctly.
### Bot Configuration
1. Open @BotFather (https://t.me/botfather)
2. Send the `/mybots` command and select the required bot
3. Select the option `Bot settings``Domain`
4. Select the option `Set domain`
Now send the bot a message containing the domain name used to access Remnawave.
```
https://panel.domain.com
```
### Access Configuration
After entering the bot token, you need to specify a list of administrator IDs who will have access to login.
1. From the required account, launch the bot https://t.me/Get_myidrobot
2. In response, the bot will send you your ID, enter it in the corresponding field.
---
### Known Error Solutions
###### Error: BOT_DOMAIN_INVALID
This error occurs due to incorrect bot domain configuration review the "Bot Configuration" section (above). If necessary, repeat this step-by-step process.
###### Error: Telegram confirmation code not received during login
Unfortunately, this issue cannot be resolved from the Remnawave side. Try using a bot that was created a while ago or use a different browser.
Alternatively, you can try logging in on one of the "official" resources for example, https://fragment.com. Since the Telegram session within the browser will be shared you can try logging into the panel.

View File

@@ -0,0 +1,20 @@
## OAuth2: Yandex
The Yandex authentication method is not recommended for use.
### Creating an OAuth Application
You need to create an OAuth application in Yandex.
Follow the link to create an application: https://oauth.yandex.com/client/new
On the second step of application creation, select the "Web application" option and enter the `Callback URL`
```
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
https://YOUR_PANEL_DOMAIN/oauth2/callback/yandex
```
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
On the third step of creation make sure to check the box next to `Access to email address`, no other permissions are required.

View File

@@ -1,87 +0,0 @@
---
sidebar_position: 4
title: OAuth2 Configuration
---
OAuth2 allows you to authenticate to Remnawave dashboard using one of the configured providers.
<div style={{ display: 'flex', justifyContent: 'center' }}>
<img src="/features/oauth2/oauth2-providers.webp" alt="OAuth2 Configuration" width="800" style={{ borderRadius: '8px' }} />
</div>
Remnawave supports the following providers:
- Telegram (follow [this guide](./telegram-oauth.md) to configure)
- [GitHub](#github)
- [Yandex](#yandex)
- [PocketID](#pocketid)
---
## Github {#github}
### Create an OAuth application
You will need to create an OAuth application in Github.
Follow this link to create an application: [https://github.com/settings/applications/new](https://github.com/settings/applications/new)
```bash title="Authorization callback URL"
# Replace YOUR_PANEL_DOMAIN with your panel domain
https://YOUR_PANEL_DOMAIN/oauth2/callback/github
```
:::warning
Don't forget to set the correct callback URL. Change `YOUR_PANEL_DOMAIN` to your panel domain.
:::
### Configuring OAuth2 in Remnawave
1. Open Remnawave Panel and move to `Remnawave Settings` -> `Authentication Methods`.
2. Select desired method and click on it to open configuration.
3. Click on `Enable` button.
4. Enter Client ID and Client Secret.
5. Enter List of allowed emails.
6. Click on `Save` button.
## PocketID {#pocketid}
### Create an OIDC Client
Login to your self-hosted PocketID instance and go to `Settings` → `OIDC Clients` → `Add OIDC Client`.
```bash title="Authorization callback URL"
# Replace YOUR_PANEL_DOMAIN with your panel domain
https://YOUR_PANEL_DOMAIN/oauth2/callback/pocketid
```
:::warning
Don't forget to set the correct callback URL. Change `YOUR_PANEL_DOMAIN` to your panel domain.
:::
## Yandex {#yandex}
:::danger
It is not recommended to use Yandex OAuth2 for self-hosted Remnawave instances.
:::
### Create an OAuth application
You will need to create an OAuth application in Yandex.
Follow this link to create an application: [https://oauth.yandex.com/client/new](https://oauth.yandex.com/client/new)
In the second step of creation select "Web application" and set the following callback URL:
```bash title="Authorization callback URL"
# Replace YOUR_PANEL_DOMAIN with your panel domain
https://YOUR_PANEL_DOMAIN/oauth2/callback/yandex
```
:::warning
Don't forget to set the correct callback URL. Change `YOUR_PANEL_DOMAIN` to your panel domain.
:::
In the third step of creation allow "Access to email address", no other permissions are needed.