Getting Started with the Atra VPN App

Application Dashboard Overview

After

successful login, the

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 theavailable tunnels

---

Top Bar Elements

1. App Version

 Display: Top-left corner
Format: "Atra VPN Client willv1.2.3"
Purpose: beShows displayed.current Theinstalled dashboardversion

provides key information and quick access

When to essential features:Check:

1. App Version : The top section shows the current version of the Atra VPN Client you are running.
2. Associated Organization : Displays the organization name linked to your Atra-RMS account.
3. Theme Toggler (Dark/Light Mode) : 

   • ATroubleshooting simple toggle allows you to switch between light theme and dark theme instantly.issues

   • Preferences are

     Verifying savedyou sohave thelatest appversion

     remembers
   your
   • last

     Reporting selectedbugs mode.to support

---

4. Profile2. AvatarAssociated :Organization

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

   What This Means:

   • LocatedYou atsee thetunnels top-rightcreated cornerin ofyour the dashboard.organization

   • Clicking the

     You avatarsee openstunnels ayour dropdownorganization with: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:

   • mail

     Light Mode: Better for bright environments

   • Dark Mode: Reduces eye strain in low-light conditions

   ---

   4. Profile Avatar

   

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

   Click to Open Menu:

   • Email Address (yourdisplay loginonly)

     email)

   • Organization Name (display only)

   • Logout option (click to securely sign out of the application)out)

---

VPN Tunnels Table

On theThe main page, users will see a table listingdisplays all VPN tunnels associatedyou withhave theiraccess organization. This table is the central place to view, and connect to VPN tunnels.to.

Key Actions and Management Tools:

Table

Search & Refresh

Search BarBar::

Allows
you

• Type keywords to quicklyfilter findtunnels

  a
tunnel
• by

  Searches: typing in keywords (e.g., tunnelTunnel name, organization, or created by).by

• Real-time filtering (results update as you type)

Refresh IconIcon::

Refreshes
the

• Click to manually update tunnel list

  to show the most current data.

• Useful after tunnels are created/deleted in web interface

Table Navigation: 

• Rows per pagepage: :10, Adjust25, the50, number100

• Total Count: "Showing 1-10 of child25 organizationstunnels"

  shown on the screen.
• Total Count : Displays the total number of child organizations.

• Page NavigationNavigation: :Previous, MoveNext, betweenpage pages.numbers

---

📋 Table Columns & Features

1. Device Model : The name or model of the connected device within the selected tunnel.
2. Local IP :
   • The local (LAN) IP address of the device.
   • This IP is used for communication within the local environment and helps identify the device inside your local subnet.
3. VPN IP :
   • Indicates whether network forwarding is enabled for the device.
   • This IP allows the device to communicate securely over the encrypted VPN tunnel.
4. Network Forwarding :
   • Indicates whether network forwarding is enabled for the device.
   • When enabled, the device can forward network traffic through the VPN tunnel, allowing communication between multiple devices or networks securely.
5. Connection Status : Shows if the device is currently connected to the VPN.
6. Routing IP :
   • Lists available routing IPs for data transfer through the VPN tunnel.
   • These routing IPs define which network ranges or subnets can be accessed through the VPN tunnel from this device.

---

🔗

Connecting to a Tunnel

[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 the Connect"Connect" button for a desired tunnel.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 theinternet tunneldrops, isVPN runningdisconnects and enabled, the app will initiate a secure connection.automatically

• After a

  Notification successfulappears: connection:"Connection lost"

• Attempt to reconnect when internet restores

2. Tunnel Stopped by Administrator:

• TheAdministrator Connectstops buttontunnel transforms into Disconnect.process

• Three status

  All cardsconnections appearterminate

  at
the
• top

  Notification: of"Tunnel thestopped pageby showing:administrator"

3. Tunnel Disabled by Administrator:

• TheAdministrator currently connecteddisables tunnel

• Connection details

• TheProcess sessionstops, durationall 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 Important:"Details" You can connectbutton to onlyview onedevices tunnelin atthe a time. If a tunnel is already connected, all other tunnels will remain disabled until you disconnect.tunnel.

---

🔗Opening DisconnectingDetails to a TunnelSidebar

1. Click the Disconnect button on the activeLocate tunnel row.in table

2. The VPN

   Click tunnel"Details" sessionbutton will(typically safelyicon close.button)

3. The status

   Sidebar cardsslides (connectedin tunnelfrom detailsright andside

   duration) will disappear.
4. Other tunnels will become available for connection again.

---

Sidebar Contents

DisconnectingHeader:

• Tunnel name

• Close button (X) to dismiss sidebar

Device List:

For each device, displays:

---

Understanding Routing IP

What is requiredRouting beforeIP?

switching

to
• another

  Lists tunnel.network ranges accessible through this device

• Only shown when Network Forwarding = Enabled

• CIDR notation (e.g., 192.168.1.0)

Example:

If theDevice internetVPN connectionIP: is10.8.0.10
Network lost,Forwarding: theEnabled
Routing appIP: may auto-disconnect for security. 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

---