First Look Readme

2026-05-05 08:25:59 +00:00 · 2026-04-15 13:11:39 +02:00
parent 750d54f0e5
commit b4a21b6f88
1 changed files with 92 additions and 209 deletions
@@ -1,283 +1,166 @@
 <div align="center">
-  <img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo-81x112.png" height="120px" alt="Proxmox VE Helper-Scripts Logo" />
-  
+  <img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo-81x112.png" height="112px" alt="Proxmox VE Helper-Scripts Logo" />
+
  <h1>Proxmox VE Helper-Scripts</h1>
-  <p><em>A Community Legacy in Memory of @tteck</em></p>
+  <p><strong>One-command installations for services, containers, and VMs on Proxmox VE</strong><br/>
+  A community project — built on the foundation of <a href="https://github.com/tteck">@tteck</a>'s original work</p>

  <p>
-    <a href="https://community-scripts.org">
-      <img src="https://img.shields.io/badge/🌐_Website-Visit-4c9b3f?style=for-the-badge&labelColor=2d3748" alt="Website" />
-    </a>
-    <a href="https://discord.gg/3AnUqsXnmK">
-      <img src="https://img.shields.io/badge/💬_Discord-Join-7289da?style=for-the-badge&labelColor=2d3748" alt="Discord" />
-    </a>
-    <a href="https://ko-fi.com/community_scripts">
-      <img src="https://img.shields.io/badge/❤️_Support-Donate-FF5F5F?style=for-the-badge&labelColor=2d3748" alt="Donate" />
-    </a>
+    <a href="https://community-scripts.org"><img src="https://img.shields.io/badge/Website-community--scripts.org-4c9b3f?style=flat-square" /></a>
+    <a href="https://discord.gg/3AnUqsXnmK"><img src="https://img.shields.io/discord/1126788645370785873?label=Discord&logo=discord&style=flat-square&color=7289da" /></a>
+    <a href="https://github.com/community-scripts/ProxmoxVE/stargazers"><img src="https://img.shields.io/github/stars/community-scripts/ProxmoxVE?style=flat-square&color=f5a623" /></a>
+    <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/Changelog-view-6c5ce7?style=flat-square" /></a>
+    <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=flat-square" /></a>
  </p>
-
-  <p>
-    <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/README.md">
-      <img src="https://img.shields.io/badge/🤝_Contribute-Guidelines-ff4785?style=for-the-badge&labelColor=2d3748" alt="Contribute" />
-    </a>
-    <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/USER_SUBMITTED_GUIDES.md">
-      <img src="https://img.shields.io/badge/📚_Guides-Read-0077b5?style=for-the-badge&labelColor=2d3748" alt="Guides" />
-    </a>
-    <a href="https://github.com/community-scripts/ProxmoxVE/blob/main/CHANGELOG.md">
-      <img src="https://img.shields.io/badge/📋_Changelog-View-6c5ce7?style=for-the-badge&labelColor=2d3748" alt="Changelog" />
-    </a>
-  </p>
-
-  <br />
-
- **Simplify your Proxmox VE setup with community-driven automation scripts**  
- Originally created by tteck, now maintained and expanded by the community
-
-</div>
-
-<br />
-
-<div align="center">
-  <sub>🙌 <strong>Shoutout to</strong></sub>
-  <br />
-  <br />
-  <a href="https://selfh.st/">
-    <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" />
-  </a>
-  <br />
-  <sub><a href="https://github.com/selfhst/icons">View on GitHub</a> • Consistent, beautiful icons for 5000+ self-hosted apps</sub>
 </div>

 ---

-## 🎯 Key Features
+## What is this?

-<div align="center">
+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.

-<table>
-  <tr>
-    <td align="center" width="25%">
-      <h3>⚡ Quick Setup</h3>
-      <p>One-command installations for popular services and containers</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>⚙️ Flexible Config</h3>
-      <p>Simple mode for beginners, advanced options for power users</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>🔄 Auto Updates</h3>
-      <p>Keep your installations current with built-in update mechanisms</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>🛠️ Easy Management</h3>
-      <p>Post-install scripts for configuration and troubleshooting</p>
-    </td>
-  </tr>
-  <tr>
-    <td align="center" width="25%">
-      <h3>👥 Community Driven</h3>
-      <p>Actively maintained with contributions from users worldwide</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>📖 Well Documented</h3>
-      <p>Comprehensive guides and community support</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>🔒 Secure</h3>
-      <p>Regular security updates and best practices</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>⚡ Performance</h3>
-      <p>Optimized configurations for best performance</p>
-    </td>
-  </tr>
-</table>
-
-</div>
+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

-<div align="center">
-
-<table>
-  <tr>
-    <td align="center" width="33%">
-      <h3>🖥️ Proxmox VE</h3>
-      <p>Version: 8.4.x | 9.0.x | 9.1.x</p>
-    </td>
-    <td align="center" width="33%">
-      <h3>🐧 Operating System</h3>
-      <p>Debian-based with Proxmox Tools</p>
-    </td>
-    <td align="center" width="33%">
-      <h3>🌐 Network</h3>
-      <p>Internet connection required</p>
-    </td>
-  </tr>
-</table>
-
-</div>
+| 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

