VPN/panel
1
0
Fork 0
mirror of https://github.com/remnawave/panel.git synced 2026-04-26 09:48:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: v1.6.x upgrading guide

Browse Source
This commit is contained in:
kastov
2025-05-10 21:31:51 +03:00
parent b66838c9b8
commit b55a59dc84
3 changed files with 225 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/install/environment-variables.md
View File

@@ -155,31 +155,59 @@ JWT_API_TOKENS_SECRET=strong_secret_key
## Telegram Notifications
`TELEGRAM_ADMIN_ID`, `TELEGRAM_ADMIN_THREAD_ID` is used to send notifications about user events.
`TELEGRAM_NOTIFY_USERS_CHAT_ID`, `TELEGRAM_NOTIFY_USERS_THREAD_ID` is used to send notifications about user events.
`NODES_NOTIFY_CHAT_ID`, `NODES_NOTIFY_THREAD_ID` is used to send notifications about node events.
`TELEGRAM_NOTIFY_NODES_CHAT_ID`, `TELEGRAM_NOTIFY_NODES_THREAD_ID` is used to send notifications about node events.
| Variable | Description | Default | Possible values |
| -------------------------- | ------------------------------------- | ------- | --------------- |
| `IS_TELEGRAM_ENABLED` | Disable/Enable Telegram notifications | `false` | `true`, `false` |
| `TELEGRAM_BOT_TOKEN` | The token for the Telegram bot | | |
| `TELEGRAM_ADMIN_ID` | The admin id for the Telegram bot | | |
| `NODES_NOTIFY_CHAT_ID` | The chat id for the Telegram bot | | |
| `NODES_NOTIFY_THREAD_ID` | The thread id for the Telegram bot | | |
| `TELEGRAM_ADMIN_THREAD_ID` | The thread id for the Telegram bot | | |
| Variable | Description | Default | Possible values |
| ----------------------------------- | ------------------------------------- | ------- | --------------- |
| `IS_TELEGRAM_NOTIFICATIONS_ENABLED` | Disable/Enable Telegram notifications | `false` | `true`, `false` |
| `TELEGRAM_BOT_TOKEN` | The token for the Telegram bot | | |
| `TELEGRAM_NOTIFY_USERS_CHAT_ID` | The user/group chat id | | |
| `TELEGRAM_NOTIFY_NODES_CHAT_ID` | The user/group chat id | | |
| `TELEGRAM_NOTIFY_USERS_THREAD_ID` | The topic id of Telegram group | | |
| `TELEGRAM_NOTIFY_NODES_THREAD_ID` | The topic id of Telegram group | | |
<details>
<summary>Example</summary>
```bash title=".env file"
IS_TELEGRAM_ENABLED=true
TELEGRAM_BOT_TOKEN=1234567890
TELEGRAM_ADMIN_ID=1234567890
TELEGRAM_ADMIN_THREAD_ID=1234567890
# Disable/Enable Telegram notifications
IS_TELEGRAM_NOTIFICATIONS_ENABLED=false
NODES_NOTIFY_CHAT_ID=1
NODES_NOTIFY_THREAD_ID=1
# Telegram bot token
TELEGRAM_BOT_TOKEN=change_me
# Notifications about users
TELEGRAM_NOTIFY_USERS_CHAT_ID=change_me
# Notifications about nodes
TELEGRAM_NOTIFY_NODES_CHAT_ID=change_me
# Optional, if you want to send notifications to specific topics in Telegram group
TELEGRAM_NOTIFY_USERS_THREAD_ID=1
TELEGRAM_NOTIFY_NODES_THREAD_ID=2
```
</details>
## Telegram OAuth
| Variable | Description | Default | Possible values |
| -------------------------- | ------------------------------------------------------------ | ------- | --------------- |
| `TELEGRAM_OAUTH_ENABLED` | Disable/Enable Telegram OAuth | `false` | `true`, `false` |
| `TELEGRAM_OAUTH_ADMIN_IDS` | Array of Admin Chat Ids. These ids will be allowed to login. | |
<details>
<summary>Example</summary>
```bash title=".env file"
### Telegram Oauth (Login with Telegram)
### true/false
TELEGRAM_OAUTH_ENABLED=false
### Array of Admin Chat Ids. These ids will be allowed to login.
TELEGRAM_OAUTH_ADMIN_IDS=[123, 321]
```
</details>
@@ -350,3 +378,4 @@ IS_HTTP_LOGGING_ENABLED=true
```
</details>
````

50
docs/install/remnawave-subscription-page.md
View File

@@ -38,8 +38,8 @@ services:
restart: always
environment:
// highlight-next-line-yellow
- REMNAWAVE_PLAIN_DOMAIN=panel.com
- SUBSCRIPTION_PAGE_PORT=3010
- REMNAWAVE_PANEL_URL=https://panel.com
- APP_PORT=3010
- META_TITLE="Subscription Page Title"
- META_DESCRIPTION="Subscription Page Description"
ports:
@@ -57,6 +57,8 @@ networks:
Please replace `panel.com` with the URL at which the **Remnawave Dashboard** is available.
`REMNAWAVE_PANEL_URL` can be http (bridged Remnawave, example: `http://remnawave:3000`) or https (example: `https://panel.com`).
:::
:::tip
@@ -72,6 +74,38 @@ And you will need to specify similar changes to the valid path in your configura
:::
<details>
<summary>Full .env file reference</summary>
```bash title=".env file"
APP_PORT=3010
### Remnawave Panel URL, can be http://remnawave:3000 or https://panel.example.com
REMNAWAVE_PANEL_URL=https://panel.example.com
META_TITLE="Subscription page"
META_DESCRIPTION="Subscription page description"
# Serve at custom root path, for example, this value can be: CUSTOM_SUB_PREFIX=sub
# Do not place / at the start/end
CUSTOM_SUB_PREFIX=
# Support Marzban links
MARZBAN_LEGACY_LINK_ENABLED=false
MARZBAN_LEGACY_SECRET_KEY=
REMNAWAVE_API_TOKEN=
# If you use "Caddy with security" addon, you can place here X-Api-Key, which will be applied to requests to Remnawave Panel.
CADDY_AUTH_API_TOKEN=
```
</details>
## Step 3 - Start the container
```bash title="Starting the container"
@@ -148,17 +182,15 @@ cd /opt/remnawave/subscription && nano docker-compose.yml
:::warning
Please use the docker container name and port (`remnawave:3000`) instead of the panel URL (`panel.com`).
You also need to add the `REQUEST_REMNAWAVE_SCHEME` variable so that the subscription page can send requests to the panel API inside the docker network via the `http` protocol.
Please use the docker container name and port (`http://remnawave:3000`) instead of the panel URL (`https://panel.com`).
Review the configuration below, look for yellow highlighted line and make the necessary changes. Then copy the entire line highlighted in green and add it to the `docker-compose` file.
:::
```yaml title="docker-compose.yml"
environment:
- REMNAWAVE_PLAIN_DOMAIN=remnawave:3000
// highlight-next-line-green
- REQUEST_REMNAWAVE_SCHEME=http
// highlight-next-line-green
- REMNAWAVE_PANEL_URL=http://remnawave:3000
```
Now, you need to restart the Subscription Page container.
@@ -657,7 +689,7 @@ Modify your docker-compose.yml file to mount the app-config.json file to the sub
```yaml
volumes:
- ./app-config.json:/app/dist/assets/app-config.json
- ./app-config.json:/opt/app/frontend/assets/app-config.json
```
Restart the subscription-page container to apply the changes.
@@ -668,4 +700,4 @@ docker compose down && docker compose up -d && docker compose logs -f
### Full Example
See the [complete example](https://raw.githubusercontent.com/remnawave/subscription-page/refs/heads/main/public/assets/app-config.json) to understand how to configure multiple applications across different platforms.
See the [complete example](https://raw.githubusercontent.com/remnawave/subscription-page/refs/heads/main/frontend/public/assets/app-config.json) to understand how to configure multiple applications across different platforms.