diff --git a/README.md b/README.md index 859041df..1b6bae02 100644 --- a/README.md +++ b/README.md @@ -57,20 +57,114 @@ Then, follow the on-screen options to manage your Proxmox server efficiently. --- -## ๐Ÿ“Œ System Requirements -๐Ÿ–ฅ **Compatible with:** -- Proxmox VE 8.x and 9.x -๐Ÿ“ฆ **Dependencies:** -- `bash`, `curl`, `wget`, `jq`, `whiptail`, `python3-venv` (These dependencies are installed automatically during setup.) -- **Translations are handled in a Python virtual environment using `googletrans-env`.** +## ๐Ÿงช Beta Program + +Want to try the latest features before the official release and help shape the final version? + +The **ProxMenux Beta Program** gives early access to new functionality โ€” including the newest builds of ProxMenux Monitor โ€” directly from the `develop` branch. Beta builds may contain bugs or incomplete features. Your feedback is what helps fix them before the stable release. + +**Install the beta version:** + +```bash +bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/develop/install_proxmenux_beta.sh)" +``` + +**What to expect:** + +- You'll get new features and Monitor builds before anyone else +- Some things may not work perfectly โ€” that's expected and normal +- When a stable release is published, ProxMenux will notify you on the next `menu` launch and offer to switch automatically + +**How to report issues:** + +Open a [GitHub Issue](https://github.com/MacRimi/ProxMenux/issues) and include: +- What you did and what you expected to happen +- Any error messages shown on screen +- Logs from the Monitor if relevant: + +```bash +journalctl -u proxmenux-monitor -n 50 +``` + +> ๐Ÿ’™ Thank you for being part of the beta program. Your help makes ProxMenux better for everyone. --- + +## ๐Ÿ–ฅ๏ธ ProxMenux Monitor + +ProxMenux Monitor is an integrated web dashboard that provides real-time visibility into your Proxmox infrastructure โ€” accessible from any browser on your network, without needing a terminal. + +**What it offers:** + +- Real-time monitoring of CPU, RAM, disk usage and network traffic +- Overview of running VMs and LXC containers with status indicators +- Login authentication to protect access +- Two-Factor Authentication (2FA) with TOTP support +- Reverse proxy support (Nginx / Traefik) +- Designed to work across desktop and mobile devices + +**Access:** + +Once installed, the dashboard is available at: + +``` +http://:8008 +``` + +The Monitor is installed automatically as part of the standard ProxMenux installation and runs as a systemd service (`proxmenux-monitor.service`) that starts automatically on boot. + +**Useful commands:** + +```bash +# Check service status +systemctl status proxmenux-monitor + +# View logs +journalctl -u proxmenux-monitor -n 50 + +# Restart the service +systemctl restart proxmenux-monitor +``` + +--- + + +## ๐Ÿ”ง Dependencies + +The following dependencies are installed automatically during setup: + +| Package | Purpose | +|---|---| +| `dialog` | Interactive terminal menus | +| `curl` | Downloads and connectivity checks | +| `jq` | JSON processing | +| `git` | Repository cloning and updates | +| `python3` + `python3-venv` | Translation support *(Translation version only)* | +| `googletrans` | Google Translate library *(Translation version only)* | + + +--- + + ## โญ Support the Project! If you find **ProxMenux** useful, consider giving it a โญ on GitHub to help others discover it! +## ๐Ÿค Contributing + +Contributions, bug reports and feature suggestions are welcome! + +- ๐Ÿ› [Report a bug](https://github.com/MacRimi/ProxMenux/issues/new) +- ๐Ÿ’ก [Suggest a feature](https://github.com/MacRimi/ProxMenux/discussions) +- ๐Ÿ”€ [Submit a pull request](https://github.com/MacRimi/ProxMenux/pulls) + + +--- + + + ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=MacRimi/ProxMenux&type=Date)](https://www.star-history.com/#MacRimi/ProxMenux&Date)