{"id":23652768,"url":"https://github.com/g1ibby/auto-vpn","last_synced_at":"2025-04-08T23:45:24.139Z","repository":{"id":268296381,"uuid":"895665742","full_name":"g1ibby/auto-vpn","owner":"g1ibby","description":"A simple, all-in-one tool for deploying on-demand WireGuard VPN servers on popular VPS providers—no ongoing subscriptions, effortless management, and automatic cleanup when you’re done.","archived":false,"fork":false,"pushed_at":"2025-02-07T14:09:02.000Z","size":123760,"stargazers_count":83,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T14:39:13.995Z","etag":null,"topics":["encryption","freedom","privacy","self-hosted","streamlit","vpn","vpn-manager","vpn-server","wireguard"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/g1ibby.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-28T16:30:48.000Z","updated_at":"2025-02-07T14:09:05.000Z","dependencies_parsed_at":"2025-02-07T14:42:04.727Z","dependency_job_id":null,"html_url":"https://github.com/g1ibby/auto-vpn","commit_stats":null,"previous_names":["g1ibby/auto-vpn"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g1ibby%2Fauto-vpn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g1ibby%2Fauto-vpn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g1ibby%2Fauto-vpn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g1ibby%2Fauto-vpn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/g1ibby","download_url":"https://codeload.github.com/g1ibby/auto-vpn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247947820,"owners_count":21023058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["encryption","freedom","privacy","self-hosted","streamlit","vpn","vpn-manager","vpn-server","wireguard"],"created_at":"2024-12-28T17:01:25.080Z","updated_at":"2025-04-08T23:45:24.121Z","avatar_url":"https://github.com/g1ibby.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Auto-VPN: On-Demand WireGuard VPN Server Manager \n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\nDeploy your personal WireGuard VPN server with just a few clicks. No subscriptions, no complexity, full control.\n\n![Main interface](images/main.png)\n\nThis project provides an effortless way to spin up your own temporary, cost-effective WireGuard VPN servers on-demand—no long-term subscriptions or complex manual setups required. By leveraging popular VPS providers like Vultr or Linode, it automatically:\n\n## 🚀 Features\n\n- **On-Demand Deployment**: Launch VPN servers instantly on Vultr or Linode\n- **Cost-Effective**: Pay only for actual usage with automatic server cleanup\n- **User-Friendly Interface**: Simple GUI for server and profile management\n- **Enhanced Privacy**: Full control over your VPN infrastructure\n- **Automated Setup**: Pre-configured WireGuard installation\n- **Multi-Provider Support**: Works with major VPS providers (Vultr, Linode)\n\n## 🏃‍♂️ Quick Start\n\n### Local Deployment (Docker)\n\n1. Run the container:\n```bash\ndocker run --rm -d --pull always --name auto-vpn \\\n  -e USERNAME=admin \\\n  -e PASSWORD=qwerty \\\n  -e VULTR_API_KEY=\u003cyour-vultr-api-key\u003e \\\n  -v $(pwd)/data_layer:/app/data_layer \\\n  -p 8501:8501 \\\n  ghcr.io/g1ibby/auto-vpn\n```\n\n2. Access the interface at `http://localhost:8501`\n\n### Free Cloud Deployment (Render.com)\n\n1. **Create New Web Service**\n   - Sign in to [Render Dashboard](https://dashboard.render.com)\n   - Choose \"New Web Service\"\n   - Select Docker runtime\n   - Use image: `ghcr.io/g1ibby/auto-vpn`\n\n2. **Configure Environment Variables**\n   \n   Required:\n   - `USERNAME`: Admin username\n   - `PASSWORD`: Admin password\n   - `VULTR_API_KEY` or `LINODE_API_KEY`: VPS provider API key\n   - `SELF_URL`: Your Render service URL (e.g., https://your-service.onrender.com)\n\n  Database Configuration:\n   - `DATABASE_URL`: Database connection string (see details below)\n\n3. **Deploy and Access**\n   - Service will be available at your Render URL\n   - Auto-ping feature keeps the service active on free tier\n\n### ⚠️ Important Database Considerations\n\nThe application supports two database types:\n\n1. **SQLite** (default):\n`DATABASE_URL=sqlite:///data_layer/data_layer.db`\n\n⚠️ **WARNING**: Using SQLite on Render's free tier is NOT recommended as:\n- Database will be lost on service restarts\n- Data doesn't persist between deployments\n- Free tier instances can restart randomly\n\n2. **PostgreSQL** (recommended for Render):\n`DATABASE_URL=postgresql://user:password@host:5432/database`\n\n✅ **Recommended**: Use external PostgreSQL service:\n- [Supabase](https://supabase.com) offers free PostgreSQL databases\n- Data persists across deployments and restarts\n- More reliable for production use\n\n## 💻 Environment Variables\n\n| Variable | Required | Description |\n|----------|----------|-------------|\n| USERNAME | Yes | Admin login username |\n| PASSWORD | Yes | Admin login password |\n| VULTR_API_KEY | * | Vultr API key |\n| LINODE_API_KEY | * | Linode API key |\n| SELF_URL | No | Service URL for auto-ping |\n| DATABASE_URL | No | Database connection string |\n\n\\* Either VULTR_API_KEY or LINODE_API_KEY is required\n\n## 🏗️ Architecture\n\n![Flowchart](images/flowchart.png)\n\nThe project leverages several powerful technologies:\n\n- **Pulumi**: Infrastructure as Code for VPS management\n- **WireGuard**: Secure VPN protocol\n- **Streamlit**: Modern web interface\n- **Docker**: Containerization and easy deployment\n\n## 🔒 Security Considerations\n\n- All VPN traffic is encrypted using WireGuard\n- No logs are kept on VPN servers\n- Servers are automatically destroyed after inactivity\n- Full control over infrastructure eliminates third-party trust\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## 🗺️ Roadmap\n\n### New Cloud Providers\n- [ ] DigitalOcean\n- [ ] Hetzner\n- [ ] AWS\n\n### Enhanced User Experience\n- [ ] QR code generation for WireGuard peers\n  - Easy mobile device configuration\n  - One-click peer sharing\n\n## 🙏 Acknowledgments\n\n- Pulumi: Handles infrastructure provisioning, making it simple to deploy and tear down VPS instances on-demand.\n- [Nyr/wireguard-install](https://github.com/Nyr/wireguard-install): Automates the WireGuard installation process, ensuring a seamless setup experience.\n- [Streamlit](https://streamlit.io): GUI\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg1ibby%2Fauto-vpn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fg1ibby%2Fauto-vpn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg1ibby%2Fauto-vpn/lists"}