About this project
Proxmox VE Helper-Scripts (Community Edition) is a community-maintained collection of automation scripts that install and configure self-hosted services on Proxmox VE. Instead of manually hunting packages and editing configuration files, users paste a single command into the Proxmox shell, answer a few prompts, and end up with a running container or virtual machine.
The project is presented as a community continuation built on the foundation of tteck's original work, and is maintained by a small core team together with outside contributors. Scripts are MIT licensed, so they can be used, modified and redistributed for personal and commercial purposes.
Requirements
- Proxmox VE version 8.4, 9.0, 9.1 or 9.2 (a Debian-based Proxmox host).
- Root shell access on the Proxmox host.
- An internet connection during installation.
Getting started
1. Browse the project website to find the service you want, for example Home Assistant, Nginx Proxy Manager or Jellyfin.
2. Copy the one-line install command shown on that script's page.
3. Open the Proxmox shell and paste the command.
4. Choose either Default or Advanced setup and follow the prompts.
Each script page is documented with what the container includes, its default resource allocation, and post-install notes.
How the scripts behave
Default mode selects sensible CPU, RAM and storage defaults and asks only the minimum required questions, with most installs stated to finish in under five minutes. Advanced mode exposes container settings, networking, storage backends and application-level configuration before anything is installed. After installation, each container includes a post-install helper reachable from the Proxmox shell, which can apply updates to the installed service, change application settings without hand-editing config files, and provide basic troubleshooting and log access.
Scope of the collection
The README describes coverage of hundreds of services, grouped into categories such as home automation (Home Assistant, Zigbee2MQTT, ESPHome, Node-RED), media (Jellyfin, Plex, Radarr, Sonarr, Immich), networking (AdGuard Home, Nginx Proxy Manager, Pi-hole, Traefik), monitoring (Grafana, Prometheus, Uptime Kuma, Netdata), databases (PostgreSQL, MariaDB, Redis, InfluxDB), security (Vaultwarden, CrowdSec, Authentik) and development tools (Gitea, Portainer, VS Code Server, n8n). A full, regularly updated list is published on the project website's category pages.
Contributing
New scripts are not accepted in this repository directly: they are first submitted and tested in the separate ProxmoxVED repository, and pull requests adding new scripts here are closed. Bug fixes and improvements to existing scripts belong in this repository and should follow the contributing guidelines, with one focused change per pull request and documentation of what the script installs plus any non-obvious decisions in the corresponding JSON metadata file. Bugs are reported through the issue tracker, requests and questions through discussions or the project's Discord, and security vulnerabilities through the security policy.
Support and licensing
The project is maintained by volunteers, with infrastructure costs paid out of pocket; the README states that 30% of all donations are forwarded to cancer research and hospice care, a cause important to tteck. Proxmox is noted as a registered trademark of Proxmox Server Solutions GmbH, and the code is released under the MIT License.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.