VU VPN Helper / VU VPN Vedlys

A web application designed to help Vilnius University (VU) students and staff connect to remote desktop computers through VU VPN. The app provides step-by-step instructions and real-time VPN connection status monitoring.

🌟 Features

• Real-time VPN Status Check: Automatically detects if you're connected to VU VPN
• Network Detection: Identifies if you're on the Kaunas Faculty (KNF) network
• OS-Specific Instructions: Automatically detects your operating system (macOS/Windows) and provides tailored instructions
• Bilingual UI: Lithuanian (default) and English, switchable in the top bar and remembered in a cookie
• Embeddable: opening /iframe renders the guide without the top bar and footer, ready to sit in an <iframe> on the faculty's main page
• Step-by-Step Guide: Interactive stepper interface guides users through:
  1. VU VPN connection verification
  2. Obtaining remote computer IP address
  3. Installing remote desktop software
  4. Connecting to remote desktop

🚀 Tech Stack

• Frontend Framework: React 19
• Build Tool: Vite 7
• Styling: Tailwind CSS 4
• UI Components: Material-UI (MUI) 7
• HTTP Client: Axios
• Deployment: Docker + Caddy

📋 Prerequisites

• Ubuntu operating system
• Docker and Docker Compose

🚀 Quick Start

1. Clone the repository

   git clone https://github.com/kaunofakultetas/vpn-helper.git
   cd vpn-helper

2. Copy docker-compose sample file

   cp docker-compose.sample.yml docker-compose.yml

3. OPTIONAL: Modify docker-compose.yml file if needed

   nano docker-compose.yml

4. Start the docker-compose stack

   ./runUpdateThisStack.sh

   The app will be available at port 80.