{"id":32807424,"url":"https://github.com/aitmiloud/ngxtui","last_synced_at":"2026-04-18T05:34:09.033Z","repository":{"id":322649368,"uuid":"1089504340","full_name":"aitmiloud/ngxtui","owner":"aitmiloud","description":"[experimental] - TUI app that lets you manage Nginx like a2ensite/a2dissite, but prettier.","archived":false,"fork":false,"pushed_at":"2025-11-05T15:14:21.000Z","size":256,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-05T17:23:59.941Z","etag":null,"topics":["bubbletea","golang","nginx","tui"],"latest_commit_sha":null,"homepage":"","language":"Go","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/aitmiloud.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-11-04T12:38:37.000Z","updated_at":"2025-11-05T16:09:26.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/aitmiloud/ngxtui","commit_stats":null,"previous_names":["aitmiloud/ngxtui"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/aitmiloud/ngxtui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitmiloud%2Fngxtui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitmiloud%2Fngxtui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitmiloud%2Fngxtui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitmiloud%2Fngxtui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aitmiloud","download_url":"https://codeload.github.com/aitmiloud/ngxtui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aitmiloud%2Fngxtui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31957663,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"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":["bubbletea","golang","nginx","tui"],"created_at":"2025-11-06T16:01:23.318Z","updated_at":"2026-04-18T05:34:09.008Z","avatar_url":"https://github.com/aitmiloud.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NGINX Terminal UI Manager (NgxTUI)\n\nA modern, feature-rich terminal UI for managing NGINX servers, built with [Bubble Tea](https://github.com/charmbracelet/bubbletea) and Go.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/header.png\" alt=\"NGX TUI Logo\" width=\"500\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/aitmiloud/ngxtui/actions\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/aitmiloud/ngxtui/ci.yml?branch=main\" alt=\"Build Status\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/aitmiloud/ngxtui/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/aitmiloud/ngxtui\" alt=\"Latest Release\"\u003e\u003c/a\u003e\n  \u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-green.svg\" alt=\"License: MIT\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://go.dev/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Go-%3E%3D%201.24-00ADD8\" alt=\"Go Version\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- Interactive, keyboard-driven dashboard: Sites, Logs, Stats, and Metrics tabs\n- Site management: enable/disable, config test, graceful reload, quick add\n- Powerful template system for \"Add Site\" with 11 pre-configured templates:\n  - Static, SPA, Node.js, WordPress, Laravel, Django, Docker/Proxy, WebSocket, Domain Redirect, API Gateway, Blank\n- Auto-populated forms, validation, and quick-start guides per template\n- NGINX config generation with SSL/TLS, proxy, PHP-FPM, and custom block support\n- Real-time metrics: CPU, memory, network, request throughput with live charts\n- Access log viewer: color-coded by status code, auto-scroll, quick filtering\n- Statistics: site distribution and performance summaries\n- Modular architecture: testable, production-ready, easy to extend\n- Modern TUI styling with a clean dark theme\n\n## Installation \u0026 Build\n\nPrerequisites:\n- Go 1.24 or higher\n- NGINX installed and running\n- A Unix-like OS (Linux recommended)\n\nBuild from source:\n\n```bash\ngit clone https://github.com/aitmiloud/ngxtui.git\ncd ngxtui\nmake build\n# or\ngo build -o bin/ngxtui ./cmd/ngxtui\n```\n\n## Usage\n\nRun the application (requires elevated privileges to manage NGINX configs):\n\n```bash\nsudo ./bin/ngxtui        # after building locally\n# or\nsudo make run            # build and run in one step\n```\n\nNotes:\n- Sudo is required to read/write NGINX configuration files and reload the service.\n- NgxTUI does not modify your configs without explicit actions from you.\n\n### Keyboard Controls\n\n- `←/→` or `h/l`: Switch between tabs\n- `↑/↓` or `k/j`: Navigate items\n- `Enter`: Select/Execute action\n- `Esc`: Go back\n- `a`: Add site\n- `r`: Refresh sites\n- `q`: Quit application\n\n## Tabs Overview\n\n### Sites Tab\n- View all configured NGINX sites\n- Enable/disable sites\n- Test configuration\n- Reload NGINX server\n- Add new site configuration\n\n### Logs Tab\n- Real-time access log viewing\n- Color-coded by status codes\n- Auto-scroll support\n- Quick status filtering\n\n### Stats Tab\n- Total sites overview\n- Active sites count\n- Request rate statistics\n- Uptime monitoring\n\n### Metrics Tab\n- Real-time CPU usage\n- Memory utilization\n- Network traffic\n- Request rate trends\n\n## Template System\n\nNgxTUI ships with a comprehensive template system for quick, safe site provisioning.\n\n- 11 ready-to-use templates: Static, SPA, Node.js, WordPress, Laravel, Django, Docker/Proxy, WebSocket, Domain Redirect, API Gateway, Blank\n- Auto-populates form fields and generates production-grade NGINX configs\n- Includes SSL/TLS, proxying, PHP-FPM, and custom configuration blocks\n- Built-in validation, previews, and quick-start guidance\n\n## Requirements\n\n- Go 1.24 or higher\n- NGINX installed and configured\n- Unix-like operating system (Linux, macOS)\n- Terminal with true color support\n\n## Development\n\nThis project follows a modular architecture with clear separation of concerns. See [ARCHITECTURE.md](ARCHITECTURE.md) for detailed documentation.\n\n### Project Structure\n```\ncmd/ngxtui/          # Application entry point\ninternal/\n  ├── app/           # Bubble Tea application logic\n  ├── model/         # Data models and types\n  ├── nginx/         # NGINX service layer\n  ├── styles/        # UI styling\n  └── ui/            # View rendering\n```\n\n### Building\n```bash\nmake build          # Build the application\nmake run            # Build and run (requires sudo)\nmake test           # Run tests\nmake lint           # Run linter\nmake fmt            # Format code\n```\n\n### Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Follow the architecture patterns (see `ARCHITECTURE.md`)\n4. Add tests for new functionality\n5. Commit your changes (`git commit -m 'Add some amazing feature'`)\n6. Push to the branch (`git push origin feature/amazing-feature`)\n7. Open a Pull Request\n\n## Dependencies\n\n- [bubbletea](https://github.com/charmbracelet/bubbletea): Terminal UI framework\n- [lipgloss](https://github.com/charmbracelet/lipgloss): Style definitions\n- [bubbles](https://github.com/charmbracelet/bubbles): UI components\n\n## Troubleshooting\n\n- Permission denied / operation not permitted\n  - Run via `sudo` as shown above.\n  - Ensure your user is allowed to reload NGINX (e.g., via `sudoers`).\n\n- NGINX reload fails\n  - Check syntax with `sudo nginx -t`.\n  - Inspect error logs (e.g., `/var/log/nginx/error.log`).\n\n- No sites listed / paths differ\n  - Verify your NGINX `sites-available` and `sites-enabled` directories.\n  - Customize paths in your system or adjust service configuration as needed.\n\n- Colors or graphics look wrong\n  - Use a terminal with true-color support.\n  - Ensure `TERM` is set appropriately (e.g., `xterm-256color`).\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Charm](https://charm.sh/) for their amazing terminal UI libraries\n- NGINX community for inspiration and documentation","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faitmiloud%2Fngxtui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faitmiloud%2Fngxtui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faitmiloud%2Fngxtui/lists"}