Repository navigation
Home
Welcome to the documentation hub for MASQUE VPN — an experimental,
self-hosted VPN based on QUIC, HTTP/3 CONNECT-IP, and mutual TLS (mTLS).
MASQUE VPN is for people who want to operate their own VPN infrastructure on a VPS and connect with native clients. The project includes clients for Android, Android TV, Windows, and iOS testing through TestFlight.
Warning
MASQUE VPN is experimental software. Review the documentation, test in your own environment, and do not rely on it as the only solution for critical connectivity or security requirements.
The current GitHub release is v1.7.1.
It includes:
-
masque-1.7.1.msi— Windows client -
masque-phone-1.7.1.apk— Android phone client -
masque-tv-1.7.1.apk— Android TV client
v1.7.1 updates the Android and Windows clients. It does not replace the Linux
server binary: existing 1.5.x server deployments using connect-ip-go v0.3.0
remain the server-side baseline for this release.
The iOS TestFlight build remains on v1.7.0. No IPA is included in v1.7.1.
-
Repository README
Project overview, current status, prerequisites, and quick-start information. -
Releases
Published builds, checksums where provided, release notes, and changelogs. -
Issues
Bug reports, feature requests, and planned work. -
Discussions
Questions, deployment notes, feedback, and community discussion.
Implementation-specific, release-sensitive documentation is maintained in the main repository and should be treated as the source of truth for deployment, configuration, compatibility, and upgrades.
-
Client applications
Platform support, client status, and platform-specific notes. -
Censorship resistance
Reachability considerations, known limitations, and deployment context. -
Roadmap
Planned work, priorities, and platform direction. -
Benchmarks
Performance-test material and supporting data, where available. -
Security policy
Security-reporting process and project security guidance. -
Contributing
Guidelines for issues, changes, and contributions.
This Wiki contains durable conceptual and operational guidance. Use it for topics that should remain useful across releases:
-
Getting Started
What to prepare before deployment and where to find current setup instructions. -
Architecture
How MASQUE VPN combines QUIC, HTTP/3CONNECT-IP, and mTLS. -
Troubleshooting
A first-pass checklist for reachability, UDP, certificates, clients, MTU, and logs. -
MTU Testing
How to test and tune MTU-related connectivity behaviour. -
Security Model
Trust boundaries, credential handling, VPS-owner responsibilities, and limitations. -
FAQ
Short answers to common deployment and project-scope questions.
- Install or test the latest release.
- Review Troubleshooting and the platform-specific client documentation.
- Confirm that UDP reachability, server certificates, client credentials, and VPS firewall rules are configured correctly.
- Include the client platform and version, server version, relevant logs, error text, and steps to reproduce the problem.
- Never include private keys, client certificates, tokens, or other secrets in an issue.
MASQUE VPN is under active development. Supported platforms, client behaviour, configuration formats, and deployment procedures can change between releases.
For exact setup instructions, supported-client details, compatibility notes, and release-specific configuration, always use the versioned documentation in the main repository.