mirror of
https://github.com/community-scripts/ProxmoxVE
synced 2025-01-27 11:06:18 +00:00
5d69a62b47
Some checks are pending
Auto Update .app-headers / update-app-headers (push) Waiting to run
Shellcheck / Shellcheck (push) Waiting to run
Create Changelog Pull Request / update-changelog-pull-request (push) Waiting to run
Frontend CI/CD / build (push) Waiting to run
Frontend CI/CD / deploy (push) Blocked by required conditions
105 lines
4.4 KiB
Markdown
105 lines
4.4 KiB
Markdown
<div align="center">
|
||
<p align="center">
|
||
<a href="#">
|
||
<img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo.png" height="100px" />
|
||
</a>
|
||
</p>
|
||
</div>
|
||
|
||
<div style="border: 2px solid #d1d5db; padding: 20px; border-radius: 8px; background-color: #f9fafb;">
|
||
<h2 align="center">Proxmox VE Helper-Scripts</h2>
|
||
<p align="center">A Community Legacy in Memory of @tteck</p>
|
||
<p align="center">
|
||
<a href="https://helper-scripts.com">
|
||
<img src="https://img.shields.io/badge/Website-4c9b3f?style=for-the-badge&logo=github&logoColor=white" alt="Website" />
|
||
</a>
|
||
<a href="https://discord.gg/UHrpNWGwkH">
|
||
<img src="https://img.shields.io/badge/Discord-7289da?style=for-the-badge&logo=discord&logoColor=white" alt="Discord" />
|
||
</a>
|
||
<a href="https://ko-fi.com/community_scripts">
|
||
<img src="https://img.shields.io/badge/Support-FF5F5F?style=for-the-badge&logo=ko-fi&logoColor=white" alt="Donate" />
|
||
</a>
|
||
<a href="https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTING.md">
|
||
<img src="https://img.shields.io/badge/Contribute-ff4785?style=for-the-badge&logo=git&logoColor=white" alt="Contribute" />
|
||
</a>
|
||
<a href="https://github.com/community-scripts/ProxmoxVE/blob/main/USER_SUBMITTED_GUIDES.md">
|
||
<img src="https://img.shields.io/badge/Guides-0077b5?style=for-the-badge&logo=read-the-docs&logoColor=white" alt="Guides" />
|
||
</a>
|
||
<a href="https://github.com/community-scripts/ProxmoxVE/blob/main/CHANGELOG.md">
|
||
<img src="https://img.shields.io/badge/Changelog-6c5ce7?style=for-the-badge&logo=git&logoColor=white" alt="Changelog" />
|
||
</a>
|
||
</p>
|
||
</div>
|
||
|
||
---
|
||
|
||
## 🚀 Project Overview
|
||
|
||
**Proxmox VE Helper-Scripts** is a collection of tools to simplify the setup and management of Proxmox Virtual Environment (VE). Originally created by [tteck](https://github.com/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.
|
||
|
||
---
|
||
|
||
## 📦 Features
|
||
|
||
- **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.
|
||
|
||
---
|
||
## ✅ Requirements
|
||
|
||
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.
|
||
|
||
---
|
||
|
||
## 🚀 Installation
|
||
|
||
To install the Proxmox Helper Scripts, follow these steps:
|
||
|
||
1. Visit the [Website](https://helper-scripts.com/).
|
||
2. Search for the desired script, e.g., **"Home Assistant OS VM"**.
|
||
3. Copy the provided **Bash command** from the **"How To Install"** section.
|
||
4. Open the Proxmox shell on your **main node** and paste the command.
|
||
5. Press enter to start the installation! 🚀
|
||
|
||
---
|
||
|
||
## ❤️ Community and Contributions
|
||
|
||
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.
|
||
|
||
## 💖 Donate to Support the Project
|
||
- **Ko-Fi for Community Edition**: [Donate to support this project](https://ko-fi.com/community_scripts) – Donations go towards maintaining the project, testing infrastructure, and charity (cancer research, hospice care). 30% of the funds will be donated to charity.
|
||
|
||
---
|
||
|
||
## 💬 Get Help
|
||
|
||
Join our community for support:
|
||
|
||
- **Discord**: Join our [Proxmox Helper Scripts Discord server](https://discord.gg/UHrpNWGwkH) for real-time support.
|
||
- **GitHub Discussions**: [Ask questions or report issues](https://github.com/community-scripts/ProxmoxVE/discussions).
|
||
|
||
## 🤝 Report a Bug or Feature Request
|
||
|
||
If you encounter any issues or have suggestions for improvement, file a new issue on our [GitHub issues page](https://github.com/community-scripts/ProxmoxVE/issues). You can also submit pull requests with solutions or enhancements!
|
||
|
||
---
|
||
|
||
## 📜 License
|
||
|
||
This project is licensed under the [MIT License](LICENSE).
|
||
|
||
</br>
|
||
</br>
|
||
<p align="center">
|
||
<i style="font-size: smaller;"><b>Proxmox</b>® is a registered trademark of <a href="https://www.proxmox.com/en/about/company">Proxmox Server Solutions GmbH</a>.</i>
|
||
</p>
|
||
|
||
|