ProxmoxVE/README.md

105 lines
4.4 KiB
Markdown
Raw Permalink Normal View History

2023-11-26 22:36:25 +00:00
<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>
2023-11-26 22:36:25 +00:00
</div>
2024-11-01 14:13:34 +00:00
<div style="border: 2px solid #d1d5db; padding: 20px; border-radius: 8px; background-color: #f9fafb;">
2025-01-17 09:10:11 +00:00
<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">
2025-01-19 11:58:12 +00:00
<img src="https://img.shields.io/badge/Support-FF5F5F?style=for-the-badge&logo=ko-fi&logoColor=white" alt="Donate" />
2025-01-17 09:10:11 +00:00
</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>
2023-11-22 19:58:01 +00:00
---
2025-01-17 09:10:11 +00:00
## 🚀 Project Overview
2024-11-01 14:13:34 +00:00
2025-01-17 09:10:11 +00:00
**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.
2023-11-22 20:13:00 +00:00
2025-01-17 09:10:11 +00:00
---
2025-01-17 09:10:11 +00:00
## 📦 Features
2025-01-17 09:10:11 +00:00
- **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.
2024-11-01 14:13:34 +00:00
---
2025-01-17 09:10:11 +00:00
## ✅ Requirements
2024-11-01 14:13:34 +00:00
2025-01-17 09:10:11 +00:00
Ensure your system meets the following prerequisites:
2025-01-17 09:10:11 +00:00
- **Proxmox VE version**: 8.x or higher
- **Linux**: Compatible with most distributions
- **Dependencies**: bash and curl should be installed.
2025-01-17 09:10:11 +00:00
---
2025-01-17 09:10:11 +00:00
## 🚀 Installation
2025-01-17 09:10:11 +00:00
To install the Proxmox Helper Scripts, follow these steps:
2025-01-17 09:10:11 +00:00
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! 🚀
2025-01-17 09:10:11 +00:00
---
2025-01-17 09:10:11 +00:00
## ❤️ Community and Contributions
2025-01-17 09:10:11 +00:00
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.
2025-01-17 09:10:11 +00:00
## 💖 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.
2025-01-17 09:10:11 +00:00
---
2025-01-17 09:10:11 +00:00
## 💬 Get Help
2025-01-17 09:10:11 +00:00
Join our community for support:
2025-01-17 09:10:11 +00:00
- **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).
2025-01-17 09:10:11 +00:00
## 🤝 Report a Bug or Feature Request
2025-01-17 09:10:11 +00:00
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!
2025-01-17 09:10:11 +00:00
---
2025-01-17 09:10:11 +00:00
## 📜 License
2024-11-01 14:15:23 +00:00
2025-01-17 09:10:11 +00:00
This project is licensed under the [MIT License](LICENSE).
2024-11-01 14:15:23 +00:00
2025-01-17 09:10:11 +00:00
</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>