ProxMenux/README.md
2025-02-02 22:40:35 +01:00

86 lines
2.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
<img src="https://github.com/MacRimi/ProxMenux/blob/main/images/proxmenu.png" alt="ProxMenu Logo" width="265" height="294">
</div>
# 🚀 ProxMenux: Interactive Menu for Proxmox VE Management
**ProxMenux** is an interactive menu for **Proxmox VE** that simplifies advanced task management and automation through scripts hosted on GitHub.
## ✨ Key Features
**Easy-to-use interface** Navigate Proxmox tasks with a structured menu.
**Multi-language support** Customize the interface to your preferred language.
**Automation & scripts** Automate repetitive tasks effortlessly.
**Automatic updates detection** ProxMenux detects updates automatically and prompts you before applying any changes.
**Lightweight & fast** Optimized for speed and low resource usage.
---
## 📌 Installation
To install ProxMenux, simply run the following command in your Proxmox server terminal:
```bash
bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh)"
```
---
## 📌 How to Use
Once installed, launch **ProxMenux** by running:
```bash
menu.sh
```
Then, follow the on-screen options to manage your Proxmox server efficiently.
---
## 📌 Screenshots & Interface Preview
_(Add screenshots or GIFs showcasing ProxMenux in action)_
---
## 📌 Features & Menu Options
**ProxMenux** allows you to:
**Manage virtual machines (VMs) and containers (LXC).**
**Assign or passthrough GPUs to VMs.**
**Backup and restore configurations.**
**Install NVIDIA drivers and other dependencies.**
**Optimize Proxmox settings.**
**And much more...**
---
## 📌 System Requirements
🖥 **Compatible with:**
- Proxmox VE **7.x / 8.x**
- Debian-based systems
📦 **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`.**
---
## 📌 Contributing
Contributions are welcome! If you want to improve **ProxMenux**, feel free to fork the repository and submit a pull request.
---
## 📌 License
🔖 ProxMenux is licensed under the **MIT License** You are free to use, modify, and distribute it.
📜 See the full license [here](https://github.com/MacRimi/ProxMenux/blob/main/LICENSE).
---
## ⭐ Support the Project!
If you find **ProxMenux** useful, consider giving it a ⭐ on GitHub to help others discover it!
---
## 🔥 Final Thoughts
This **structured README** ensures that **users quickly understand what ProxMenux does, how to install it, and how to contribute**.
🚀 **Now ready to publish on GitHub!** 😃