From 53cdb515a42093314fc2a3ae3fdfdb9fa2132f27 Mon Sep 17 00:00:00 2001
From: CanbiZ <47820557+MickLesk@users.noreply.github.com>
Date: Tue, 12 Nov 2024 16:54:39 +0100
Subject: [PATCH 1/6] [Core]: Change build.func to new design (#189)
* Redesign LXC Description
* Update build.func
* Update README.md
---
README.md | 124 +++++++++++++++++++++++++++++++++++++-----------
misc/build.func | 37 +++++++++++++--
2 files changed, 130 insertions(+), 31 deletions(-)
diff --git a/README.md b/README.md
index 6e45c85e..c34b665d 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,116 @@
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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
----
-
-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 and let's start! 🚀
+
+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
+
+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.
+
+
+
+## 💬 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.
+
+## 📢 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.
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 "![](https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo-81x112.png)
- # ${APP} LXC
+ # Generate LXC Description
+ DESCRIPTION=$(cat <
+
+
+
+
+ ${APP} LXC
+
+
+
+
+
+
+
+
+
+ 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
From bdb9d0ce51f3b305a585aeffd773e848739146be Mon Sep 17 00:00:00 2001
From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com>
Date: Tue, 12 Nov 2024 17:34:21 +0100
Subject: [PATCH 2/6] Fixing missing information on the new Homepage (#191)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* Update mariadb.json
* Update vaultwarden.json
* Update vaultwarden.json
* Update keycloak.json
* Update json/keycloak.json
Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com>
* Update mariadb.json
Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com>
---------
Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com>
Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com>
---
json/keycloak.json | 8 ++++++--
json/mariadb.json | 11 ++++++++---
json/vaultwarden.json | 6 +++++-
3 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/json/keycloak.json b/json/keycloak.json
index b61fb7b3..e28d3d54 100644
--- a/json/keycloak.json
+++ b/json/keycloak.json
@@ -9,7 +9,7 @@
"updateable": false,
"privileged": false,
"interface_port": "8080",
- "documentation": null,
+ "documentation": "https://github.com/community-scripts/ProxmoxVE/discussions/193",
"website": "https://www.keycloak.org/",
"logo": "https://www.keycloak.org/resources/images/logo.svg",
"description": "Keycloak is an open-source identity and access management solution that provides centralized authentication and authorization for modern applications and services. It enables organizations to secure their applications and services with a single sign-on (SSO) solution, reducing the need for users to remember multiple login credentials. Keycloak supports various authentication protocols, including SAML, OAuth, and OpenID Connect, and integrates with a wide range of applications and services. With Keycloak, administrators can manage user identities, define security policies, and monitor access to their applications and services. The software is designed to be scalable, flexible, and easy to use, making it a valuable tool for enhancing the security and usability of modern applications and services.",
@@ -34,6 +34,10 @@
{
"text": "First start can take a few minutes",
"type": "warning"
+ },
+ {
+ "text": "This script requires some extra steps after the installation, Please checkout the 'documentation'",
+ "type": "info"
}
]
-}
\ No newline at end of file
+}
diff --git a/json/mariadb.json b/json/mariadb.json
index 1129d082..3dfc1009 100644
--- a/json/mariadb.json
+++ b/json/mariadb.json
@@ -9,7 +9,7 @@
"updateable": false,
"privileged": false,
"interface_port": "3306",
- "documentation": null,
+ "documentation": "https://github.com/community-scripts/ProxmoxVE/discussions/192",
"website": "https://mariadb.org/",
"logo": "https://raw.githubusercontent.com/loganmarchione/homelab-svg-assets/main/assets/mariadb.svg",
"description": "MariaDB is a fork of the popular MySQL database management system that is developed and maintained by the open-source community. It is also commercially supported, offering enterprise-level features and support for organizations that require them. MariaDB aims to maintain high compatibility with MySQL, ensuring a drop-in replacement capability.",
@@ -30,5 +30,10 @@
"username": null,
"password": null
},
- "notes": []
-}
\ No newline at end of file
+ "notes": [
+ {
+ "text": "This script requires some extra steps after the installation, Please checkout the 'documentation'",
+ "type": "info"
+ }
+ ]
+}
diff --git a/json/vaultwarden.json b/json/vaultwarden.json
index a05336e9..d5d5c66e 100644
--- a/json/vaultwarden.json
+++ b/json/vaultwarden.json
@@ -45,6 +45,10 @@
{
"text": "Vaultwarden needs to be behind a proxy (Nginx Proxy Manager) to obtain HTTPS and to allow clients to connect.",
"type": "warning"
+ },
+ {
+ "text": "Build Settings for normal LXC: 4GB RAM - 6GB Storage - 4vCPU",
+ "type": "info"
}
]
-}
\ No newline at end of file
+}
From ab240646f50c8f17b5927a4337e4638e4b2dce2d Mon Sep 17 00:00:00 2001
From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com>
Date: Tue, 12 Nov 2024 19:09:48 +0100
Subject: [PATCH 3/6] Fixing missing information on the new Homepage (#191)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* Update mariadb.json
* Update vaultwarden.json
* Update vaultwarden.json
* Update keycloak.json
* Update json/keycloak.json
Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com>
* Update mariadb.json
Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com>
---------
Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com>
Co-authored-by: Håvard Gjøby Thom <34199185+havardthom@users.noreply.github.com>
From 8f2e917b72d46d916057f576e698c607c73bf2f6 Mon Sep 17 00:00:00 2001
From: Rafael Rivera
Date: Tue, 12 Nov 2024 12:48:18 -0800
Subject: [PATCH 4/6] Remove duplicate acknowledgements from README (#199)
---
README.md | 4 ----
1 file changed, 4 deletions(-)
diff --git a/README.md b/README.md
index c34b665d..bc60a181 100644
--- a/README.md
+++ b/README.md
@@ -110,7 +110,3 @@ 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.
-
-## 📢 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.
From 1633cddf55c0efbb60c825072cc8509afffbc065 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?H=C3=A5vard=20Gj=C3=B8by=20Thom?=
<34199185+havardthom@users.noreply.github.com>
Date: Wed, 13 Nov 2024 01:32:27 +0100
Subject: [PATCH 5/6] Add website issue template (#200)
---
.../{bug_report.yaml => script-issue.yaml} | 2 +-
.github/ISSUE_TEMPLATE/website-issue.yaml | 45 +++++++++++++++++++
2 files changed, 46 insertions(+), 1 deletion(-)
rename .github/ISSUE_TEMPLATE/{bug_report.yaml => script-issue.yaml} (98%)
create mode 100644 .github/ISSUE_TEMPLATE/website-issue.yaml
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
+
+
From 7e948d349c328ba6d8551a0c107768e193586627 Mon Sep 17 00:00:00 2001
From: Paul
Date: Wed, 13 Nov 2024 22:08:11 +1300
Subject: [PATCH 6/6] Suggested wording and improvements to README (#209)
* Proposed rewording
* Fixed typo in donations
---
README.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index bc60a181..16100226 100644
--- a/README.md
+++ b/README.md
@@ -55,7 +55,7 @@ To install the Proxmox Helper Scripts, simply follow these steps:
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! 🚀
+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).
@@ -63,16 +63,14 @@ For detailed instructions, check out our [official guides](https://github.com/co
## ❤️ 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.
+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
+### 💖 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’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.
+- **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.
@@ -110,3 +108,5 @@ 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