## INTRODUCTION

YOP VPN (YourOwnPrivate VPN) is a Drupal module that enables privacy-conscious users to set up and manage their own VPN server using WireGuard directly from their Drupal site. Ideal for users new to VPNs or Drupal, this module provides a simple, automated solution to launch a fast, secure, and cost-effective VPN server—without relying on third-party providers.

Whether you're bypassing geo-restrictions, securing your connection on public Wi-Fi, or building a private developer environment, YOP VPN puts you in control of your traffic and privacy.

## FEATURES

Basic Functionality:
- One-click VPN deployment to a new VPS using WireGuard
- Generates secure client configuration files (including QR code for mobile)
- SSH key authentication for secure provisioning
- Downloadable config files for easy import into WireGuard clients
- Integration with VPS providers (Hetzner, DigitalOcean, etc.)

Unique Features:
- Fully self-hosted solution—no third-party VPN service needed
- CLI and Drupal UI support for non-technical and power users
- Auto-generation of secure peer/client configuration with QR for mobile
- Lightweight and fast (uses WireGuard’s modern cryptography)

Use Cases:
- Watch region-locked content while traveling
- Avoid paying for expensive commercial VPNs
- Connect securely to your home or dev servers
- Provide secure VPN access for teams, families, or clients

## REQUIREMENTS

None

## INSTALLATION

Install as you would normally install a contributed Drupal module.
See: https://www.drupal.org/node/895232 for further information.

## CONFIGURATION
1. Navigate to /admin/content, click on Add content -> VPN.
2. Copy & paste the already created SSH public key to your VPS provider account (this is used to access your VPS).
3. Create your VPS server with your provider.
4. Enter your VPS IP address and start the deployment script.
5. Once provisioning is complete, import the configuration file into your WireGuard client app and/or scan the generated QR code from your mobile device’s WireGuard app.

## MAINTAINERS

Current maintainers:
- Andrei Condurachi (andreic) - https://www.drupal.org/u/andreic

