{"id":50897451,"url":"https://github.com/akasha-code/wg-manager","last_synced_at":"2026-06-16T01:04:45.870Z","repository":{"id":318463596,"uuid":"1071384116","full_name":"akasha-code/wg-manager","owner":"akasha-code","description":"TUI Manager for WireGuard.","archived":false,"fork":false,"pushed_at":"2025-10-07T11:21:39.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-07T11:40:08.085Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akasha-code.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-07T09:22:34.000Z","updated_at":"2025-10-07T11:21:42.000Z","dependencies_parsed_at":"2025-10-07T11:40:23.164Z","dependency_job_id":"63831da9-0a07-4307-9235-cfae97f6d130","html_url":"https://github.com/akasha-code/wg-manager","commit_stats":null,"previous_names":["akasha-code/wg-manager"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/akasha-code/wg-manager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akasha-code%2Fwg-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akasha-code%2Fwg-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akasha-code%2Fwg-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akasha-code%2Fwg-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akasha-code","download_url":"https://codeload.github.com/akasha-code/wg-manager/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akasha-code%2Fwg-manager/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34386324,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2026-06-16T01:04:45.244Z","updated_at":"2026-06-16T01:04:45.861Z","avatar_url":"https://github.com/akasha-code.png","language":"Shell","funding_links":["https://buymeacoffee.com/matekraft"],"categories":[],"sub_categories":[],"readme":"# WireGuard Manager (TUI)\r\n\r\n**🇺🇸 English | [🇪🇸 Español](README.es.md)**\r\n\r\nWireGuard Admin is an interactive TUI helper designed to simplify the day-to-day\r\nmanagement of a self-hosted WireGuard VPN server. It wraps the `wg` tooling with\r\nan `fzf`-powered menu so you can configure the server, add peers and inspect\r\nstatus without memorising long commands. The project ships with bilingual (EN/ES)\r\nprompts, guided first-run wizards and sane defaults so that you can go from zero\r\nto a usable VPN in minutes.\r\n\r\n## Features\r\n\r\n- 🚀 **First-run onboarding** – choose between quick defaults, a simple prompt\r\n  flow, or an in-depth guided wizard that explains every setting.\r\n- 📂 **Config management** – automatically populates a `.env` file and stores\r\n  client files under `~/wireguard-files` (customisable).\r\n- 👥 **Peer provisioning** – create client profiles with QR codes and selectable\r\n  routing modes using `create-client.sh` or from the main menu.\r\n- 🔁 **Service helpers** – restart WireGuard, validate configuration and review\r\n  logs from inside the menu.\r\n- 🌐 **Multi-language support** – English and Spanish localisation with automatic\r\n  application restart when changing languages for seamless experience.\r\n- 🚪 **User-friendly interface** – intuitive menu system with clear exit options\r\n  and streamlined installation process.\r\n\r\n## Requirements\r\n\r\n- A GNU/Linux host with WireGuard already installed and minimally configured.\r\n- `bash`, `wg`, `qrencode`, `fzf` and `wireguard-tools` available in `$PATH`.\r\n- `sudo` rights for actions that touch `/etc/wireguard` or restart services.\r\n\r\n## Installation\r\n\r\n### 1. Clone the repository\r\n\r\n```bash\r\ngit clone https://github.com/akasha-code/wg-manager.git\r\ncd wg-manager\r\n```\r\n\r\n### 2. Run the installer\r\n\r\nThe installer automatically detects your distribution, installs required packages,\r\nand prepares a `.env` file with a clean, professional installation experience.\r\n\r\n```bash\r\n./install.sh\r\n```\r\n\r\n\u003e **💡 Tip**: If you get a \"Permission denied\" error, make the script executable first:\r\n\u003e ```bash\r\n\u003e chmod +x install.sh\r\n\u003e ./install.sh\r\n\u003e ```\r\n\u003e Alternatively, you can run it directly with: `bash install.sh`\r\n\r\nDuring installation you will:\r\n- Select your preferred language (English/Spanish)\r\n- Choose a first-run setup mode (defaults, simple prompts, or verbose wizard)\r\n- Have the `wg-manager` command automatically registered in your system\r\n\r\nThe installer provides intelligent fallbacks, attempting system-wide installation\r\nfirst, then falling back to local user installation if needed.\r\n\r\n\u003e **Note**: The script tries to detect your distribution and install packages via\r\n\u003e `apt`, `pacman`, `dnf` or `zypper`. If your distro is not supported you will\r\n\u003e need to install `fzf`, `qrencode` and `wireguard-tools` manually before running\r\n\u003e the script again.\r\n\r\n### Manual installation (optional)\r\n\r\nIf you prefer a manual setup:\r\n\r\n1. Copy `.env.example` to `.env` and edit the values to match your server.\r\n2. Ensure the required commands (`wg`, `qrencode`, `fzf`) are available.\r\n3. Export `WG_HOME` to the project directory and run `./wg-manager`.\r\n4. Optionally symlink the script somewhere in your `$PATH` as `wg-manager`.\r\n\r\n## Usage\r\n\r\nLaunch the interface with:\r\n\r\n```bash\r\nwg-manager\r\n```\r\n\r\nKey operations available from the menu include:\r\n\r\n- **Create peers**: generates keys, configuration files and QR codes. You can\r\n  choose between full-tunnel, split-tunnel or custom routing.\r\n- **Edit settings**: open `.env` in your `$EDITOR` to tweak defaults such as DNS\r\n  servers, keepalive or the base network.\r\n- **Change language**: switch between English and Spanish with automatic \r\n  application restart to apply the new language immediately.\r\n- **Service controls**: restart `wg-quick@\u003cinterface\u003e` or validate the current\r\n  WireGuard configuration.\r\n- **Exit application**: clean exit option available directly from the main menu\r\n  (in addition to ESC key support).\r\n- **Wizard rerun**: start the detailed setup wizard at any time with\r\n  `wg-manager --wizard`.\r\n\r\nGenerated client artefacts are stored under `~/wireguard-files/\u003cpeer-name\u003e/` by\r\ndefault. Each directory contains the client configuration (`.conf`) and a QR\r\ncode (`.png`) that can be scanned from mobile devices.\r\n\r\n## Recent Improvements\r\n\r\n- **Enhanced user experience**: Streamlined installation with reduced debug output\r\n  for a cleaner, more professional setup process.\r\n- **Complete internationalization**: All user-facing messages now support both\r\n  English and Spanish languages.\r\n- **Smart language switching**: Automatic application restart when changing \r\n  languages with user confirmation to ensure seamless language transitions.\r\n- **Improved navigation**: Added clear exit option to main menu for better\r\n  user experience and discoverability.\r\n- **Automated versioning**: GitHub Actions automatically manage version numbers\r\n  based on commit messages, eliminating manual version management.\r\n\r\n## Credits and Support\r\n\r\nWireGuard Admin is maintained by Guido Nicolás Quadrini. You can find a\r\ncomplete acknowledgment of all the people and projects that collaborated in\r\n[CREDITS.md](CREDITS.md).\r\n\r\nIs this tool useful to you? Consider buying me a coffee on\r\n[Buy Me a Coffee](https://buymeacoffee.com/matekraft) to support its\r\ncontinued development.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakasha-code%2Fwg-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakasha-code%2Fwg-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakasha-code%2Fwg-manager/lists"}