docs: add configuration option for displaying raw keys in subscription page

This commit is contained in:
kastov
2025-12-10 00:42:20 +03:00
parent d90ebbff74
commit b229602ef3
4 changed files with 55 additions and 4 deletions

View File

@@ -79,6 +79,11 @@ REMNAWAVE_PANEL_URL=https://panel.example.com
META_TITLE="Subscription page"
META_DESCRIPTION="Subscription page description"
# If you want to display raw keys in the subscription page, set this to true.
# Please note, this setting will not have any effect if you have HWID enabled.
SUBSCRIPTION_UI_DISPLAY_RAW_KEYS=false
# Serve at custom root path, for example, this value can be: CUSTOM_SUB_PREFIX=sub
# Do not place / at the start/end

View File

@@ -0,0 +1,48 @@
---
sidebar_position: 4
title: Display Raw Keys
---
![Display raw keys](/install/subscription-page-display-raw-keys.webp)
:::warning
This setting will not have any effect if you have HWID enabled.
:::
If you want to display raw keys in the subscription page, you can set the `SUBSCRIPTION_UI_DISPLAY_RAW_KEYS` variable to `true` in the `.env` file.
```bash title=".env file"
cd /opt/remnawave/subscription && nano .env
```
```bash title=".env file content"
SUBSCRIPTION_UI_DISPLAY_RAW_KEYS=true
```
Restart the subscription page container to apply the changes.
```bash
cd /opt/remnawave/subscription && docker compose down && docker compose up -d && docker compose logs -f
```
### Disable Display Raw Keys {#disable-display-raw-keys}
If you want to disable displaying raw keys in the subscription page, you can set the `SUBSCRIPTION_UI_DISPLAY_RAW_KEYS` variable to `false` in the `.env` file.
```bash title=".env file"
cd /opt/remnawave/subscription && nano .env
```
```bash
SUBSCRIPTION_UI_DISPLAY_RAW_KEYS=false
```
### Restart the subscription page container {#restart-subscription-page-container}
Restart the subscription page container to apply the changes.
```bash
cd /opt/remnawave/subscription && docker compose down && docker compose up -d && docker compose logs -f
```

View File

@@ -27,9 +27,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
After you install subscription page, you can customize it by following the guide below.
```mdx-code-block
import DocCard from '@theme/DocCard';
<DocCard
item={{ type: 'link', label: 'Customization', description: 'Customization guide', href: '/docs/install/subscription-page/customization' }}
/>
<DocCardList items={[...[...useCurrentSidebarCategory().items].map((_,i)=>i>=useCurrentSidebarCategory().items.length-2?_:null).filter(Boolean)]} />
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB