Skip to content

Commit 00b978d

Browse files
MickLeskMickLesk
authored
[docs / gh]: modernize README | Change Version Support in SECURITY.md | Shoutout to selfhst\icons (#9049)
1 parent c054403 commit 00b978d

File tree

2 files changed

+221
-67
lines changed

2 files changed

+221
-67
lines changed

‎README.md‎

Lines changed: 215 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,266 @@
11
<div align="center">
2-
<p align="center">
3-
<a href="#">
4-
<img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo-81x112.png" height="100px" />
5-
</a>
6-
</p>
7-
</div>
2+
<img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo-81x112.png" height="120px" alt="Proxmox VE Helper-Scripts Logo" />
3+
4+
<h1>Proxmox VE Helper-Scripts</h1>
5+
<p><em>A Community Legacy in Memory of @tteck</em></p>
86

9-
<div style="border: 2px solid #d1d5db; padding: 20px; border-radius: 8px; background-color: #f9fafb;">
10-
<h2 align="center">Proxmox VE Helper-Scripts</h2>
11-
<p align="center">A Community Legacy in Memory of @tteck</p>
12-
<p align="center">
7+
<p>
138
<a href="https://helper-scripts.com">
14-
<img src="https://img.shields.io/badge/Website-4c9b3f?style=for-the-badge&logo=github&logoColor=white" alt="Website" />
9+
<img src="https://img.shields.io/badge/🌐_Website-Visit-4c9b3f?style=for-the-badge&labelColor=2d3748" alt="Website" />
1510
</a>
1611
<a href="https://discord.gg/3AnUqsXnmK">
17-
<img src="https://img.shields.io/badge/Discord-7289da?style=for-the-badge&logo=discord&logoColor=white" alt="Discord" />
18-
</a>
12+
<img src="https://img.shields.io/badge/💬_Discord-Join-7289da?style=for-the-badge&labelColor=2d3748" alt="Discord" />
13+
</a>
1914
<a href="https://ko-fi.com/community_scripts">
20-
<img src="https://img.shields.io/badge/Support-FF5F5F?style=for-the-badge&logo=ko-fi&logoColor=white" alt="Donate" />
15+
<img src="https://img.shields.io/badge/❤️_Support-Donate-FF5F5F?style=for-the-badge&labelColor=2d3748" alt="Donate" />
2116
</a>
17+
</p>
18+
19+
<p>
2220
<a href="https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md">
23-
<img src="https://img.shields.io/badge/Contribute-ff4785?style=for-the-badge&logo=git&logoColor=white" alt="Contribute" />
24-
</a>
21+
<img src="https://img.shields.io/badge/🤝_Contribute-Guidelines-ff4785?style=for-the-badge&labelColor=2d3748" alt="Contribute" />
22+
</a>
2523
<a href="https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/USER_SUBMITTED_GUIDES.md">
26-
<img src="https://img.shields.io/badge/Guides-0077b5?style=for-the-badge&logo=read-the-docs&logoColor=white" alt="Guides" />
27-
</a>
24+
<img src="https://img.shields.io/badge/📚_Guides-Read-0077b5?style=for-the-badge&labelColor=2d3748" alt="Guides" />
25+
</a>
2826
<a href="https://github.com/community-scripts/ProxmoxVE/blob/main/CHANGELOG.md">
29-
<img src="https://img.shields.io/badge/Changelog-6c5ce7?style=for-the-badge&logo=git&logoColor=white" alt="Changelog" />
27+
<img src="https://img.shields.io/badge/📋_Changelog-View-6c5ce7?style=for-the-badge&labelColor=2d3748" alt="Changelog" />
3028
</a>
3129
</p>
30+
31+
<br />
32+
33+
> **Simplify your Proxmox VE setup with community-driven automation scripts**
34+
> Originally created by tteck, now maintained and expanded by the community
35+
36+
</div>
37+
38+
<br />
39+
40+
<div align="center">
41+
<sub>🙌 <strong>Shoutout to</strong></sub>
42+
<br />
43+
<br />
44+
<a href="https://selfh.st/">
45+
<img src="https://img.shields.io/badge/selfh.st-Icons_for_Self--Hosted-2563eb?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJNMTIgMkM2LjQ4IDIgMiA2LjQ4IDIgMTJzNC40OCAxMCAxMCAxMCAxMC00LjQ4IDEwLTEwUzE3LjUyIDIgMTIgMnptMCAxOGMtNC40MSAwLTgtMy41OS04LThzMy41OS04IDgtOCA4IDMuNTkgOCA4LTMuNTkgOC04IDh6IiBmaWxsPSJ3aGl0ZSIvPjwvc3ZnPg==&labelColor=1e3a8a" alt="selfh.st Icons" />
46+
</a>
47+
<br />
48+
<sub><a href="https://github.com/selfhst/icons">View on GitHub</a> • Consistent, beautiful icons for 5000+ self-hosted apps</sub>
3249
</div>
3350

3451
---
3552

36-
## 🚀 Project Overview
53+
## 🎯 Key Features
54+
55+
<div align="center">
3756

38-
**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.
57+
<table>
58+
<tr>
59+
<td align="center" width="25%">
60+
<h3>⚡ Quick Setup</h3>
61+
<p>One-command installations for popular services and containers</p>
62+
</td>
63+
<td align="center" width="25%">
64+
<h3>⚙️ Flexible Config</h3>
65+
<p>Simple mode for beginners, advanced options for power users</p>
66+
</td>
67+
<td align="center" width="25%">
68+
<h3>🔄 Auto Updates</h3>
69+
<p>Keep your installations current with built-in update mechanisms</p>
70+
</td>
71+
<td align="center" width="25%">
72+
<h3>🛠️ Easy Management</h3>
73+
<p>Post-install scripts for configuration and troubleshooting</p>
74+
</td>
75+
</tr>
76+
<tr>
77+
<td align="center" width="25%">
78+
<h3>👥 Community Driven</h3>
79+
<p>Actively maintained with contributions from users worldwide</p>
80+
</td>
81+
<td align="center" width="25%">
82+
<h3>📖 Well Documented</h3>
83+
<p>Comprehensive guides and community support</p>
84+
</td>
85+
<td align="center" width="25%">
86+
<h3>🔒 Secure</h3>
87+
<p>Regular security updates and best practices</p>
88+
</td>
89+
<td align="center" width="25%">
90+
<h3>⚡ Performance</h3>
91+
<p>Optimized configurations for best performance</p>
92+
</td>
93+
</tr>
94+
</table>
95+
96+
</div>
3997

4098
---
4199

42-
## 📦 Features
100+
## 📋 Requirements
101+
102+
<div align="center">
43103

44-
- **Interactive Setup**: Choose between simple and advanced options for configuring VMs and LXC containers.
45-
- **Customizable Configurations**: Advanced setup for fine-tuning your environment.
46-
- **Seamless Integration**: Works seamlessly with Proxmox VE for a smooth experience.
47-
- **Community-driven**: Actively maintained and improved by the Proxmox community.
104+
<table>
105+
<tr>
106+
<td align="center" width="33%">
107+
<h3>🖥️ Proxmox VE</h3>
108+
<p>Version 8.4.x or 9.0.x</p>
109+
</td>
110+
<td align="center" width="33%">
111+
<h3>🐧 Operating System</h3>
112+
<p>Debian-based with Proxmox Tools</p>
113+
</td>
114+
<td align="center" width="33%">
115+
<h3>🌐 Network</h3>
116+
<p>Internet connection required</p>
117+
</td>
118+
</tr>
119+
</table>
120+
121+
</div>
48122

49123
---
50-
## ✅ Requirements
51124

52-
Ensure your system meets the following prerequisites:
125+
## 📥 Getting Started
53126

54-
- **Proxmox VE version**: 8.x or higher
55-
- **Linux**: Compatible with most distributions
56-
- **Dependencies**: bash and curl should be installed.
127+
Choose your preferred installation method:
57128

58-
---
129+
### Method 1: One-Click Web Installer
130+
131+
The fastest way to get started:
132+
133+
1. Visit **[helper-scripts.com](https://helper-scripts.com/)** 🌐
134+
2. Search for your desired script (e.g., "Home Assistant", "Docker")
135+
3. Copy the bash command displayed on the script page
136+
4. Open your **Proxmox Shell** and paste the command
137+
5. Press Enter and follow the interactive prompts
138+
139+
### Method 2: PVEScripts-Local
59140

60-
## 🚀 Installation
141+
Install a convenient script manager directly in your Proxmox UI:
61142

62-
To install the Proxmox Helper Scripts, follow these steps:
143+
```bash
144+
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/pve-scripts-local.sh)"
145+
```
63146

64-
1. Visit the [Website](https://helper-scripts.com/).
65-
2. Search for the desired script, e.g., **"Home Assistant OS VM"**.
66-
3. Copy the provided **Bash command** from the **"How To Install"** section.
67-
4. Open the Proxmox shell on your **main node** and paste the command.
68-
5. Press enter to start the installation! 🚀
147+
This adds a menu to your Proxmox interface for easy script access without visiting the website.
148+
149+
📖 **Learn more:** [ProxmoxVE-Local Repository](https://github.com/community-scripts/ProxmoxVE-Local)
69150

70151
---
71152

72-
## ❤️ Community and Contributions
153+
## 💬 Join the Community
154+
155+
<div align="center">
73156

74-
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.
157+
<table>
158+
<tr>
159+
<td align="center" width="33%">
160+
<h3>💬 Discord</h3>
161+
<p>Real-time chat, support, and discussions</p>
162+
<a href="https://discord.gg/3AnUqsXnmK">
163+
<img src="https://img.shields.io/badge/Join-7289da?style=for-the-badge&logo=discord&logoColor=white" alt="Discord" />
164+
</a>
165+
</td>
166+
<td align="center" width="33%">
167+
<h3>💭 Discussions</h3>
168+
<p>Feature requests, Q&A, and ideas</p>
169+
<a href="https://github.com/community-scripts/ProxmoxVE/discussions">
170+
<img src="https://img.shields.io/badge/Discuss-238636?style=for-the-badge&logo=github&logoColor=white" alt="Discussions" />
171+
</a>
172+
</td>
173+
<td align="center" width="33%">
174+
<h3>🐛 Issues</h3>
175+
<p>Bug reports and issue tracking</p>
176+
<a href="https://github.com/community-scripts/ProxmoxVE/issues">
177+
<img src="https://img.shields.io/badge/Report-d73a4a?style=for-the-badge&logo=github&logoColor=white" alt="Issues" />
178+
</a>
179+
</td>
180+
</tr>
181+
</table>
75182

76-
## 💖 Donate to Support the Project
77-
- **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.
183+
</div>
78184

79185
---
80186

81-
## 💬 Get Help
187+
## 🛠️ Contribute
82188

83-
Join our community for support:
189+
<div align="center">
84190

85-
- **Discord**: Join our [Proxmox Helper Scripts Discord server](https://discord.gg/3AnUqsXnmK) for real-time support.
86-
- **GitHub Discussions**: [Ask questions or report issues](https://github.com/community-scripts/ProxmoxVE/discussions).
191+
<table>
192+
<tr>
193+
<td align="center" width="25%">
194+
<h3>💻 Code</h3>
195+
<p>Add new scripts or improve existing ones</p>
196+
</td>
197+
<td align="center" width="25%">
198+
<h3>📝 Documentation</h3>
199+
<p>Write guides, improve READMEs, translate content</p>
200+
</td>
201+
<td align="center" width="25%">
202+
<h3>🧪 Testing</h3>
203+
<p>Test scripts and report compatibility issues</p>
204+
</td>
205+
<td align="center" width="25%">
206+
<h3>💡 Ideas</h3>
207+
<p>Suggest features or workflow improvements</p>
208+
</td>
209+
</tr>
210+
</table>
87211

88-
## 🤝 Report a Bug or Feature Request
212+
</div>
89213

90-
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!
214+
<div align="center">
215+
<br />
216+
217+
👉 Check our **[Contributing Guidelines](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md)** to get started
218+
219+
</div>
91220

92221
---
93222

94-
## ⭐ Star History
223+
## ❤️ Support the Project
224+
225+
This project is maintained by volunteers in memory of tteck. Your support helps us maintain infrastructure, improve documentation, and give back to important causes.
95226

96-
<a href="https://star-history.com/#community-scripts/ProxmoxVE&Date">
97-
<picture>
98-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date&theme=dark" />
99-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" />
100-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" />
101-
</picture>
227+
**🎗️ 30% of all donations go directly to cancer research and hospice care**
228+
229+
<div align="center">
230+
231+
<a href="https://ko-fi.com/community_scripts">
232+
<img src="https://img.shields.io/badge/☕_Buy_us_a_coffee-Support_on_Ko--fi-FF5F5F?style=for-the-badge&labelColor=2d3748" alt="Support on Ko-fi" />
102233
</a>
103234

104-
## 📜 License
235+
<br />
236+
<sub>Every contribution helps keep this project alive and supports meaningful causes</sub>
105237

106-
This project is licensed under the [MIT License](LICENSE).
238+
</div>
107239

108-
</br>
109-
</br>
110-
<p align="center">
111-
<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>
112-
</p>
240+
---
241+
242+
## 📈 Project Growth
113243

244+
<div align="center">
245+
<a href="https://star-history.com/#community-scripts/ProxmoxVE&Date">
246+
<picture>
247+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date&theme=dark" />
248+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" />
249+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" />
250+
</picture>
251+
</a>
252+
</div>
114253

254+
---
255+
256+
## 📜 License
257+
258+
This project is licensed under the **[MIT License](LICENSE)** - feel free to use, modify, and distribute.
259+
260+
---
261+
262+
<div align="center">
263+
<sub>Made with ❤️ by the Proxmox community in memory of tteck</sub>
264+
<br />
265+
<sub><i>Proxmox® is a registered trademark of <a href="https://www.proxmox.com/en/about/company">Proxmox Server Solutions GmbH</a></i></sub>
266+
</div>

‎SECURITY.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ This project currently supports the following versions of Proxmox VE (PVE):
88
| ------- | ------------------ |
99
| 9.0.x | :white_check_mark: |
1010
| 8.4.x | :white_check_mark: |
11-
| 8.3.x | :white_check_mark: |
12-
| 8.2.x | :white_check_mark: |
13-
| 8.1.x | :white_check_mark: |
11+
| 8.3.x | Limited support* ❕ |
12+
| 8.2.x | Limited support* ❕ |
13+
| 8.1.x | Limited support* ❕ |
1414
| 8.0.x | Limited support* ❕ |
1515
| < 8.0 | :x: |
1616

17-
*Version 8.0.x has limited support. Security updates may not be provided for all issues affecting this version.
17+
*Version 8.0.x - 8.3.x has limited support. Security updates may not be provided for all issues affecting this version.
18+
19+
*Debian 13 Containers may fail to install. You can write var_version=12 before the bash call.
1820

1921
---
2022

0 commit comments

Comments
 (0)