diff --git a/README.md b/README.md index 9e6f5720..3f8f82eb 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,97 @@
- -ProxMenux Logo - -# ProxMenux - -**An Interactive Menu for Proxmox VE Management** - -[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://github.com/MacRimi/ProxMenux/blob/main/LICENSE) -[![Stars](https://img.shields.io/github/stars/MacRimi/ProxMenux?style=flat&color=yellow)](https://github.com/MacRimi/ProxMenux/stargazers) -[![Forks](https://img.shields.io/github/forks/MacRimi/ProxMenux?style=flat&color=orange)](https://github.com/MacRimi/ProxMenux/network/members) -[![Last Commit](https://img.shields.io/github/last-commit/MacRimi/ProxMenux?color=green)](https://github.com/MacRimi/ProxMenux/commits/main) - + ProxMenux Logo +
---- +
-ProxMenux is a powerful menu-driven toolkit for Proxmox VE management, designed to simplify and streamline administration tasks through an intuitive interactive interface. Manage virtual machines, containers, networking, storage, hardware and more โ€” all without memorizing complex commands. +
+ + Website + + + Docs + + + Changelog + + + Guides + +
+ + +
+ + +**ProxMenux** is a management tool for **Proxmox VE** that simplifies system administration through an interactive menu, allowing you to execute commands and scripts with ease. --- -## ๐Ÿ“‹ Table of Contents +## ๐Ÿ“Œ Installation +To install ProxMenux, simply run the following command in your Proxmox server terminal: -- [Features](#-features) -- [ProxMenux Monitor](#-proxmenux-monitor) -- [Installation](#-installation) -- [Beta Program](#-beta-program) -- [Usage](#-usage) -- [Menu Structure](#-menu-structure) -- [Dependencies](#-dependencies) -- [Contributing](#-contributing) -- [License](#-license) +```bash +bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh)" +``` + +
+ +โš ๏ธ Be careful when copying scripts from the internet. Always remember to check the source! + +๐Ÿ“„ You can [review the source code](https://github.com/MacRimi/ProxMenux/blob/main/install_proxmenux.sh) before execution. + +๐Ÿ›ก๏ธ All executable links follow our [Code of Conduct](https://github.com/MacRimi/ProxMenux?tab=coc-ov-file#-2-security--code-responsibility). --- -## โœจ Features +## ๐Ÿ“Œ How to Use +Once installed, launch **ProxMenux** by running: -- **Interactive menus** โ€” navigate everything with arrow keys and Enter, no commands to memorize -- **VM & LXC management** โ€” create, start, stop, restart and delete virtual machines and containers -- **Network configuration** โ€” manage bridges, physical interfaces and network troubleshooting -- **Storage management** โ€” configure and monitor ZFS pools, add disks, manage volumes -- **Hardware management** โ€” detect PCI devices, configure IOMMU and passthrough (GPU, Coral TPU) -- **Post-install optimization** โ€” apply recommended settings after a fresh Proxmox installation -- **Helper Scripts integration** โ€” access Proxmox VE Helper-Scripts directly from the menu -- **Multi-language support** โ€” English and other languages via Google Translate (Translation version) -- **Automatic updates** โ€” ProxMenux checks for new versions on startup and updates itself -- **ProxMenux Monitor** โ€” real-time web dashboard for system monitoring (see below) +```bash +menu +``` +Then, follow the on-screen options to manage your Proxmox server efficiently. --- + +## ๐Ÿงช 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. @@ -86,88 +130,6 @@ systemctl restart proxmenux-monitor --- -## ๐Ÿ“ฆ Installation - -Run the following command in your Proxmox server terminal: - -```bash -bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh)" -``` - -> โš ๏ธ **Security notice:** Always review scripts before executing them. -> ๐Ÿ“„ You can [read the source code](https://github.com/MacRimi/ProxMenux/blob/main/install_proxmenux.sh) before running. -> ๐Ÿ›ก๏ธ All executable links follow our [Code of Conduct](https://github.com/MacRimi/ProxMenux/blob/main/CODE_OF_CONDUCT.md). - -**Two installation options are available:** - -| Version | Description | -|---|---| -| **Normal** | English only. Minimal dependencies. Recommended for Proxmox VE 9+. | -| **Translation** | Multi-language support via Google Translate. Requires Python 3 + virtual environment. | - -After installation, launch ProxMenux with: - -```bash -menu -``` - ---- - -## ๐Ÿงช 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. - ---- - -## ๐Ÿš€ Usage - -After installation, type `menu` in your Proxmox terminal to launch ProxMenux. Use the arrow keys to navigate, Enter to select, and Escape or the Back option to return to the previous menu. - -ProxMenux checks for available updates on each launch. If a newer version is available, it will prompt you to update before continuing. - ---- - -## ๐Ÿ—‚๏ธ Menu Structure - -ProxMenux is organized into modular sections: - -- **Post Install** โ€” apply recommended optimizations after a fresh Proxmox installation -- **Virtual Machines** โ€” create and manage VMs including OS image downloads -- **LXC Containers** โ€” create and manage containers with helper script integration -- **Network** โ€” configure bridges, interfaces and troubleshoot connectivity -- **Storage** โ€” manage ZFS, disks, passthrough and mount points -- **Hardware** โ€” PCI passthrough, IOMMU, GPU and Coral TPU setup -- **System** โ€” updates, utilities, Log2RAM, monitoring tools -- **Helper Scripts** โ€” direct access to Proxmox VE Helper-Scripts - ---- ## ๐Ÿ”ง Dependencies @@ -182,8 +144,14 @@ The following dependencies are installed automatically during setup: | `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! @@ -196,14 +164,25 @@ If you find ProxMenux useful, consider giving it a โญ on GitHub โ€” it helps ot --- -## ๐Ÿ“„ License -ProxMenux is released under the [GPL-3.0 License](https://github.com/MacRimi/ProxMenux/blob/main/LICENSE). ---- +## Star History -
+[![Star History Chart](https://api.star-history.com/svg?repos=MacRimi/ProxMenux&type=Date)](https://www.star-history.com/#MacRimi/ProxMenux&Date) -Made with โค๏ธ by [MacRimi](https://github.com/MacRimi) and contributors +
+ + Support me on Ko-fi +
+ +Support the project on Ko-fi! + +## Contributors + + + + +[contrib.rocks](https://contrib.rocks). +