{"id":13455728,"url":"https://github.com/wg-easy/wg-easy","last_synced_at":"2026-05-18T12:01:35.161Z","repository":{"id":37265062,"uuid":"369764441","full_name":"wg-easy/wg-easy","owner":"wg-easy","description":"The easiest way to run WireGuard VPN + Web-based Admin UI.","archived":false,"fork":false,"pushed_at":"2026-05-13T07:22:01.000Z","size":8348,"stargazers_count":25675,"open_issues_count":34,"forks_count":2437,"subscribers_count":136,"default_branch":"master","last_synced_at":"2026-05-13T09:09:43.226Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://wg-easy.github.io/wg-easy/latest/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wg-easy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["weejewel","kaaax0815"]}},"created_at":"2021-05-22T09:12:05.000Z","updated_at":"2026-05-13T08:40:16.000Z","dependencies_parsed_at":"2024-05-04T14:28:57.707Z","dependency_job_id":"9fd0ce07-24d4-438f-a3aa-b3b5568acc43","html_url":"https://github.com/wg-easy/wg-easy","commit_stats":null,"previous_names":["weejewel/wg-easy"],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/wg-easy/wg-easy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wg-easy%2Fwg-easy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wg-easy%2Fwg-easy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wg-easy%2Fwg-easy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wg-easy%2Fwg-easy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wg-easy","download_url":"https://codeload.github.com/wg-easy/wg-easy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wg-easy%2Fwg-easy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33177294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-18T09:27:30.708Z","status":"ssl_error","status_checked_at":"2026-05-18T09:27:28.300Z","response_time":71,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-07-31T08:01:10.079Z","updated_at":"2026-05-18T12:01:30.141Z","avatar_url":"https://github.com/wg-easy.png","language":"TypeScript","funding_links":["https://github.com/sponsors/weejewel","https://github.com/sponsors/kaaax0815","https://github.com/sponsors/WeeJeWel"],"categories":["TypeScript","JavaScript","HTML","Other","others","网络信息服务","Table of Contents","Security","Projects"],"sub_categories":["Webapps","网络代理","VPN","User Interface"],"readme":"# WireGuard Easy\n\n[![Build \u0026 Publish latest Image](https://github.com/wg-easy/wg-easy/actions/workflows/deploy.yml/badge.svg?branch=production)](https://github.com/wg-easy/wg-easy/actions/workflows/deploy.yml)\n[![Lint](https://github.com/wg-easy/wg-easy/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/wg-easy/wg-easy/actions/workflows/lint.yml)\n[![GitHub Stars](https://img.shields.io/github/stars/wg-easy/wg-easy)](https://github.com/wg-easy/wg-easy/stargazers)\n[![License](https://img.shields.io/github/license/wg-easy/wg-easy)](LICENSE)\n[![GitHub Release](https://img.shields.io/github/v/release/wg-easy/wg-easy)](https://github.com/wg-easy/wg-easy/releases/latest)\n[![Image Pulls](https://img.shields.io/badge/image_pulls-12M+-blue)](https://github.com/wg-easy/wg-easy/pkgs/container/wg-easy)\n\nYou have found the easiest way to install \u0026 manage WireGuard on any Linux host!\n\n\u003c!-- TOOD: update screenshot --\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/screenshot.png\" width=\"802\" alt=\"wg-easy Screenshot\" /\u003e\n\u003c/p\u003e\n\n## Features\n\n- All-in-one: WireGuard + Web UI.\n- Easy installation, simple to use.\n- List, create, edit, delete, enable \u0026 disable clients.\n- Show a client's QR code.\n- Download a client's configuration file.\n- Statistics for which clients are connected.\n- Tx/Rx charts for each connected client.\n- Gravatar support.\n- Automatic Light / Dark Mode\n- Multilanguage Support\n- One Time Links\n- Client Expiration\n- Prometheus metrics support\n- IPv6 support\n- CIDR support\n- 2FA support\n- Per-client firewall filtering (requires iptables)\n\n\u003e [!NOTE]\n\u003e To better manage documentation for this project, it has its own site here: [https://wg-easy.github.io/wg-easy/latest](https://wg-easy.github.io/wg-easy/latest)\n\n- [Getting Started](https://wg-easy.github.io/wg-easy/latest/getting-started/)\n- [Basic Installation](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/basic-installation/)\n- [Caddy](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/caddy/)\n- [Traefik](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/traefik/)\n- [Podman](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/podman-nft/)\n- [AdGuard Home](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/adguard/)\n\n\u003e [!NOTE]\n\u003e If you want to migrate from the old version to the new version, you can find the migration guide here: [Migration Guide](https://wg-easy.github.io/wg-easy/latest/advanced/migrate/)\n\n## Installation\n\nThis is a quick start guide to get you up and running with WireGuard Easy.\n\nFor a more detailed installation guide, please refer to the [Getting Started](https://wg-easy.github.io/wg-easy/latest/getting-started/) page.\n\n### 1. Install Docker\n\nIf you haven't installed Docker yet, install it by running as root:\n\n```shell\ncurl -sSL https://get.docker.com | sh\nexit\n```\n\nAnd log in again.\n\n### 2. Run WireGuard Easy\n\nThe easiest way to run WireGuard Easy is with Docker Compose.\n\nJust follow [these steps](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/basic-installation/) in the detailed documentation.\n\nYou can also install WireGuard Easy with the [docker run command](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/docker-run/) or via [podman](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/podman-nft/).\n\nNow [setup a reverse proxy](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/basic-installation/#setup-reverse-proxy) to be able to access the Web UI securely from the internet. This step is optional, just make sure to follow the guide [here](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/reverse-proxyless/) if you decide not to do it.\n\n## Donate\n\nAre you enjoying this project? Consider donating.\n\nFounder: [Buy Emile a beer!](https://github.com/sponsors/WeeJeWel) 🍻\n\nMaintainer: [Buy kaaax0815 a coffee!](https://github.com/sponsors/kaaax0815) ☕\n\n## Development\n\n### Prerequisites\n\n- Docker\n- Node LTS \u0026 corepack enabled\n- Visual Studio Code\n\n### Dev Server\n\nThis starts the development server with docker\n\n```shell\npnpm dev\n```\n\n### Update Auto Imports\n\nIf you add something that should be auto-importable and VSCode complains, run:\n\n```shell\ncd src\npnpm install\ncd ..\n```\n\n### Test Cli\n\nThis starts the cli with docker\n\n```shell\npnpm cli:dev\n```\n\n## License\n\nThis project is licensed under the AGPL-3.0-only License - see the [LICENSE](LICENSE) file for details\n\nThis project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security\n\n\"WireGuard\" and the \"WireGuard\" logo are registered trademarks of Jason A. Donenfeld\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwg-easy%2Fwg-easy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwg-easy%2Fwg-easy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwg-easy%2Fwg-easy/lists"}