nexus/ProxMenux
2
0
Fork 0
mirror of https://github.com/MacRimi/ProxMenux.git synced 2026-04-05 20:03:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
MacRimi
2026-03-18 22:13:03 +01:00
parent 5611b69ad2
commit fd399edce7
1 changed files with 101 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

223
README.md
View File

@@ -1,53 +1,97 @@
<div align="center"> <div align="center">
<img src="https://github.com/MacRimi/ProxMenux/blob/main/images/main.png"
<img src="https://raw.githubusercontent.com/MacRimi/ProxMenux/main/images/proxmenux_logo.png" alt="ProxMenux Logo" width="180"/> alt="ProxMenux Logo"
style="max-width: 100%; height: auto;" >
# 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)
</div> </div>
--- <br />
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. <div align="center" style="margin-top: 20px;">
<a href="https://macrimi.github.io/ProxMenux/" target="_blank">
<img src="https://img.shields.io/badge/Website-%23E64804?style=for-the-badge&logo=World-Wide-Web&logoColor=white" alt="Website" />
</a>
<a href="https://macrimi.github.io/ProxMenux/docs/introduction" target="_blank">
<img src="https://img.shields.io/badge/Docs-%232A3A5D?style=for-the-badge&logo=read-the-docs&logoColor=white" alt="Docs" />
</a>
<a href="https://macrimi.github.io/ProxMenux/changelog" target="_blank">
<img src="https://img.shields.io/badge/Changelog-%232A3A5D?style=for-the-badge&logo=git&logoColor=white" alt="Changelog" />
</a>
<a href="https://macrimi.github.io/ProxMenux/guides" target="_blank">
<img src="https://img.shields.io/badge/Guides-%232A3A5D?style=for-the-badge&logo=bookstack&logoColor=white" alt="Guides" />
</a>
</div>
<br />
**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) ```bash
- [ProxMenux Monitor](#-proxmenux-monitor) bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh)"
- [Installation](#-installation) ```
- [Beta Program](#-beta-program)
- [Usage](#-usage) <br>
- [Menu Structure](#-menu-structure)
- [Dependencies](#-dependencies) ⚠️ Be careful when copying scripts from the internet. Always remember to check the source!
- [Contributing](#-contributing)
- [License](#-license) 📄 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 ```bash
- **VM & LXC management** — create, start, stop, restart and delete virtual machines and containers menu
- **Network configuration** — manage bridges, physical interfaces and network troubleshooting ```
- **Storage management** — configure and monitor ZFS pools, add disks, manage volumes Then, follow the on-screen options to manage your Proxmox server efficiently.
- **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)
--- ---
## 🧪 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
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. 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 ## 🔧 Dependencies
@@ -182,8 +144,14 @@ The following dependencies are installed automatically during setup:
| `python3` + `python3-venv` | Translation support *(Translation version only)* | | `python3` + `python3-venv` | Translation support *(Translation version only)* |
| `googletrans` | Google Translate library *(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 ## 🤝 Contributing
Contributions, bug reports and feature suggestions are welcome! 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
<div align="center"> [![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
<div style="display: flex; justify-content: center; align-items: center;">
<a href="https://ko-fi.com/G2G313ECAN" target="_blank" style="display: flex; align-items: center; text-decoration: none;">
<img src="https://raw.githubusercontent.com/MacRimi/HWEncoderX/main/images/kofi.png" alt="Support me on Ko-fi" style="width:140px; margin-right:40px;"/>
</a>
</div> </div>
Support the project on Ko-fi!
## Contributors
<a href="https://github.com/MacRimi/ProxMenux/graphs/contributors">
<img src="https://contrib.rocks/image?repo=MacRimi/ProxMenux" />
</a>
[contrib.rocks](https://contrib.rocks).