Proxmox VE Helper-Scripts is a collection of tools to simplify the setup and management of Proxmox Virtual Environment (VE). Originally created by tteck, these scripts are now continued by the community. Our goal is to preserve and expand upon tteck's work, providing an ongoing resource for Proxmox users worldwide.
- Interactive Setup: Choose between simple and advanced options for configuring VMs and LXC containers.
- Customizable Configurations: Advanced setup for fine-tuning your environment.
- Seamless Integration: Works seamlessly with Proxmox VE for a smooth experience.
- Community-driven: Actively maintained and improved by the Proxmox community.
Ensure your system meets the following prerequisites:
- Proxmox VE version: 8.x or higher
- Linux: Compatible with most distributions
- Dependencies: bash and curl should be installed.
To install the Proxmox Helper Scripts, follow these steps:
- Visit the Website.
- Search for the desired script, e.g., "Home Assistant OS VM".
- Copy the provided Bash command from the "How To Install" section.
- Open the Proxmox shell on your main node and paste the command.
- Press enter to start the installation! 🚀
We appreciate any contributions to the project—whether it's bug reports, feature requests, documentation improvements, or spreading the word. Your involvement helps keep the project alive and sustainable.
- Ko-Fi for Community Edition: Donate to support this project – Donations go towards maintaining the project, testing infrastructure, and charity (cancer research, hospice care). 30% of the funds will be donated to charity.
Join our community for support:
- Discord: Join our Proxmox Helper Scripts Discord server for real-time support.
- GitHub Discussions: Ask questions or report issues.
If you encounter any issues or have suggestions for improvement, file a new issue on our GitHub issues page. You can also submit pull requests with solutions or enhancements!
This project is licensed under the MIT License.
Proxmox® is a registered trademark of Proxmox Server Solutions GmbH.
This fork aims to add support for Nvidia GPU. The scripts are not guaranteed to work with every hardware, but they have been tested with the following hardware:
- CPU: AMD Ryzen 5 3600
- Compute GPU (LXC): Nvidia T600
- Gaming GPU (VM): Nvidia RTX 2060
- Motherboard: Asrock B450M Pro4-F
- RAM: 4x8GB HyperX (non ECC)
All diagnostic functions have been disabled.
Here's a shortlist of scripts/apps that did not get merged upstream (tteck) for various reasons:
- Collabora Online
- Backup2Azure
- Frigate with Nvidia GPU passthrough (older cards such as Pascal may not work)
- Epic Games free games
- Scrutiny
- SAQLottery
- Nvidia drivers support (detection/installation)
- Windows 11 Gaming VM
I have added some configuration options to streamline deployment of certain services in my environment. When building a container, I run an extra script to do that additional configuration. That script is ct/post_create_lxc.sh, which is called at the end of the build_container() function (in build.func). This can be used to:
- mount a shared folder by adding this configuration to the LXC:
mp0: /mnt/pve/share/public,mp=/mnt/pve/share - setup postfix service to run as a satellite, leveraging a single postfix LXC to send all emails
- passthrough a Nvidia GPU
Some of these configurations leverage settings that can be found in /etc/pve-helper-scripts.conf.
To create a new LXC, run the following command directly on the host:
bash -c "$(wget -qLO - https://github.com/remz1337/ProxmoxVE/raw/remz/ct/<app>.sh)"
and replace <app> by the service you wish to deploy, eg. .../remz/ct/frigate.sh)
To update an existing LXC, run the following command directly on the host, where <ID> is the LXC ID (eg. 100, 101...) :
pct exec <ID> -- /usr/bin/update
Alternatively, you can update from within the LXC by running the same command used to create the machine but inside it (not on the host). Easiest way is to log in from the host using the pct enter command with the machine ID :
pct enter <ID>
bash -c "$(wget -qLO - https://github.com/remz1337/ProxmoxVE/raw/remz/ct/<app>.sh)"
To install or update latest Nvidia drivers, run the following command directly on the host:
bash -c "$(wget -qLO - https://github.com/remz1337/ProxmoxVE/raw/remz/misc/nvidia-drivers-host.sh)"
- Ko-Fi for remz1337's fork: Donate to support this fork