Skip to content

Latest commit

 

History

History

README.md

Psiphon Linux VPN Service - Documentation

Welcome! Pick what you need:

🚀 Quick Start

First time?Getting Started (5 minutes)

📖 Main Guides

🔗 Reference


Navigation by Task

I want to... Go to...
Get VPN working now Getting Started
Copy a ready-made config Configuration
Understand all settings Configuration
See all commands Commands Reference
Fix something broken Troubleshooting
Use SOCKS proxy Usage & Commands
Verify kill switch Security
Check DNS security Security
Monitor in real-time Usage & Commands
Optimize performance Configuration
Find quick answers FAQ

📚 Reading by Level

Beginner (Want it working)

  1. Getting Started
  2. Configuration - pick a profile
  3. FAQ - keep for reference

Intermediate (Want to understand)

  1. Getting Started
  2. Usage & Commands
  3. Configuration
  4. Troubleshooting

Advanced (Want everything)

  1. All guides above
  2. Network Setup
  3. Security
  4. Commands Reference

📋 Document Overview

Guide Size Reading Time Purpose
Getting Started 3 KB 5 min Install & test
Configuration 8 KB 15 min Settings & profiles
Usage & Commands 6 KB 15 min Operations
Troubleshooting 7 KB 20 min Fix problems
FAQ 4 KB 10 min Quick answers
Commands Reference 2 KB 5 min Command lookup
Network Setup 3 KB 10 min Network details
Security 3 KB 10 min Security features

🎯 Key Commands

# Quick lookup - see COMMANDS.md for complete list

# Basic
sudo systemctl start psiphon-tun
sudo systemctl status psiphon-tun
curl --interface PsiphonTUN https://ifconfig.me

# Diagnosis
sudo ./Psiphon-Linux-VPN-Service-Setup.sh diagnose

# Config
sudo nano /opt/psiphon-tun/psiphon/psiphon.config
sudo systemctl reload psiphon-tun

See Commands Reference for full list.


✨ Highlights

  • ✅ 5 pre-made configurations (copy-paste ready)
  • ✅ All commands in one reference page
  • ✅ Common issues with fixes
  • ✅ No repeated information
  • ✅ Clean, focused guides
  • ✅ Quick navigation

🆘 In a Hurry?

Everything broken? Run:

sudo ./Psiphon-Linux-VPN-Service-Setup.sh diagnose

→ Then check Troubleshooting

Can't connect? See Troubleshooting

Something confusing? Check FAQ


Start with: Getting Started or Commands Reference