$ cat quick_start.md

QUICK_START

Get your Pi VPN Hotspot up and running in under 10 minutes. Follow these steps to deploy your secure VPN hotspot.

01 PREREQUISITES

Raspberry Pi 3B+ or newer (4GB RAM recommended)
MicroSD card (16GB minimum, 32GB recommended)
Raspberry Pi OS (Bullseye or newer)
WireGuard VPN account and configuration file
Android phone (optional, for SMS control)
Internet connection for initial setup

02 DOWNLOAD_PACKAGE

Download the latest Pi VPN Hotspot package to your Raspberry Pi.

$ wget https://github.com/your-repo/pi-vpn-hotspot/releases/latest/download/pi-vpn-hotspot.tar.gz
$ tar -xzf pi-vpn-hotspot.tar.gz
$ cd pi-vpn-hotspot

03 CONFIGURE_VPN

Copy your WireGuard configuration file to the config directory.

# Copy your WireGuard config
$ sudo cp /path/to/your/wg0.conf /etc/wireguard/

# Edit configuration file
$ nano config/settings.conf

# Configure these settings:

HOTSPOT_SSID="YourHotspotName"

HOTSPOT_PASSWORD="YourSecurePassword"

VPN_INTERFACE="wg0"

WIFI_INTERFACE="wlan0"

04 RUN_INSTALLER

Execute the installation script. This will install all dependencies and configure your system.

$ sudo ./install.sh

# The installer will:
# - Install required packages
# - Configure WireGuard VPN
# - Set up hostapd and dnsmasq
# - Configure kill switch
# - Enable services

⚠ NOTE

The installation process takes approximately 5-10 minutes. Your Pi will reboot automatically when complete.

05 VERIFY_INSTALLATION

After reboot, verify that all services are running correctly.

# Check VPN status
$ sudo wg show

# Check hotspot status
$ sudo systemctl status hostapd

# Check for IP leaks
$ curl ifconfig.me

06 CONNECT_DEVICES

Your VPN hotspot is now active. Connect your devices using the credentials you configured.

WEB_DASHBOARD

Access the monitoring dashboard at:

http://192.168.4.1:8080

SMS_CONTROL

Send commands via SMS:

STATUS, RESTART, STOP

NEXT_STEPS