diff --git a/README.md b/README.md index bb1303ae7..b62004160 100644 --- a/README.md +++ b/README.md @@ -1,114 +1,266 @@
-

- - - -

-
+ Proxmox VE Helper-Scripts Logo + +

Proxmox VE Helper-Scripts

+

A Community Legacy in Memory of @tteck

-
-

Proxmox VE Helper-Scripts

-

A Community Legacy in Memory of @tteck

-

+

- Website + Website - Discord - - - Donate + Discord - - Contribute - - - Guides - - - Changelog + + Donate

+ +

+ + Contribute + + + Guides + + + Changelog + +

+ +
+ + > **Simplify your Proxmox VE setup with community-driven automation scripts** + > Originally created by tteck, now maintained and expanded by the community + +
+ +
+ +
+ ๐Ÿ™Œ Shoutout to +
+
+ + selfh.st Icons + +
+ View on GitHub โ€ข Consistent, beautiful icons for 5000+ self-hosted apps
--- -## ๐Ÿš€ Project Overview +## ๐ŸŽฏ Key Features -**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. +
+ + + + + + + + + + + + + + +
+

โšก Quick Setup

+

One-command installations for popular services and containers

+
+

โš™๏ธ Flexible Config

+

Simple mode for beginners, advanced options for power users

+
+

๐Ÿ”„ Auto Updates

+

Keep your installations current with built-in update mechanisms

+
+

๐Ÿ› ๏ธ Easy Management

+

Post-install scripts for configuration and troubleshooting

+
+

๐Ÿ‘ฅ Community Driven

+

Actively maintained with contributions from users worldwide

+
+

๐Ÿ“– Well Documented

+

Comprehensive guides and community support

+
+

๐Ÿ”’ Secure

+

Regular security updates and best practices

+
+

โšก Performance

+

Optimized configurations for best performance

+
+ +
--- -## ๐Ÿ“ฆ Features +## ๐Ÿ“‹ Requirements -- **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. +
---- -## โœ… Requirements + + + + + + +
+

๐Ÿ–ฅ๏ธ Proxmox VE

+

Version 8.4.x or 9.0.x

+
+

๐Ÿง Operating System

+

Debian-based with Proxmox Tools

+
+

๐ŸŒ Network

+

Internet connection required

+
-Ensure your system meets the following prerequisites: - -- **Proxmox VE version**: 8.x or higher -- **Linux**: Compatible with most distributions -- **Dependencies**: bash and curl should be installed. +
--- -## ๐Ÿš€ Installation +## ๐Ÿ“ฅ Getting Started -To install the Proxmox Helper Scripts, follow these steps: +Choose your preferred installation method: -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! ๐Ÿš€ +### Method 1: One-Click Web Installer + +The fastest way to get started: + +1. Visit **[helper-scripts.com](https://helper-scripts.com/)** ๐ŸŒ +2. Search for your desired script (e.g., "Home Assistant", "Docker") +3. Copy the bash command displayed on the script page +4. Open your **Proxmox Shell** and paste the command +5. Press Enter and follow the interactive prompts + +### Method 2: PVEScripts-Local + +Install a convenient script manager directly in your Proxmox UI: + +```bash +bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/pve-scripts-local.sh)" +``` + +This adds a menu to your Proxmox interface for easy script access without visiting the website. + +๐Ÿ“– **Learn more:** [ProxmoxVE-Local Repository](https://github.com/community-scripts/ProxmoxVE-Local) --- -## โค๏ธ Community and Contributions +## ๐Ÿ’ฌ Join the Community -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. +
-## ๐Ÿ’– 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. + + + + + + +
+

๐Ÿ’ฌ Discord

+

Real-time chat, support, and discussions

+ + Discord + +
+

๐Ÿ’ญ Discussions

+

Feature requests, Q&A, and ideas

+ + Discussions + +
+

๐Ÿ› Issues

+

Bug reports and issue tracking

+ + Issues + +
+ +
--- -## ๐Ÿ’ฌ Get Help +## ๐Ÿ› ๏ธ Contribute -Join our community for support: +
-- **Discord**: Join our [Proxmox Helper Scripts Discord server](https://discord.gg/3AnUqsXnmK) for real-time support. -- **GitHub Discussions**: [Ask questions or report issues](https://github.com/community-scripts/ProxmoxVE/discussions). + + + + + + + +
+

๐Ÿ’ป Code

+

Add new scripts or improve existing ones

+
+

๐Ÿ“ Documentation

+

Write guides, improve READMEs, translate content

+
+

๐Ÿงช Testing

+

Test scripts and report compatibility issues

+
+

๐Ÿ’ก Ideas

+

Suggest features or workflow improvements

+
-## ๐Ÿค Report a Bug or Feature Request +
-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! +
+
+ + ๐Ÿ‘‰ Check our **[Contributing Guidelines](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md)** to get started + +
--- -## โญ Star History +## โค๏ธ Support the Project - - - - - Star History Chart - +This project is maintained by volunteers in memory of tteck. Your support helps us maintain infrastructure, improve documentation, and give back to important causes. + +**๐ŸŽ—๏ธ 30% of all donations go directly to cancer research and hospice care** + +
+ + + Support on Ko-fi +
+Every contribution helps keep this project alive and supports meaningful causes + +
+ +--- + +## ๐Ÿ“ˆ Project Growth + +
+ + + + + Star History Chart + + +
+ +--- + ## ๐Ÿ“œ License -This project is licensed under the [MIT License](LICENSE). - -
-
-

- Proxmoxยฎ is a registered trademark of Proxmox Server Solutions GmbH. -

+This project is licensed under the **[MIT License](LICENSE)** - feel free to use, modify, and distribute. +--- +
+ Made with โค๏ธ by the Proxmox community in memory of tteck +
+ Proxmoxยฎ is a registered trademark of Proxmox Server Solutions GmbH +
diff --git a/SECURITY.md b/SECURITY.md index 7d7db9f43..20c0492af 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -8,13 +8,15 @@ This project currently supports the following versions of Proxmox VE (PVE): | ------- | ------------------ | | 9.0.x | :white_check_mark: | | 8.4.x | :white_check_mark: | -| 8.3.x | :white_check_mark: | -| 8.2.x | :white_check_mark: | -| 8.1.x | :white_check_mark: | +| 8.3.x | Limited support* โ• | +| 8.2.x | Limited support* โ• | +| 8.1.x | Limited support* โ• | | 8.0.x | Limited support* โ• | | < 8.0 | :x: | -*Version 8.0.x has limited support. Security updates may not be provided for all issues affecting this version. +*Version 8.0.x - 8.3.x has limited support. Security updates may not be provided for all issues affecting this version. + +*Debian 13 Containers may fail to install. You can write var_version=12 before the bash call. ---