diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/script-issue.yaml similarity index 98% rename from .github/ISSUE_TEMPLATE/bug_report.yaml rename to .github/ISSUE_TEMPLATE/script-issue.yaml index bed10433..b8e83878 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/script-issue.yaml @@ -1,4 +1,4 @@ -name: Problems with a script. +name: Problems with a script description: Generate a report on an issue pertaining specifically to a script. For other inquires please share them in the Discussions section. body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/website-issue.yaml b/.github/ISSUE_TEMPLATE/website-issue.yaml new file mode 100644 index 00000000..abfa19f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/website-issue.yaml @@ -0,0 +1,45 @@ +name: Problems with the website +description: Generate a report on an issue pertaining specifically to the website (https://community-scripts.github.io/ProxmoxVE/). For other inquires please share them in the Discussions section. +labels: ["website"] +body: + - type: markdown + attributes: + value: | + **IMPORTANT:** Failure to comply with the following guidelines may result in immediate closure. + - Prior to submitting, kindly search the closed issues to check if the problem you are reporting has already been addressed and resolved. If you come across a closed issue that pertains to your problem, please leave a comment on that issue instead of creating a new one. + - For suggestions, questions or feature/script requests, please share them in the [Discussions section.](https://github.com/community-scripts/ProxmoxVE/discussions) + - type: input + id: guidelines + attributes: + label: Please verify that you have read and understood the guidelines. + placeholder: 'yes' + validations: + required: true + - type: textarea + id: bug + attributes: + label: A clear and concise description of the issue. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Please provide a description of the expected behavior. + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: If relevant, including screenshots or a code block can be helpful in clarifying the issue. + placeholder: Code blocks begin and conclude by enclosing the code with three backticks (```) above and below it. + validations: + required: false + - type: textarea + id: reproduce + attributes: + label: Please provide detailed steps to reproduce the issue. + placeholder: First do this, then this ... + validations: + required: false + + diff --git a/README.md b/README.md index 6e45c85e..16100226 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,112 @@
- - - +

+ + + +

Proxmox VE Helper-Scripts: A Community Legacy

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, 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.

-

To tteck: Your impact will be felt in this community for years to come. We thank you for everything.

-

Warm regards,
The Community

-
- ----

- Website | - Ko-Fi (for tteck🙏) | - Contribute | - Guides | - Discord | - Changelog + + Website + + + Contribute + + + Guides + + + Discord + + + Changelog +

---- - -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. - -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. -
-

-Please exercise caution and thoroughly review scripts and automation tasks from external sources. Read more -

+## 🚀  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. --- -### 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. +## 📦  Features + +- **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. + +
+ +## 🚀  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, hit enter, and you are away! 🚀 + +For detailed instructions, check out our [official guides](https://github.com/community-scripts/ProxmoxVE/blob/main/USER_SUBMITTED_GUIDES.md). --- -
Proxmox® is a registered trademark of Proxmox Server Solutions GmbH.
+## ❤️  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 (DRAFT) + +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, the founder of this project. +- **Ko-Fi for Community Edition**: [Donate to this project](https://ko-fi.com/community_scripts) - 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. + +
+ +## 💬  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). + +
+ +## 🤝  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. + +
+ +## ✅  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. + +
+ +## 📜  License + +This project is licensed under the terms of the [MIT License](LICENSE). + +--- + +## 📢  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. + +Proxmox® is a registered trademark of [Proxmox Server Solutions GmbH](https://www.proxmox.com/en/about/company). \ No newline at end of file diff --git a/misc/build.func b/misc/build.func index ea73f0b4..85613136 100644 --- a/misc/build.func +++ b/misc/build.func @@ -640,12 +640,41 @@ EOF' # This function sets the description of the container. description() { IP=$(pct exec "$CTID" ip a s dev eth0 | awk '/inet / {print $2}' | cut -d/ -f1) - pct set "$CTID" -description "
- # ${APP} LXC + # Generate LXC Description + DESCRIPTION=$(cat < + + Logo + + +

${APP} LXC

+ +

+ + spend Coffee + +

+ + + + GitHub + + + + Discussions + + + + Issues + +
+EOF +) + + # Set Description in LXC + pct set "$CTID" -description "$DESCRIPTION" - - " if [[ -f /etc/systemd/system/ping-instances.service ]]; then systemctl start ping-instances.service fi