{"id":48774003,"url":"https://github.com/cyr-ius/wireguard-ui","last_synced_at":"2026-04-13T12:01:12.588Z","repository":{"id":46308427,"uuid":"423216041","full_name":"cyr-ius/wireguard-ui","owner":"cyr-ius","description":"A web user interface to manage your WireGuard setup.","archived":false,"fork":false,"pushed_at":"2026-04-11T14:51:07.000Z","size":1035,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-11T16:28:14.408Z","etag":null,"topics":["docker","flask","python"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/cyr-ius.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":"2021-10-31T17:32:38.000Z","updated_at":"2026-04-06T17:28:28.000Z","dependencies_parsed_at":"2022-08-28T02:01:57.853Z","dependency_job_id":"b15c7b16-ec2a-4551-bf3a-bb31174dd8e5","html_url":"https://github.com/cyr-ius/wireguard-ui","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/cyr-ius/wireguard-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyr-ius%2Fwireguard-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyr-ius%2Fwireguard-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyr-ius%2Fwireguard-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyr-ius%2Fwireguard-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyr-ius","download_url":"https://codeload.github.com/cyr-ius/wireguard-ui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyr-ius%2Fwireguard-ui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31751705,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["docker","flask","python"],"created_at":"2026-04-13T12:00:56.273Z","updated_at":"2026-04-13T12:01:12.581Z","avatar_url":"https://github.com/cyr-ius.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WireGuard UI\n\nInterface web moderne pour administrer un serveur WireGuard sans manipuler directement les fichiers de configuration.\n\n## ✨ Fonctionnalités\n\n- Gestion des pairs (création, édition, révocation).\n- Génération de configuration client.\n- Export via QR code et fichier.\n- Authentification administrateur.\n- Healthcheck API intégré (`/api/health`).\n- Déploiement simple avec Docker / Docker Compose.\n\n## 🧱 Stack technique\n\n- **Backend** : FastAPI (Python)\n- **Frontend** : Angular\n- **Base de données** : SQLite (par défaut, persistée dans `/data`)\n- **Conteneurisation** : Docker multi-stage (Node + Python + WireGuard tools)\n\n## 🚀 Démarrage rapide (Docker Compose)\n\n### 1) Cloner le dépôt\n\n```bash\ngit clone https://github.com/cyr-ius/wireguard-ui.git\ncd wireguard-ui\n```\n\n### 2) (Optionnel) Créer un fichier `.env`\n\nLe `docker-compose.yaml` fournit déjà des valeurs par défaut, mais il est recommandé de les surcharger en production :\n\n```env\nADMIN_USERNAME=admin\nADMIN_PASSWORD=change-me-now\nSECRET_KEY=replace-with-a-long-random-secret\nLOG_LEVEL=INFO\n```\n\n### 3) Lancer l’application\n\n```bash\ndocker compose up -d --build\n```\n\n### 4) Accéder à l’interface\n\n- UI / API : `http://localhost:8000`\n- Port WireGuard : `51820/udp`\n\n## 🔐 Variables d’environnement importantes\n\n### Sécurité / Auth\n\n- `ADMIN_USERNAME` : identifiant admin initial.\n- `ADMIN_PASSWORD` : mot de passe admin initial.\n- `ADMIN_EMAIL` : email admin initial.\n- `SECRET_KEY` : clé de signature JWT (**obligatoire en production**).\n- `ACCESS_TOKEN_EXPIRE_MINUTES` : durée de vie des tokens.\n- `BCRYPT_ROUNDS` : coût de hash des mots de passe.\n\n### API / Application\n\n- `LOG_LEVEL` : niveau de logs (`INFO`, `DEBUG`, etc.).\n- `APP_VERSION` : version exposée par l’application.\n- `ALLOWED_ORIGINS` : origines CORS autorisées (séparées par des virgules).\n- `FRONTEND_DIST` : chemin du build frontend servi en statique.\n\n### Base de données\n\n- `DB_PATH` : URL de connexion SQLAlchemy.\n  - Par défaut : `sqlite+aiosqlite:////data/wireguard_ui.db`\n\n### WireGuard\n\n- `WIREGUARD_AUTOSTART` : active le démarrage automatique WireGuard au lancement.\n\n### Email (envoi de configuration / notifications)\n\n- `MAIL_FROM` : adresse expéditrice.\n- `MAIL_NAME` : nom expéditeur.\n\n\u003e D’autres réglages SMTP sont configurables depuis l’interface d’administration.\n\n## 🩺 Santé de service\n\nLe conteneur expose un healthcheck sur :\n\n```text\nGET /api/health\n```\n\nExemple :\n\n```bash\ncurl -f http://localhost:8000/api/health\n```\n\n## 📦 Persistance des données\n\nLe volume `wireguard-ui_data` est monté sur `/data` dans le conteneur.\n\n- Base SQLite\n- État applicatif persistant\n\n## 🛡️ Recommandations production\n\n- Remplacer `SECRET_KEY` par une valeur longue et aléatoire.\n- Changer immédiatement les identifiants admin par défaut.\n- Restreindre `ALLOWED_ORIGINS` à vos domaines.\n- Utiliser un reverse proxy TLS (Traefik, Nginx, Caddy).\n- Sauvegarder régulièrement le volume `/data`.\n\n## 🧪 Développement local (sans Docker)\n\nLe projet est découpé en deux applications :\n\n- `backend/` (API FastAPI)\n- `frontend/` (Angular)\n\n### Prérequis\n\n- Python **3.14+**\n- [uv](https://docs.astral.sh/uv/) (gestion des dépendances Python)\n- Node.js **22+** et npm\n\n### 1) Installer les dépendances backend\n\nDepuis la racine du dépôt :\n\n```bash\ncd backend\nuv sync --extra dev\n```\n\n### 2) Lancer le backend\n\n```bash\nuv run uvicorn src.main:app --reload --host 0.0.0.0 --port 8000\n```\n\n### 3) Installer les dépendances frontend\n\nDans un autre terminal :\n\n```bash\ncd frontend\nnpm ci\n```\n\n### 4) Lancer le frontend\n\n```bash\nnpm start\n```\n\nPar défaut, le frontend est accessible sur `http://localhost:4200`.\n\n## 🤝 Contribuer\n\nLes contributions sont bienvenues : bugfix, amélioration UX, sécurité, documentation.\n\n### Workflow recommandé\n\n1. Forker le dépôt et créer une branche :\n   ```bash\n   git checkout -b feat/ma-feature\n   ```\n2. Développer avec des commits atomiques et des messages explicites.\n3. Vérifier localement avant PR :\n\n   ```bash\n   # Backend\n   cd backend\n   uv run ruff check src\n   uv run mypy src\n\n   # Frontend\n   cd ../frontend\n   npm run build\n   ```\n\n4. Ouvrir une Pull Request avec :\n   - le contexte / problème,\n   - la solution proposée,\n   - les tests effectués,\n   - les éventuels impacts (migration, compatibilité, sécurité).\n\n### Bonnes pratiques\n\n- Éviter les changements hors-sujet dans une même PR.\n- Préférer les PR petites et faciles à relire.\n- Mettre à jour la documentation si comportement fonctionnel modifié.\n\n## 🤖 Instructions pour agents IA\n\nUn fichier `AGENTS.md` est fourni à la racine pour aider les agents (Codex, assistants IA, etc.) à installer les dépendances et lancer les vérifications nécessaires à l’analyse du projet.\n\n## 📄 Licence\n\nMIT — voir [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyr-ius%2Fwireguard-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyr-ius%2Fwireguard-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyr-ius%2Fwireguard-ui/lists"}