-<div align="center">
+Every script follows the same pattern:

-<table>
-  <tr>
-    <td align="center" width="33%">
-      <h3>💬 Discord</h3>
-      <p>Real-time chat, support, and discussions</p>
-      <a href="https://discord.gg/3AnUqsXnmK">
-        <img src="https://img.shields.io/badge/Join-7289da?style=for-the-badge&logo=discord&logoColor=white" alt="Discord" />
-      </a>
-    </td>
-    <td align="center" width="33%">
-      <h3>💭 Discussions</h3>
-      <p>Feature requests, Q&A, and ideas</p>
-      <a href="https://github.com/community-scripts/ProxmoxVE/discussions">
-        <img src="https://img.shields.io/badge/Discuss-238636?style=for-the-badge&logo=github&logoColor=white" alt="Discussions" />
-      </a>
-    </td>
-    <td align="center" width="33%">
-      <h3>🐛 Issues</h3>
-      <p>Bug reports and issue tracking</p>
-      <a href="https://github.com/community-scripts/ProxmoxVE/issues">
-        <img src="https://img.shields.io/badge/Report-d73a4a?style=for-the-badge&logo=github&logoColor=white" alt="Issues" />
-      </a>
-    </td>
-  </tr>
-</table>
+**Default mode** — Picks sensible resource defaults (CPU, RAM, storage) and asks only the minimum required questions. Most installs finish in under five minutes.

-</div>
+**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

-<div align="center">
+The repository covers a wide range of categories. A few examples:

-<table>
-  <tr>
-    <td align="center" width="25%">
-      <h3>💻 Code</h3>
-      <p>Add new scripts or improve existing ones</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>📝 Documentation</h3>
-      <p>Write guides, improve READMEs, translate content</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>🧪 Testing</h3>
-      <p>Test scripts and report compatibility issues</p>
-    </td>
-    <td align="center" width="25%">
-      <h3>💡 Ideas</h3>
-      <p>Suggest features or workflow improvements</p>
-    </td>
-  </tr>
-</table>
+| Category | Examples |
+|---|---|
+| Home Automation | Home Assistant, Zigbee2MQTT, ESPHome, Node-RED |
+| Media | Jellyfin, Plex, Radarr, Sonarr, Immich |
+| Networking | AdGuard Home, Nginx Proxy Manager, Pi-hole, Traefik |
+| Monitoring | Grafana, Prometheus, Uptime Kuma, Netdata |
+| Databases | PostgreSQL, MariaDB, Redis, InfluxDB |
+| Security | Vaultwarden, CrowdSec, Authentik |
+| Dev & Tools | Gitea, Portainer, VS Code Server, n8n |

-</div>
-
-<div align="center">
-  <br />
-  
-  👉 Check our **[Contributing Guidelines](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/README.md)** to get started
-  
-</div>
+> 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

-<div align="center">
+| 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) |

-<a href="https://ko-fi.com/community_scripts">
-  <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" />
-</a>
+### Before you open a PR

-<br />
-<sub>Every contribution helps keep this project alive and supports meaningful causes</sub>
-
-</div>
+- 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
+
 <p align="center">
  <img
    src="https://repobeats.axiom.co/api/embed/57edde03e00f88d739bdb5b844ff7d07dd079375.svg"
-    alt="Repobeats analytics"
-    width="650"
+    alt="Repository activity"
+    width="700"
  />
 </p>

 <p align="center">
  <a href="https://star-history.com/#community-scripts/ProxmoxVE&Date">
    <picture>
-      <source
-        media="(prefers-color-scheme: dark)"
-        srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date&theme=dark"
-      />
-      <source
-        media="(prefers-color-scheme: light)"
-        srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date"
-      />
-      <img
-        alt="Star History Chart"
-        src="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date"
-        width="650"
-      />
+      <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date&theme=dark" />
+      <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" />
+      <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" width="700" />
    </picture>
  </a>
 </p>

 ---

-## 📜 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.
+
+<div align="center">
+  <a href="https://ko-fi.com/community_scripts">
+    <img src="https://img.shields.io/badge/Support_on_Ko--fi-FF5F5F?style=for-the-badge&logo=ko-fi&logoColor=white" alt="Ko-fi" />
+  </a>
+</div>
+
+---
+
+## License
+
+[MIT](LICENSE) — free to use, modify, and distribute.

 ---

 <div align="center">
-  <sub>Made with ❤️ by the Proxmox community in memory of tteck</sub>
-  <br />
+  <sub>Maintained by the Proxmox community · In memory of <a href="https://github.com/tteck">tteck</a></sub><br/>
  <sub><i>Proxmox® is a registered trademark of <a href="https://www.proxmox.com/en/about/company">Proxmox Server Solutions GmbH</a></i></sub>
 </div>