Example Guides

Problem-oriented examples for common Pi Gateway scenarios.

Quick Start

  1. Quick Install — Install Pi Gateway in one line
  2. Add VPN Clients — Configure VPN for macOS, Windows, Linux, iOS, Android
  3. Configure SSH Access — Set up SSH keys and remote access
  4. Set Up Dynamic DNS — Keep your hostname in sync (DuckDNS, No-IP)
  5. Troubleshooting Guide — Solve common issues

Use Case Scenarios

Scenario: “I want secure SSH access to my Pi from anywhere” → Follow: Quick Start + Configure SSH Access

Scenario: “I want to access my entire home network remotely via VPN” → Follow: Quick Start + Add VPN Clients

Scenario: “I want both SSH and VPN with a custom domain” → Follow: All guides in order

Common Commands

# Add a new VPN client (e.g., for your laptop)
./scripts/vpn-client-manager.sh
# Then select: 1) Add new client

# Check system status
make status

# View logs
sudo journalctl -u ssh -f        # SSH logs
sudo journalctl -u wg-quick -f   # VPN logs
sudo ufw status                   # Firewall rules

# Test SSH connection
ssh -i ~/.ssh/pi-gateway-key user@your-domain.duckdns.org

# Export VPN client config for new device
cat ~/.wireguard/clients/my-client.conf

Next Steps

After completing these examples:

  1. Review Daily Operations Guide
  2. Check Troubleshooting Guide if issues arise
  3. Read Architecture Overview to understand how it works

Table of contents


Back to top

Copyright © 2026 Pi Gateway. Licensed under MIT.

This site uses Just the Docs, a documentation theme for Jekyll.