ProxMenux/README.md
2025-05-30 11:12:45 +02:00

82 lines
2.9 KiB
Markdown

<div align="center">
<img src="https://github.com/MacRimi/ProxMenux/blob/main/images/main.png"
alt="ProxMenu Logo"
style="max-width: 100%; height: auto;" >
</div>
<br />
<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.
---
## 📌 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)"
```
<br>
⚠️ 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).
---
## 📌 How to Use
Once installed, launch **ProxMenux** by running:
```bash
menu
```
Then, follow the on-screen options to manage your Proxmox server efficiently.
---
## 📌 System Requirements
🖥 **Compatible with:**
- Proxmox VE 8.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`.**
---
## ⭐ Support the Project!
If you find **ProxMenux** useful, consider giving it a ⭐ on GitHub to help others discover it!
<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>
Support the project on Ko-fi!