-
-
Notifications
You must be signed in to change notification settings - Fork 442
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
93 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,116 @@ | ||
| <div align="center"> | ||
| <a href="#"> | ||
| <img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo.png" height="100px" /> | ||
| </a> | ||
| <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: A Community Legacy</h2> | ||
| <p>Dear Community,</p> | ||
| <p>In agreement with <a href="https://github.com/tteck">tteck</a> and <a href="https://github.com/community-scripts">Community-Scripts</a>, 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.</p> | ||
| <p>tteck, whose contribution has been invaluable, shared recently that he is now in hospice care. His scripts have empowered thousands, and we honor his legacy by carrying this project forward with the same passion and commitment. We’re deeply grateful for his vision, which made Proxmox accessible to so many.</p> | ||
| <p>To tteck: Your impact will be felt in this community for years to come. We thank you for everything.</p> | ||
| <p>Warm regards,<br>The Community</p> | ||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| <p align="center"> | ||
| <a href="https://helper-scripts.com">Website</a> | | ||
| <a href="https://ko-fi.com/proxmoxhelperscripts">Ko-Fi (for tteck🙏)</a> | | ||
| <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTING.md">Contribute</a> | | ||
| <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/USER_SUBMITTED_GUIDES.md">Guides</a> | | ||
| <a href="https://discord.gg/UHrpNWGwkH">Discord</a> | | ||
| <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/CHANGELOG.md">Changelog</a> | ||
| <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://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://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://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> | ||
|
|
||
| <hr> | ||
|
|
||
| ## 🚀 Introduction | ||
|
|
||
| **Proxmox VE Helper-Scripts** is a community-driven initiative that simplifies the setup of Proxmox Virtual Environment (VE). Originally created by [tteck](https://github.com/tteck), these scripts automate and streamline the process of creating and configuring Linux containers (LXC) and virtual machines (VMs) on Proxmox VE. | ||
|
|
||
| --- | ||
|
|
||
| This community-managed project continues tteck’s original vision of simplifying Proxmox VE setup. The scripts allow users to create Linux containers or virtual machines interactively, with options for both simple and advanced configurations. While the basic setup adheres to default settings, the advanced setup offers extensive customization options for specific needs. | ||
| ## 📦 Features | ||
|
|
||
| All configuration choices are displayed in a dialog box, where users can select their preferences. The script then validates these inputs to generate a final configuration for the container or virtual machine. | ||
| - **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. | ||
|
|
||
| <hr> | ||
|
|
||
| <p align="center"> | ||
| Please exercise caution and thoroughly review scripts and automation tasks from external sources. <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/CODE-AUDIT.md">Read more</a> | ||
| </p> | ||
| ## 🚀 Installation | ||
|
|
||
| To install the Proxmox Helper Scripts, simply follow these steps: | ||
|
|
||
| 1. Open the [Website](https://helper-scripts.com/) | ||
| 2. Search for the desired script, e.g. **"Home Assistant OS VM"**. | ||
| 3. In the **"How To Install"** section, copy the provided **Bash command**. | ||
| 4. Open the Proxmox shell on your **main node**. | ||
| 5. Paste the command into the console and let's start! 🚀 | ||
|
|
||
| For detailed instructions, check out our [official guides](https://github.com/community-scripts/ProxmoxVE/blob/main/USER_SUBMITTED_GUIDES.md). | ||
|
|
||
| --- | ||
|
|
||
| ### Note on the Transition: | ||
| This project is now maintained by the community in memory of tteck’s invaluable contribution. His dedication transformed the Proxmox experience for countless users, and we’re committed to continuing his work with the same dedication. | ||
| ## ❤️ Community and Contributions | ||
|
|
||
| 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. | ||
|
|
||
| ### 💖 Donate to Support the Project | ||
|
|
||
| We offer two donation options to help maintain and grow this project: | ||
|
|
||
| - **Ko-Fi for tteck**: [Donate to tteck](https://ko-fi.com/proxmoxhelperscripts) - All donations will go directly to support tteck’s legacy and help fund ongoing maintenance of the scripts. | ||
| - **Ko-Fi for Community Edition**: [Donate to Community Edition](https://ko-fi.com/community_scripts) - This is a nonprofit organization. All funds will go towards script maintenance, infrastructure, and server costs. Any remaining funds will be donated annually to 2-4 causes (e.g., cancer research, hospice care, etc.). | ||
|
|
||
| Your contributions help keep the project running and support important charitable causes. | ||
|
|
||
| <hr> | ||
|
|
||
| ## 💬 Get Help | ||
|
|
||
| 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](https://discord.gg/UHrpNWGwkH) to chat with other users and get support. | ||
| - **GitHub Discussions**: [Ask questions or report issues](https://github.com/community-scripts/ProxmoxVE/discussions). | ||
|
|
||
| <hr> | ||
|
|
||
| ## 🤝 Found a bug or missing feature? | ||
|
|
||
| If you’ve encountered an issue or identified an area for improvement, please file a new issue on our [GitHub issues page](https://github.com/community-scripts/ProxmoxVE/issues). 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. | ||
|
|
||
| <hr> | ||
|
|
||
| ## ✅ Requirements | ||
|
|
||
| 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. | ||
|
|
||
| <hr> | ||
|
|
||
| ## 📜 License | ||
|
|
||
| This project is licensed under the terms of the [MIT License](LICENSE). | ||
|
|
||
| --- | ||
|
|
||
| <sub><div align="center"> Proxmox® is a registered trademark of Proxmox Server Solutions GmbH. </div></sub> | ||
| ## 📢 Acknowledgments | ||
|
|
||
| A special thank you to [tteck](https://github.com/tteck) for his foundational work, which has allowed the Proxmox community to thrive. We’re dedicated to keeping his vision alive and expanding upon it with the continued support of this vibrant community. | ||
|
|
||
| ## 📢 Acknowledgments | ||
|
|
||
| A special thank you to [tteck](https://github.com/tteck) for his foundational work, which has allowed the Proxmox community to thrive. We’re dedicated to keeping his vision alive and expanding upon it with the continued support of this vibrant community. |