MCPcopy
hub / github.com/MacRimi/ProxMenux

github.com/MacRimi/ProxMenux @v1.2.2 sqlite

repository ↗ · DeepWiki ↗ · release v1.2.2 ↗
2,882 symbols 6,478 edges 329 files 935 documented · 32%
README
<img src="https://github.com/MacRimi/ProxMenux/blob/main/images/main.png"
     alt="ProxMenux Logo"
     style="max-width: 100%; height: auto;" >











<a href="https://proxmenux.com/en" 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://proxmenux.com/en/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://proxmenux.com/en/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://proxmenux.com/en/guides" target="_blank">
    <img src="https://img.shields.io/badge/Guides-%232A3A5D?style=for-the-badge&logo=bookstack&logoColor=white" alt="Guides" />
</a>







<a href="https://github.com/MacRimi/ProxMenux/releases/latest"><img src="https://img.shields.io/github/v/release/MacRimi/ProxMenux?display_name=tag&label=latest&color=2A3A5D&style=flat-square" alt="Latest release" /></a>
<a href="https://github.com/MacRimi/ProxMenux/releases?q=prerelease%3Atrue"><img src="https://img.shields.io/github/v/release/MacRimi/ProxMenux?include_prereleases&label=beta&color=E64804&style=flat-square" alt="Latest beta" /></a>
<a href="https://github.com/MacRimi/ProxMenux/blob/main/LICENSE"><img src="https://img.shields.io/github/license/MacRimi/ProxMenux?color=2A3A5D&style=flat-square&cacheSeconds=300" alt="License" /></a>
<a href="https://github.com/MacRimi/ProxMenux/stargazers"><img src="https://img.shields.io/github/stars/MacRimi/ProxMenux?style=flat-square" alt="GitHub stars" /></a>
<a href="https://github.com/MacRimi/ProxMenux/issues"><img src="https://img.shields.io/github/issues/MacRimi/ProxMenux?color=2A3A5D&style=flat-square" alt="Open issues" /></a>

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 -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 before execution.

🛡️ All executable links follow our Code of Conduct.


📌 How to Use

Once installed, launch ProxMenux by running:

menu

Then, follow the on-screen options to manage your Proxmox server efficiently.


🖥️ 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.

What it offers:

  • Real-time monitoring of CPU, RAM, disk usage and network traffic
  • Overview of running VMs and LXC containers with status indicators
  • Login authentication to protect access
  • Two-Factor Authentication (2FA) with TOTP support
  • Reverse proxy support (Nginx / Traefik)
  • Designed to work across desktop and mobile devices

Access:

Once installed, the dashboard is available at:

http://<your-proxmox-ip>:8008

The Monitor is installed automatically as part of the standard ProxMenux installation and runs as a systemd service (proxmenux-monitor.service) that starts automatically on boot.

Useful commands:

# Check service status
systemctl status proxmenux-monitor

# View logs
journalctl -u proxmenux-monitor -n 50

# Restart the service
systemctl restart proxmenux-monitor

🧪 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 -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 and include: - What you did and what you expected to happen - Any error messages shown on screen - Logs from the Monitor if relevant:

journalctl -u proxmenux-monitor -n 50

💙 Thank you for being part of the beta program. Your help makes ProxMenux better for everyone.


🔧 Dependencies

The following dependencies are installed automatically during setup:

Package Purpose
dialog Interactive terminal menus
curl Downloads and connectivity checks
jq JSON processing
git Repository cloning and updates
python3 + python3-venv Translation support (Translation version only)
googletrans Google Translate library (Translation version only)

🛡️ Security Note / VirusTotal False Positive

If you scan the raw installation URL on VirusTotal, you might see a 1/95 detection by heuristic engines like Chong Lua Dao. This is a known false positive. Because this script uses the standard curl | bash installation pattern and downloads legitimate binaries (like jq from its official GitHub release), overly aggressive scanners flag the behavior. The script is 100% open source and safe to review. You can read more about this in Issue #162.


🤝 Contributing

ProxMenux is an open, collaborative project — contributions of every shape are very welcome, no matter your background. Every PR, bug report, idea, translation or kind word helps move the project forward.

