ProxMenux/README.md

82 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2025-01-09 22:45:37 +01:00
<div align="center">
2025-03-04 23:40:46 +01:00
<img src="https://github.com/MacRimi/ProxMenux/blob/main/images/main.png"
alt="ProxMenu Logo"
2025-03-05 13:12:55 +01:00
style="max-width: 100%; height: auto;" >
2025-01-09 22:45:37 +01:00
</div>
2025-03-04 23:22:03 +01:00
<br />
2025-03-05 11:35:38 +01:00
2025-03-04 23:22:03 +01:00
<div align="center" style="margin-top: 20px;">
2025-03-04 23:44:37 +01:00
<a href="https://macrimi.github.io/ProxMenux/" target="_blank">
2025-03-05 11:43:47 +01:00
<img src="https://img.shields.io/badge/Website-%23E64804?style=for-the-badge&logo=World-Wide-Web&logoColor=white" alt="Website" />
2025-03-04 23:06:23 +01:00
</a>
2025-03-04 23:14:11 +01:00
<a href="https://macrimi.github.io/ProxMenux/docs/introduction" target="_blank">
2025-03-05 11:37:03 +01:00
<img src="https://img.shields.io/badge/Docs-%232A3A5D?style=for-the-badge&logo=read-the-docs&logoColor=white" alt="Docs" />
2025-03-04 23:06:23 +01:00
</a>
2025-03-04 23:14:11 +01:00
<a href="https://macrimi.github.io/ProxMenux/changelog" target="_blank">
2025-03-05 11:37:03 +01:00
<img src="https://img.shields.io/badge/Changelog-%232A3A5D?style=for-the-badge&logo=git&logoColor=white" alt="Changelog" />
2025-03-04 23:06:23 +01:00
</a>
2025-03-04 23:14:11 +01:00
<a href="https://macrimi.github.io/ProxMenux/guides" target="_blank">
2025-03-05 11:37:03 +01:00
<img src="https://img.shields.io/badge/Guides-%232A3A5D?style=for-the-badge&logo=bookstack&logoColor=white" alt="Guides" />
2025-03-04 23:06:23 +01:00
</a>
</div>
2025-03-05 11:33:47 +01:00
2025-03-05 11:37:03 +01:00
2025-03-04 23:14:11 +01:00
<br />
2025-02-02 22:40:35 +01:00
2025-03-04 23:06:23 +01:00
**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.
2025-02-02 22:40:35 +01:00
---
## 📌 Installation
2025-02-02 22:29:40 +01:00
To install ProxMenux, simply run the following command in your Proxmox server terminal:
2024-12-20 20:33:34 +01:00
2025-02-02 22:40:35 +01:00
```bash
bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh)"
2024-12-20 20:33:34 +01:00
```
2025-02-02 22:40:35 +01:00
2025-03-09 16:26:11 +01:00
<br>
2025-03-09 16:04:10 +01:00
2025-03-09 16:26:11 +01:00
⚠️ Be careful when copying scripts from the internet. Always remember to check the source!
2025-03-09 16:05:59 +01:00
2025-03-09 16:26:11 +01:00
📄 You can [review the source code](https://github.com/MacRimi/ProxMenux/blob/main/install_proxmenux.sh) before execution.
2025-03-09 16:04:10 +01:00
2025-03-09 16:26:11 +01:00
🛡️ All executable links follow our [Code of Conduct](https://github.com/MacRimi/ProxMenux?tab=coc-ov-file#-2-security--code-responsibility).
2025-03-09 16:04:10 +01:00
2025-02-02 22:40:35 +01:00
---
## 📌 How to Use
Once installed, launch **ProxMenux** by running:
```bash
2025-03-03 20:17:27 +01:00
menu
2024-12-20 20:33:34 +01:00
```
2025-02-02 22:40:35 +01:00
Then, follow the on-screen options to manage your Proxmox server efficiently.
---
## 📌 System Requirements
🖥 **Compatible with:**
2025-02-02 22:43:54 +01:00
- Proxmox VE 8.x**
2025-02-02 22:40:35 +01:00
📦 **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!
2025-02-02 22:51:46 +01:00
<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;">
2025-03-04 23:31:37 +01:00
<img src="https://raw.githubusercontent.com/MacRimi/HWEncoderX/main/images/kofi.png" alt="Support me on Ko-fi" style="width:140px; margin-right:40px;"/>
2025-02-02 22:51:46 +01:00
</a>
</div>
2025-03-03 20:21:50 +01:00
Support the project on Ko-fi!
2025-02-02 22:51:46 +01:00
2025-02-02 22:40:35 +01:00