Dear Community,
In agreement with tteck and Community-Scripts, this project has now transitioned into a community-driven effort. We aim to continue his work, building on the foundation he laid to support Proxmox users worldwide. Tteck sadly passed away in early November 2024. This project will be a memorial for his incredible contribution to the community.
Proxmox VE Helper-Scripts is a community-driven initiative that simplifies the setup of Proxmox Virtual Environment (VE). Originally created by tteck, these scripts automate and streamline the process of creating and configuring Linux containers (LXC) and virtual machines (VMs) on Proxmox VE.
- Interactive Setup: Select simple or advanced options for your VM or LXC container configurations.
- Customizable Configuration: Advanced setup allows you to fine-tune your environment.
- Ease of Use: Scripts automatically validate inputs to generate the final configuration.
- Proxmox Integration: Seamlessly integrates with Proxmox VE to provide a user-friendly experience.
- Community-Driven: This project is actively maintained and improved by the community.
To install the Proxmox Helper Scripts, simply follow these steps:
- Open the Website
- Search for the desired script, e.g. "Home Assistant OS VM".
- In the "How To Install" section, copy the provided Bash command.
- Open the Proxmox shell on your main node.
- Paste the command into the console, hit enter, and you are away! 🚀
For detailed instructions, check out our official guides.
The Proxmox Helper Scripts project is community-driven, and we highly appreciate any contributions — whether it's through reporting bugs, suggesting features, improving documentation, or spreading the word. We are committed to maintaining transparency and sustainability in this open-source effort.
We offer two donation options to help maintain and grow this project:
- Ko-Fi for tteck: Donate to tteck's wife - All donations will go directly to Angie, wife of the founder of this project who passed away in early November 2024.
- Ko-Fi for Community Edition: Donate to this project - All funds will go towards script maintenance infrastructure and server costs. Our most immediate need is funding testing infrastructure. Your contributions help keep the project running. To honor tteck's legacy this project will also raise money for charity (cancer research, hospice care). Of the money donated to this project, 30% will be donated to charity. Income, expenditure and charitable donations will be disclosed annually in a transparent manner.
- Ko-Fi for remz1337 Edition: Donate to this fork - All funds will go towards script maintenance infrastructure and server costs.
Have a question or ran into an issue? Join the conversation and get help from fellow community members:
- Discord: Join our Proxmox Helper Scripts Discord server to chat with other users and get support.
- GitHub Discussions: Ask questions or report issues.
If you’ve encountered an issue or identified an area for improvement, please file a new issue on our GitHub issues page. If you’ve already found a solution or improvement, feel free to submit a pull request! We’d love to review and merge your contributions.
To use the Proxmox VE Helper-Scripts, your system should meet the following requirements:
- Proxmox VE version: 8.x or higher
- Linux: Compatible with most distributions
- Dependencies: Ensure that your system has bash and curl installed.
This project is licensed under the terms of the MIT License.
This community project is a memorial to the memory of tteck. His foundational work created a thriving Proxmox community. Tteck worked on this project right until the end, even while in hospice. We are dedicated to keeping his vision alive and expanding upon it with the continued support of this vibrant community.
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)
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, leverage 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)"