📖 Before sending code, please read the Contributing Guide. It covers the project structure, the UI design policy (the two-phase dialog / whiptail flow), message helpers, translation policy and submission conventions — what reviewers will look for in your PR.

Ways to help:

  • 💻 Code — fix a bug, polish a script, add a feature. Read the Contributing Guide first, then open a pull request.
  • 🐛 Bug reports — found something broken? Open an issue with steps to reproduce, and the Monitor logs if relevant (journalctl -u proxmenux-monitor -n 50).
  • 💡 Ideas & feedback — share suggestions in GitHub Discussions. Every idea is welcome.
  • 🌍 Translations — the documentation site already supports English and Spanish; help expand it to more languages following the translation guide (one page per PR).
  • 🧪 Beta testing — run the beta build and let us know what you find.
  • Spread the word — a GitHub star or a mention in your homelab community helps others discover the project.

Before contributing, please take a moment to read our Code of Conduct.

Contributors

Thanks to everyone who has helped make ProxMenux what it is today.

ProxMenux contributors

Made with contrib.rocks.


⭐ Support the Project

If ProxMenux is useful to you, the simplest way to support it is a ⭐ on GitHub — it really helps others discover the project.

If you want to go a step further, a coffee on Ko-fi keeps development going:

Support on Ko-fi


📈 Star History

Star History Chart

Extension points exported contracts — how you extend this code

Temperature (Interface)
(no doc)
AppImage/types/hardware.ts
TempHistoryPoint (Interface)
(no doc)
AppImage/components/disk-temperature-detail-modal.tsx
DiskTempThreshold (Interface)
(no doc)
AppImage/lib/health-thresholds.ts
Window (Interface)
(no doc)
web/components/search-dialog.tsx
ChangelogEntry (Interface)
(no doc)
web/app/rss.xml/route.ts
State (Interface)
(no doc)
web/hooks/use-toast.ts
PowerMeter (Interface)
(no doc)
AppImage/types/hardware.ts
TempStats (Interface)
(no doc)
AppImage/components/disk-temperature-detail-modal.tsx

Core symbols most depended-on inside this repo

cn
called by 210
web/lib/utils.ts
filter
called by 96
AppImage/scripts/flask_server.py
fetchApi
called by 93
AppImage/lib/api-config.ts
cn
called by 57
AppImage/lib/utils.ts
send
called by 50
AppImage/scripts/notification_channels.py
_run_cmd
called by 43
AppImage/scripts/security_manager.py
esc
called by 37
AppImage/components/security.tsx
_run_pve_cmd
called by 37
AppImage/scripts/oci_manager.py

Shape

Function 2,084
Method 395
Interface 185
Route 181
Class 37

Languages

TypeScript57%
Python43%

Modules by API surface

AppImage/scripts/flask_server.py257 symbols
AppImage/scripts/notification_events.py92 symbols
AppImage/scripts/health_persistence.py78 symbols
AppImage/components/storage-overview.tsx73 symbols
AppImage/scripts/notification_manager.py70 symbols
AppImage/scripts/health_monitor.py64 symbols
AppImage/scripts/notification_channels.py62 symbols
AppImage/scripts/flask_notification_routes.py54 symbols
AppImage/scripts/flask_auth_routes.py53 symbols
AppImage/scripts/auth_manager.py47 symbols
AppImage/components/virtual-machines.tsx47 symbols
AppImage/components/security.tsx46 symbols

Dependencies from manifests, versioned

@hookform/resolvers3.10.0 · 1×
@radix-ui/react-accordion1.2.2 · 1×
@radix-ui/react-alert-dialog1.1.4 · 1×
@radix-ui/react-aspect-ratio1.1.1 · 1×
@radix-ui/react-avatar1.1.2 · 1×
@radix-ui/react-checkbox1.1.3 · 1×
@radix-ui/react-collapsible1.1.2 · 1×
@radix-ui/react-context-menu2.2.4 · 1×
@radix-ui/react-dialog1.1.4 · 1×
@radix-ui/react-dropdown-menu2.1.4 · 1×
@radix-ui/react-hover-card1.1.4 · 1×
@radix-ui/react-label2.1.1 · 1×

For agents

$ claude mcp add ProxMenux \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact