# ykinotrue/noki-vpn-android architecture

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

- Interactive diagram: https://gitdiagram.com/ykinotrue/noki-vpn-android
- Repository: https://github.com/ykinotrue/noki-vpn-android

## Overview

Noki is an Android VPN client. Users enter through the app UI, authenticate or use account features, choose connection settings, and start an account or temporary VPN session; the VPN service manages the tunnel and runtime status. The tree also shows device, plans/payment, filtering, stats, and support features. Source excerpts are partial, and the README is empty, so relationships are limited to calls and references visible in the supplied excerpts or SOURCE INDEX.

Main entry points: [`app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt`](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt) (VPN service), [`app/src/main/java/com/noki/vpn/data/BackendApiClient.kt`](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/BackendApiClient.kt) (Backend API), [`app/src/main/java/com/noki/vpn/MainActivity.kt`](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/MainActivity.kt) (Main activity), [`app/src/main/java/com/noki/vpn/data/SettingsRepository.kt`](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/SettingsRepository.kt) (Settings repository)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App and navigation"]
  node_activity["Main activity<br/>[MainActivity.kt]"]
  node_screens["App screens<br/>[AppScreen.kt]"]
  node_tile["Quick settings tile"]
  node_firebase["Firebase messaging"]
end

subgraph group_account["Identity and account"]
  node_auth["Authentication flows"]
  node_account_features["Account security"]
end

subgraph group_product["VPN product features"]
  node_home["VPN home and controls<br/>[HomeScreen.kt]"]
  node_devices["Device management<br/>[DevicesScreen.kt]"]
  node_plans["Plans and checkout<br/>[PlansScreen.kt]"]
  node_filters["App and site filters<br/>[AppFilterScreen.kt]"]
  node_stats["Usage statistics<br/>[StatsScreen.kt]"]
end

subgraph group_data["Backend and storage"]
  node_backend["Backend API"]
  node_auth_api["Auth API"]
  node_json_api["JSON transport<br/>[BackendJsonApi.kt]"]
  node_settings[("Settings repository")]
  node_settings_codec["Stored settings codec"]
  node_endpoints["Endpoint ranking"]
  node_health["Endpoint health events"]
end

subgraph group_runtime["Tunnel runtime"]
  node_vpn_service["VPN service<br/>[AppVpnService.kt]"]
  node_orchestrator["Connection orchestrator"]
  node_xray["Xray controller<br/>[XrayController.kt]"]
  node_network["Underlying network source"]
  node_watchdog["Connection watchdog"]
  node_scheduler["Delayed task scheduler"]
end

node_user(("User"))

node_user -->|"opens app"| node_activity
node_activity -->|"renders"| node_screens
node_activity -->|"starts session"| node_vpn_service
node_tile -->|"starts or stops"| node_vpn_service
node_vpn_service -->|"starts Xray"| node_orchestrator
node_backend -->|"delegates auth"| node_auth_api
node_auth_api -->|"sends requests"| node_json_api
node_backend -->|"uses transport"| node_json_api
node_settings -->|"encodes settings"| node_settings_codec
node_health -->|"references ranking"| node_endpoints
node_vpn_service -->|"uses repository"| node_settings
node_vpn_service -->|"uses API"| node_backend
node_firebase -->|"loads and updates"| node_settings
node_firebase -->|"registers token"| node_backend
node_network -->|"references ranking"| node_endpoints
node_watchdog -->|"schedules probes"| node_scheduler
node_xray -.->|"uses scheduling"| node_scheduler

