# remnawave/subscription-page architecture

> Architecture diagram of the GitHub repository remnawave/subscription-page, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/remnawave/subscription-page
- Repository: https://github.com/remnawave/subscription-page

## Overview

Remnawave Subscription Page serves browser users a branded, configurable subscription page and serves subscription data to non-browser clients. The browser path resolves the short UUID, fetches subscription/configuration data from the Remnawave Panel, then renders subscription details, connection keys, platform installation guidance and subscription links. The frontend route and page composition are visible; configuration-store loading and the browser’s request transport were not sampled, so those links are not inferred.

Main entry points: [`frontend/src/pages/main/ui/components/main.page.component.tsx`](https://github.com/remnawave/subscription-page/blob/main/frontend/src/pages/main/ui/components/main.page.component.tsx) (Main page), [`backend/src/modules/subscription/subscription.controller.ts`](https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/subscription/subscription.controller.ts) (Subscription route), [`frontend/src/pages/main/ui/connectors/main.page.connector.tsx`](https://github.com/remnawave/subscription-page/blob/main/frontend/src/pages/main/ui/connectors/main.page.connector.tsx) (Main page connector), [`frontend/src/app/router/router.tsx`](https://github.com/remnawave/subscription-page/blob/main/frontend/src/app/router/router.tsx) (Router)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_backend["Backend services"]
  node_app["Nest application<br/>[app.module.ts]"]
  node_subscription_route["Subscription route"]
  node_subscription_service["Subscription delivery"]
  node_webpage_route["Config endpoint"]
  node_webpage_service["Webpage rendering<br/>[webpage.service.ts]"]
end

subgraph group_panel["Panel integration"]
  node_axios["Panel API client<br/>[axios.service.ts]"]
  node_panel_service["Remnawave Panel"]
end

subgraph group_frontend["Frontend application"]
  node_frontend_app["Frontend app<br/>[app.tsx]"]
  node_router["Router<br/>[router.tsx]"]
  node_root_layout["Root layout<br/>[root.layout.tsx]"]
  node_page_connector["Main page connector"]
  node_config_store["App configuration state"]
  node_subscription_store["Subscription state"]
end

subgraph group_content["Subscription page content"]
  node_page["Main page"]
  node_info_widgets["Subscription info"]
  node_install_guide["Installation guides"]
  node_guide_renderers["Guide block renderers"]
  node_raw_keys["Raw connection keys"]
  node_sub_link["Subscription link"]
end

node_client(("Subscription client"))
node_browser(("Browser user"))

node_client -->|"requests subscription"| node_subscription_route
node_browser -->|"requests page"| node_subscription_route
node_app -->|"registers module"| node_subscription_route
node_app -->|"registers module"| node_webpage_route
node_subscription_route -->|"routes browser"| node_webpage_service
node_subscription_route -->|"routes subscription"| node_subscription_service
node_webpage_route -->|"gets config"| node_webpage_service
node_subscription_service -->|"fetches subscription"| node_axios
node_webpage_service -->|"fetches page data"| node_axios
node_axios -->|"calls panel API"| node_panel_service
node_frontend_app -->|"renders router"| node_router
node_router -->|"wraps routes"| node_root_layout
node_router -->|"routes to page"| node_page_connector
node_page_connector -->|"renders when ready"| node_page
node_page_connector -->|"reads configuration"| node_config_store
node_page_connector -->|"reads subscription"| node_subscription_store
node_page -->|"renders selected info"| node_info_widgets
node_page -->|"renders guides"| node_install_guide
node_page -->|"selects block renderer"| node_guide_renderers
node_page -->|"renders keys"| node_raw_keys
node_page -->|"renders link"| node_sub_link

click node_app "https://github.com/remnawave/subscription-page/blob/main/backend/src/app.module.ts"
click node_subscription_route "https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/subscription/subscription.controller.ts"
click node_subscription_service "https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/subscription/subscription.service.ts"
click node_webpage_route "https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/webpage/webpage.controller.ts"
click node_webpage_service "https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/webpage/webpage.service.ts"
click node_axios "https://github.com/remnawave/subscription-page/blob/main/backend/src/common/axios/axios.service.ts"
click node_frontend_app "https://github.com/remnawave/subscription-page/blob/main/frontend/src/app.tsx"
click node_router "https://github.com/remnawave/subscription-page/blob/main/frontend/src/app/router/router.tsx"
click node_root_layout "https://github.com/remnawave/subscription-page/blob/main/frontend/src/app/layouts/root/root.layout.tsx"
click node_page_connector "https://github.com/remnawave/subscription-page/blob/main/frontend/src/pages/main/ui/connectors/main.page.connector.tsx"
click node_page "https://github.com/remnawave/subscription-page/blob/main/frontend/src/pages/main/ui/components/main.page.component.tsx"
click node_config_store "https://github.com/remnawave/subscription-page/tree/main/frontend/src/entities/app-config-store"
click node_subscription_store "https://github.com/remnawave/subscription-page/blob/main/frontend/src/entities/subscription-info-store/subscription-info-store.ts"
click node_info_widgets "https://github.com/remnawave/subscription-page/tree/main/frontend/src/widgets/main/subscription-info"
click node_install_guide "https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/installation-guide/installation-guide.connector.tsx"
click node_guide_renderers "https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/installation-guide/components/blocks/renderer-block.interface.tsx"
click node_raw_keys "https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/raw-keys/raw-keys.widget.tsx"
click node_sub_link "https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/subscription-link/subscription-link.widget.tsx"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_subscription_route,node_subscription_service,node_webpage_route,node_webpage_service,node_client,node_browser toneBlue
class node_axios,node_panel_service toneAmber
class node_frontend_app,node_router,node_root_layout,node_page_connector,node_config_store,node_subscription_store toneMint
class node_page,node_info_widgets,node_install_guide,node_guide_renderers,node_raw_keys,node_sub_link toneRose
```

## Components

### Backend services

- [Nest application](https://github.com/remnawave/subscription-page/blob/main/backend/src/app.module.ts): `backend/src/app.module.ts`
- [Subscription route](https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/subscription/subscription.controller.ts): `backend/src/modules/subscription/subscription.controller.ts`
- [Subscription delivery](https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/subscription/subscription.service.ts): `backend/src/modules/subscription/subscription.service.ts`
- [Config endpoint](https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/webpage/webpage.controller.ts): `backend/src/modules/webpage/webpage.controller.ts`
- [Webpage rendering](https://github.com/remnawave/subscription-page/blob/main/backend/src/modules/webpage/webpage.service.ts): `backend/src/modules/webpage/webpage.service.ts`

### Panel integration

- [Panel API client](https://github.com/remnawave/subscription-page/blob/main/backend/src/common/axios/axios.service.ts): `backend/src/common/axios/axios.service.ts`
- **Remnawave Panel**

### Frontend application

- [Frontend app](https://github.com/remnawave/subscription-page/blob/main/frontend/src/app.tsx): `frontend/src/app.tsx`
- [Router](https://github.com/remnawave/subscription-page/blob/main/frontend/src/app/router/router.tsx): `frontend/src/app/router/router.tsx`
- [Root layout](https://github.com/remnawave/subscription-page/blob/main/frontend/src/app/layouts/root/root.layout.tsx): `frontend/src/app/layouts/root/root.layout.tsx`
- [Main page connector](https://github.com/remnawave/subscription-page/blob/main/frontend/src/pages/main/ui/connectors/main.page.connector.tsx): `frontend/src/pages/main/ui/connectors/main.page.connector.tsx`
- [App configuration state](https://github.com/remnawave/subscription-page/tree/main/frontend/src/entities/app-config-store): `frontend/src/entities/app-config-store`
- [Subscription state](https://github.com/remnawave/subscription-page/blob/main/frontend/src/entities/subscription-info-store/subscription-info-store.ts): `frontend/src/entities/subscription-info-store/subscription-info-store.ts`

### Subscription page content

- [Main page](https://github.com/remnawave/subscription-page/blob/main/frontend/src/pages/main/ui/components/main.page.component.tsx): `frontend/src/pages/main/ui/components/main.page.component.tsx`
- [Subscription info](https://github.com/remnawave/subscription-page/tree/main/frontend/src/widgets/main/subscription-info): `frontend/src/widgets/main/subscription-info`
- [Installation guides](https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/installation-guide/installation-guide.connector.tsx): `frontend/src/widgets/main/installation-guide/installation-guide.connector.tsx`
- [Guide block renderers](https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/installation-guide/components/blocks/renderer-block.interface.tsx): `frontend/src/widgets/main/installation-guide/components/blocks/renderer-block.interface.tsx`
- [Raw connection keys](https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/raw-keys/raw-keys.widget.tsx): `frontend/src/widgets/main/raw-keys/raw-keys.widget.tsx`
- [Subscription link](https://github.com/remnawave/subscription-page/blob/main/frontend/src/widgets/main/subscription-link/subscription-link.widget.tsx): `frontend/src/widgets/main/subscription-link/subscription-link.widget.tsx`

### Other components

- **Subscription client**
- **Browser user**

## Connections

- Subscription client → Subscription route: requests subscription
- Browser user → Subscription route: requests page
- Nest application → Subscription route: registers module (evidence: `backend/src/app.module.ts`)
- Nest application → Config endpoint: registers module (evidence: `backend/src/app.module.ts`)
- Subscription route → Webpage rendering: routes browser (evidence: `backend/src/modules/subscription/subscription.controller.ts`)
- Subscription route → Subscription delivery: routes subscription (evidence: `backend/src/modules/subscription/subscription.controller.ts`)
- Config endpoint → Webpage rendering: gets config (evidence: `backend/src/modules/webpage/webpage.controller.ts`)
- Subscription delivery → Panel API client: fetches subscription (evidence: `backend/src/modules/subscription/subscription.service.ts`)
- Webpage rendering → Panel API client: fetches page data (evidence: `backend/src/modules/webpage/webpage.service.ts`)
- Panel API client → Remnawave Panel: calls panel API (evidence: `backend/src/common/axios/axios.service.ts`)
- Frontend app → Router: renders router (evidence: `frontend/src/app.tsx`)
- Router → Root layout: wraps routes (evidence: `frontend/src/app/router/router.tsx`)
- Router → Main page connector: routes to page (evidence: `frontend/src/app/router/router.tsx`)
- Main page connector → Main page: renders when ready (evidence: `frontend/src/pages/main/ui/connectors/main.page.connector.tsx`)
- Main page connector → App configuration state: reads configuration (evidence: `frontend/src/pages/main/ui/connectors/main.page.connector.tsx`)
- Main page connector → Subscription state: reads subscription (evidence: `frontend/src/pages/main/ui/connectors/main.page.connector.tsx`)
- Main page → Subscription info: renders selected info (evidence: `frontend/src/pages/main/ui/components/main.page.component.tsx`)
- Main page → Installation guides: renders guides (evidence: `frontend/src/pages/main/ui/components/main.page.component.tsx`)
- Main page → Guide block renderers: selects block renderer (evidence: `frontend/src/pages/main/ui/components/main.page.component.tsx`)
- Main page → Raw connection keys: renders keys (evidence: `frontend/src/pages/main/ui/components/main.page.component.tsx`)
- Main page → Subscription link: renders link (evidence: `frontend/src/pages/main/ui/components/main.page.component.tsx`)
