# Getting Started with the Atra VPN App

#### Application Dashboard Overview

[![image.png](https://docs.atreyo.in/uploads/images/gallery/2026-04/scaled-1680-/SYpimage.png)](https://docs.atreyo.in/uploads/images/gallery/2026-04/SYpimage.png)

The main dashboard has three sections:

**Top Bar:**

1. **App Version:** Current version number (e.g., v1.2.3)
2. **Organization Name:** Your associated organization
3. **Theme Toggle:** Switch between light/dark mode
4. **Profile Avatar:** Access account menu

**Middle Section:**

1. **Search Bar:** Filter tunnels by name/organization
2. **Refresh Icon:** Manually update tunnel list
3. **Table Navigation:** Rows per page, page controls

**Main Area:**

1. **VPN Tunnels Table:** List of available tunnels

---

#### Top Bar Elements

[![image.png](https://docs.atreyo.in/uploads/images/gallery/2026-04/scaled-1680-/s3dimage.png)](https://docs.atreyo.in/uploads/images/gallery/2026-04/s3dimage.png)

##### **1. App Version**

 Display: Top-left corner  
Format: "Atra VPN Client v1.2.3"  
Purpose: Shows current installed version

When to Check:

- Troubleshooting issues
- Verifying you have latest version
- Reporting bugs to support

---

##### **2. Associated Organization**

 Display: Below app version  
Format: "Organization: \[Your Org Name\]"  
Purpose: Confirms which organization's tunnels you see

What This Means:

- You see tunnels created in your organization
- You see tunnels your organization has access to
- Cannot see tunnels from unrelated organizations

---

##### **3. Theme Toggle**

Location: Top-right area  
Options: Light Mode | Dark Mode

How to Use:

1. Click theme toggle switch
2. Interface immediately switches themes
3. Preference saved automatically
4. Applied on next launch

Benefits:

- Light Mode: Better for bright environments
- Dark Mode: Reduces eye strain in low-light conditions

---

##### **4. Profile Avatar**

[![image.png](https://docs.atreyo.in/uploads/images/gallery/2026-04/scaled-1680-/yJrimage.png)](https://docs.atreyo.in/uploads/images/gallery/2026-04/yJrimage.png)

Location: Top-right corner  
Icon: Circle with user initials or icon

**Click to Open Menu:**

- Email Address (display only)
- Organization Name (display only)
- Logout option (click to sign out)

---

### VPN Tunnels Table

The main table displays all VPN tunnels you have access to.

[![image.png](https://docs.atreyo.in/uploads/images/gallery/2026-04/scaled-1680-/21Limage.png)](https://docs.atreyo.in/uploads/images/gallery/2026-04/21Limage.png)

#### Table Search & Refresh

**Search Bar:**

- Type keywords to filter tunnels
- Searches: Tunnel name, organization, created by
- Real-time filtering (results update as you type)

**Refresh Icon:**

- Click to manually update tunnel list
- Useful after tunnels are created/deleted in web interface

**Table Navigation:**

- Rows per page: 10, 25, 50, 100
- Total Count: "Showing 1-10 of 25 tunnels"
- Page Navigation: Previous, Next, page numbers

---

#### Table Columns

<div align="left" dir="ltr" id="bkmrk-column-description-v"><table border="1" style="border-collapse: collapse; border-style: solid;"><colgroup><col width="150"></col><col width="220"></col><col width="188"></col></colgroup><thead><tr><td>Column

</td><td>Description

</td><td>Values

</td></tr></thead><tbody><tr><td>Connect Button

</td><td>Connect/disconnect from tunnel

</td><td>"Connect" or "Disconnect"

</td></tr><tr><td>Details

</td><td>Opens sidebar with device info

</td><td>Button with icon

</td></tr><tr><td>Process Status

</td><td>VPN server process state

</td><td>Running, Exited

</td></tr><tr><td>Tunnel Status

</td><td>Management state

</td><td>Enabled, Disabled

</td></tr><tr><td>Organization Name

</td><td>Tunnel's organization

</td><td>ATREYO DEMO

</td></tr><tr><td>Organization Level

</td><td>Hierarchy level

</td><td>Level: 1, 2, 3

</td></tr><tr><td>VPN IPv4

</td><td>Tunnel gateway IP

</td><td>10.8.0.1

</td></tr><tr><td>Created By

</td><td>Creator's email

</td><td>test@atreyo.in

</td></tr><tr><td>Created On

</td><td>Creation date

</td><td>2025-09-15

</td></tr><tr><td>Total Users

</td><td>Users in tunnel

</td><td>10

</td></tr><tr><td>Total Devices

</td><td>Devices in tunnel

</td><td>5

</td></tr><tr><td>Max Clients

</td><td>Maximum capacity

</td><td>253

</td></tr><tr><td>Allocated Clients

</td><td>Current users + devices

</td><td>15

</td></tr><tr><td>Remaining Clients

</td><td>Available slots

</td><td>238

</td></tr></tbody></table>

</div>---

### Connecting to a Tunnel

[![image.png](https://docs.atreyo.in/uploads/images/gallery/2026-04/scaled-1680-/ikpimage.png)](https://docs.atreyo.in/uploads/images/gallery/2026-04/ikpimage.png)

\[INSERT SCREENSHOT: Connect\_Process.png\]

#### Before Connecting

Prerequisites: ✅ Tunnel Process Status = "Running"  
✅ Tunnel Status = "Enabled"  
✅ You are added to tunnel (by administrator)  
✅ No other tunnel currently connected

⚠️ One Tunnel at a Time: You can only connect to ONE tunnel at a time.

---

#### Connection Steps

Step 1: Locate Tunnel

1. Find tunnel in table
2. Verify Process Status = "Running"
3. Verify Tunnel Status = "Enabled"

---

Step 2: Click Connect

1. Click "Connect" button for desired tunnel
2. Application initiates VPN connection
3. OpenVPN process starts in background
4. Connection established (typically 5-15 seconds)

Visual Feedback:

- Button shows "Connecting..." briefly
- Progress indicator may appear
- Button changes to "Disconnect" when connected

---

Step 3: Connected State

Once connected, three status cards appear at top of application:

Card 1: Connected Tunnel

- Shows tunnel name you're connected to
- Example: "Connected to: Factory\_Production\_VPN"

Card 2: Connection Details

- Your VPN IP address
- Example: "Your VPN IP: 10.8.0.25"
- Gateway IP
- Connection speed/status

Card 3: Session Duration

- Time connected
- Example: "Connected for: 00:45:23"
- Updates in real-time

---

#### While Connected

What You Can Do:

- ✅ Access devices in tunnel via their VPN IPs
- ✅ Access devices' local networks (if Network Forwarding enabled)
- ✅ View connection details in status cards
- ✅ Monitor session duration
- ✅ Click "Details" to view device information

What You Cannot Do:

- ❌ Connect to other tunnels (must disconnect first)
- ❌ Close application (minimizes to system tray, stays connected)

Other Tunnels:

- While connected, other "Connect" buttons are disabled (grayed out)

---

### Disconnecting from Tunnel

#### Manual Disconnect

Step 1: Click Disconnect

1. Locate "Disconnect" button on active tunnel row
2. Click "Disconnect" button
3. VPN session cleanly closes
4. OpenVPN process terminates

---

Step 2: Disconnected State

After disconnection:

- Status cards disappear from top
- Button changes back to "Connect"
- Other tunnels become available (buttons enabled)
- Can connect to different tunnel

Effects:

- Cannot access tunnel devices anymore
- Local network access lost
- VPN IP deallocated until next connection

---

#### Automatic Disconnect

Scenarios Where App Auto-Disconnects:

1\. Internet Connection Lost:

- VPN requires active internet
- If internet drops, VPN disconnects automatically
- Notification appears: "Connection lost"
- Attempt to reconnect when internet restores

2\. Tunnel Stopped by Administrator:

- Administrator stops tunnel process
- All connections terminate
- Notification: "Tunnel stopped by administrator"

3\. Tunnel Disabled by Administrator:

- Administrator disables tunnel
- Process stops, all connections drop
- Notification: "Tunnel disabled"

4\. User Removed from Tunnel:

- Administrator removes you from tunnel
- Connection immediately terminates
- Notification: "Access revoked"

---

### Device Details Sidebar

Click "Details" button to view devices in the tunnel.

[![image.png](https://docs.atreyo.in/uploads/images/gallery/2026-04/scaled-1680-/gtXimage.png)](https://docs.atreyo.in/uploads/images/gallery/2026-04/gtXimage.png)

#### Opening Details Sidebar

1. Locate tunnel in table
2. Click "Details" button (typically icon button)
3. Sidebar slides in from right side

---

#### Sidebar Contents

Header:

- Tunnel name
- Close button (X) to dismiss sidebar

Device List:

For each device, displays:

<div align="left" dir="ltr" id="bkmrk-field-description-ex"><table border="1" style="border-collapse: collapse; border-style: solid;"><colgroup><col width="160"></col><col width="176"></col><col width="179"></col></colgroup><thead><tr><td>Field

</td><td>Description

</td><td>Example

</td></tr></thead><tbody><tr><td>Device Model

</td><td>Hardware model name

</td><td>AG-702-LT-EU-V48

</td></tr><tr><td>Local IP

</td><td>Device's LAN/WAN IP

</td><td>192.168.1.50

</td></tr><tr><td>VPN IP

</td><td>Device's tunnel IP

</td><td>10.8.0.10

</td></tr><tr><td>Network Forwarding

</td><td>Forwarding state

</td><td>Enabled or Disabled

</td></tr><tr><td>Connection Status

</td><td>Device online/offline

</td><td>Connected, Disconnected

</td></tr><tr><td>Routing IP

</td><td>Available network routes

</td><td>192.168.1.0

</td></tr></tbody></table>

</div>---

#### Understanding Routing IP

**What is Routing IP?**

- Lists network ranges accessible through this device
- Only shown when Network Forwarding = Enabled
- CIDR notation (e.g., 192.168.1.0)

**Example:**

 Device VPN IP: 10.8.0.10  
Network Forwarding: Enabled  
Routing IP: 192.168.1.0

**What This Means:**

- You can access device at 10.8.0.10
- You can also access any device on 192.168.1.x network (192.168.1.1 through 192.168.1.254)
- Traffic routes through 10.8.0.10 to reach local network

**Use Case:**

Your Computer (VPN: 10.8.0.25)

 ↓

Connect to: 192.168.1.100 (PLC on device's LAN)

 ↓

Routes through: 10.8.0.10 (gateway device)

 ↓

Reaches: PLC at 192.168.1.100

---