click node_activity "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/MainActivity.kt"
click node_screens "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/AppScreen.kt"
click node_auth "https://github.com/ykinotrue/noki-vpn-android/tree/main/app/src/main/java/com/noki/vpn"
click node_account_features "https://github.com/ykinotrue/noki-vpn-android/tree/main/app/src/main/java/com/noki/vpn"
click node_backend "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/BackendApiClient.kt"
click node_auth_api "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/BackendAuthClient.kt"
click node_json_api "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/BackendJsonApi.kt"
click node_settings "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/SettingsRepository.kt"
click node_settings_codec "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/settings/StoredSettingsCodec.kt"
click node_endpoints "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/EndpointRankingPolicy.kt"
click node_health "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/EndpointHealthEvents.kt"
click node_home "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/HomeScreen.kt"
click node_devices "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/DevicesScreen.kt"
click node_plans "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/PlansScreen.kt"
click node_filters "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/AppFilterScreen.kt"
click node_stats "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/StatsScreen.kt"
click node_tile "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/NokiQuickSettingsTileService.kt"
click node_vpn_service "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt"
click node_orchestrator "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/VpnConnectionOrchestrator.kt"
click node_xray "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/XrayController.kt"
click node_network "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/AndroidUnderlyingNetworkSource.kt"
click node_watchdog "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/VpnWatchdogController.kt"
click node_scheduler "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/DelayedTaskScheduler.kt"
click node_firebase "https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/NokiFirebaseMessagingService.kt"

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_activity,node_screens,node_tile,node_firebase,node_user toneBlue
class node_auth,node_account_features toneAmber
class node_home,node_devices,node_plans,node_filters,node_stats toneMint
class node_backend,node_auth_api,node_json_api,node_settings,node_settings_codec,node_endpoints,node_health toneRose
class node_vpn_service,node_orchestrator,node_xray,node_network,node_watchdog,node_scheduler toneIndigo
```

## Components

### App and navigation

- [Main activity](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/MainActivity.kt): `app/src/main/java/com/noki/vpn/MainActivity.kt`
- [App screens](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/AppScreen.kt): `app/src/main/java/com/noki/vpn/ui/AppScreen.kt`
- [Quick settings tile](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/NokiQuickSettingsTileService.kt): `app/src/main/java/com/noki/vpn/NokiQuickSettingsTileService.kt`
- [Firebase messaging](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/NokiFirebaseMessagingService.kt): `app/src/main/java/com/noki/vpn/NokiFirebaseMessagingService.kt`

### Identity and account

- [Authentication flows](https://github.com/ykinotrue/noki-vpn-android/tree/main/app/src/main/java/com/noki/vpn): `app/src/main/java/com/noki/vpn`
- [Account security](https://github.com/ykinotrue/noki-vpn-android/tree/main/app/src/main/java/com/noki/vpn): `app/src/main/java/com/noki/vpn`

### VPN product features

- [VPN home and controls](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/HomeScreen.kt): `app/src/main/java/com/noki/vpn/ui/HomeScreen.kt`
- [Device management](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/DevicesScreen.kt): `app/src/main/java/com/noki/vpn/ui/DevicesScreen.kt`
- [Plans and checkout](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/PlansScreen.kt): `app/src/main/java/com/noki/vpn/ui/PlansScreen.kt`
- [App and site filters](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/AppFilterScreen.kt): `app/src/main/java/com/noki/vpn/ui/AppFilterScreen.kt`
- [Usage statistics](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/ui/StatsScreen.kt): `app/src/main/java/com/noki/vpn/ui/StatsScreen.kt`

### Backend and storage

- [Backend API](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/BackendApiClient.kt): `app/src/main/java/com/noki/vpn/data/BackendApiClient.kt`
- [Auth API](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/BackendAuthClient.kt): `app/src/main/java/com/noki/vpn/data/BackendAuthClient.kt`
- [JSON transport](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/BackendJsonApi.kt): `app/src/main/java/com/noki/vpn/data/BackendJsonApi.kt`
- [Settings repository](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/SettingsRepository.kt): `app/src/main/java/com/noki/vpn/data/SettingsRepository.kt`
- [Stored settings codec](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/settings/StoredSettingsCodec.kt): `app/src/main/java/com/noki/vpn/data/settings/StoredSettingsCodec.kt`
- [Endpoint ranking](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/EndpointRankingPolicy.kt): `app/src/main/java/com/noki/vpn/data/EndpointRankingPolicy.kt`
- [Endpoint health events](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/data/EndpointHealthEvents.kt): `app/src/main/java/com/noki/vpn/data/EndpointHealthEvents.kt`

### Tunnel runtime

- [VPN service](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt): `app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt`
- [Connection orchestrator](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/VpnConnectionOrchestrator.kt): `app/src/main/java/com/noki/vpn/vpn/VpnConnectionOrchestrator.kt`
- [Xray controller](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/XrayController.kt): `app/src/main/java/com/noki/vpn/vpn/XrayController.kt`
- [Underlying network source](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/AndroidUnderlyingNetworkSource.kt): `app/src/main/java/com/noki/vpn/vpn/AndroidUnderlyingNetworkSource.kt`
- [Connection watchdog](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/VpnWatchdogController.kt): `app/src/main/java/com/noki/vpn/vpn/VpnWatchdogController.kt`
- [Delayed task scheduler](https://github.com/ykinotrue/noki-vpn-android/blob/main/app/src/main/java/com/noki/vpn/vpn/DelayedTaskScheduler.kt): `app/src/main/java/com/noki/vpn/vpn/DelayedTaskScheduler.kt`

### Other components

- **User**

## Connections

- User → Main activity: opens app (evidence: `app/src/main/java/com/noki/vpn/MainActivity.kt`)
- Main activity → App screens: renders (evidence: `app/src/main/java/com/noki/vpn/MainActivity.kt`)
- Main activity → VPN service: starts session (evidence: `app/src/main/java/com/noki/vpn/MainActivity.kt`)
- Quick settings tile → VPN service: starts or stops (evidence: `app/src/main/java/com/noki/vpn/NokiQuickSettingsTileService.kt`)
- VPN service → Connection orchestrator: starts Xray (evidence: `app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt`)
- Backend API → Auth API: delegates auth (evidence: `app/src/main/java/com/noki/vpn/data/BackendApiClient.kt`)
- Auth API → JSON transport: sends requests (evidence: `app/src/main/java/com/noki/vpn/data/BackendAuthClient.kt`)
- Backend API → JSON transport: uses transport (evidence: `app/src/main/java/com/noki/vpn/data/BackendJsonApi.kt`)
- Settings repository → Stored settings codec: encodes settings (evidence: `app/src/main/java/com/noki/vpn/data/SettingsRepository.kt`)
- Endpoint health events → Endpoint ranking: references ranking (evidence: `app/src/main/java/com/noki/vpn/data/EndpointHealthEvents.kt`)
- VPN service → Settings repository: uses repository (evidence: `app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt`)
- VPN service → Backend API: uses API (evidence: `app/src/main/java/com/noki/vpn/vpn/AppVpnService.kt`)
- Firebase messaging → Settings repository: loads and updates (evidence: `app/src/main/java/com/noki/vpn/NokiFirebaseMessagingService.kt`)
- Firebase messaging → Backend API: registers token (evidence: `app/src/main/java/com/noki/vpn/NokiFirebaseMessagingService.kt`)
- Underlying network source → Endpoint ranking: references ranking (evidence: `app/src/main/java/com/noki/vpn/vpn/AndroidUnderlyingNetworkSource.kt`)
- Connection watchdog → Delayed task scheduler: schedules probes (evidence: `app/src/main/java/com/noki/vpn/vpn/VpnWatchdogController.kt`)
- Xray controller → Delayed task scheduler: uses scheduling
