-
-
-
- **Simplify your Proxmox VE setup with community-driven automation scripts**
- Originally created by tteck, now maintained and expanded by the community
-
-
-
-
-
-
- ๐ Shoutout to
-
-
-
-
-
-
- View on GitHub โข Consistent, beautiful icons for 5000+ self-hosted apps
---
-## ๐ฏ Key Features
+## What is this?
-
+Proxmox VE Helper-Scripts lets you install and configure popular self-hosted services on Proxmox VE with a single command. No manual package hunting, no config file archaeology โ paste a command into your Proxmox shell, answer a few prompts, and your container or VM is up and running.
-
-
-
-
โก 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
-
-
-
-
-
+The project started as [@tteck](https://github.com/tteck)'s personal toolkit and has since grown into a community-maintained collection covering hundreds of services: home automation, media servers, networking tools, databases, monitoring stacks, and more.
---
-## ๐ Requirements
+## Requirements
-
-
-
-
-
-
๐ฅ๏ธ Proxmox VE
-
Version: 8.4.x | 9.0.x | 9.1.x
-
-
-
๐ง Operating System
-
Debian-based with Proxmox Tools
-
-
-
๐ Network
-
Internet connection required
-
-
-
-
-
+| Component | Details |
+|---|---|
+| **Proxmox VE** | Version 8.4, 9.0, or 9.1 |
+| **Host OS** | Debian-based with Proxmox tools installed |
+| **Access** | Root shell access on the Proxmox host |
+| **Network** | Internet connection required during installation |
---
-## ๐ฅ Getting Started
+## Getting Started
-Choose your preferred installation method:
+### Option 1 โ Browse the website (recommended)
-### Method 1: One-Click Web Installer
+The fastest way to find and run scripts:
-The fastest way to get started:
+1. Go to **[community-scripts.org](https://community-scripts.org)**
+2. Search for the service you want (e.g. "Home Assistant", "Nginx Proxy Manager", "Jellyfin")
+3. Copy the one-line command from the script page
+4. Open your **Proxmox Shell** and paste it
+5. Choose between **Default** or **Advanced** setup and follow the prompts
-1. Visit **[community-scripts.org](https://community-scripts.org/)** ๐
-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
+Each script page also documents what the container includes, default resource allocation, and post-install notes.
-### Method 2: PVEScripts-Local
+### Option 2 โ Script manager in your Proxmox UI
-Install a convenient script manager directly in your Proxmox UI:
+Install a local menu that lets you browse and run scripts without leaving the Proxmox interface:
```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)
+Once installed, a **Helper-Scripts** menu appears in your Proxmox UI sidebar. See [ProxmoxVE-Local](https://github.com/community-scripts/ProxmoxVE-Local) for more details.
---
-## ๐ฌ Join the Community
+## How Scripts Work
-
+**Default mode** โ Picks sensible resource defaults (CPU, RAM, storage) and asks only the minimum required questions. Most installs finish in under five minutes.
-
+**Advanced mode** โ Gives you full control over container settings, networking, storage backends, and application-level configuration before anything is installed.
+
+After installation, each container ships with a **post-install helper** accessible from the Proxmox shell. It handles common tasks like:
+
+- Applying updates to the installed service
+- Changing application settings without manually editing config files
+- Basic troubleshooting and log access
---
-## ๐ ๏ธ Contribute
+## What's Included
-
+The repository covers a wide range of categories. A few examples:
-
-
-
- ๐ Check our **[Contributing Guidelines](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/README.md)** to get started
-
-
+> Browse the full list at **[community-scripts.org](https://community-scripts.org)** โ new scripts are added regularly.
---
-## โค๏ธ Support the Project
+## Contributing
-This project is maintained by volunteers in memory of tteck. Your support helps us maintain infrastructure, improve documentation, and give back to important causes.
+This project runs on community contributions. Whether you want to write new scripts, improve existing ones, or just report a bug โ every bit helps.
-**๐๏ธ 30% of all donations go directly to cancer research and hospice care**
+### Where to start
-
+| I want toโฆ | Go here |
+|---|---|
+| Add a new script or improve an existing one | [Contributing Guidelines](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/README.md) |
+| Test scripts before they hit production | [ProxmoxVED (dev repo)](https://github.com/community-scripts/ProxmoxVED) |
+| Report a bug or broken script | [Issues](https://github.com/community-scripts/ProxmoxVE/issues) |
+| Request a new script or feature | [Discussions](https://github.com/community-scripts/ProxmoxVE/discussions) |
+| Get help or chat with other users | [Discord](https://discord.gg/3AnUqsXnmK) |
-
-
-
+### Before you open a PR
-
-Every contribution helps keep this project alive and supports meaningful causes
-
-
+- Read the [Contributing Guidelines](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/README.md) โ they cover script structure, variable naming, required metadata, and how the review process works.
+- Test your changes in [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) first. PRs against the main repo without prior testing in VED are unlikely to be merged quickly.
+- Keep scripts focused. One script, one service.
+- Document what your script installs and any non-obvious decisions in the corresponding JSON metadata file.
---
-## ๐ Project Statistics
+## Project Activity
+
---
-## ๐ License
+## Support the Project
-This project is licensed under the **[MIT License](LICENSE)** - feel free to use, modify, and distribute.
+This project is maintained by volunteers. All infrastructure costs come out of pocket, and the work is done in people's spare time.
+
+**30% of all donations are forwarded directly to cancer research and hospice care** โ a cause that was important to tteck.
+
+
+
+---
+
+## License
+
+[MIT](LICENSE) โ free to use, modify, and distribute.
---
- Made with โค๏ธ by the Proxmox community in memory of tteck
-
+ Maintained by the Proxmox community ยท In memory of tteck Proxmoxยฎ is a registered trademark of Proxmox Server Solutions GmbH
-
+ 
-
- 
-
- 
-
- 
-
- 
-
+### Before you open a PR
-
+
+
- 
- 
- 
- 
- 
-