@@ -18,94 +19,147 @@
## What is this?
-**Simplify your Proxmox VE setup with community-driven automation scripts.**
+**The canonical application scripts.** More than 700 of them, covering home
+automation, media, networking, databases, monitoring, security and developer
+tooling. Paste one command into your Proxmox shell and the container or VM is
+built, configured and running.
-Install and configure popular self-hosted services 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.
+A script only describes *what* to install. Creating the container, asking the
+questions and handling the errors is the job of the shared engine in
+[core](https://github.com/community-scripts/core), which every script loads at
+start-up. The same scripts run unchanged on an Incus host through
+[the Incus repository](https://github.com/community-scripts/Incus).
-The collection covers hundreds of services across categories like home automation, media servers, networking tools, databases, monitoring stacks, and more.
+Ready-made commands for every application are on
+[community-scripts.org](https://community-scripts.org).
+
+---
+
+## Getting started
+
+1. Go to **[community-scripts.org](https://community-scripts.org)**
+2. Search for the service you want — Home Assistant, Nginx Proxy Manager, Jellyfin
+3. Copy the one-line install command from the script page
+4. Open your **Proxmox shell** and paste it
+5. Choose **Default** or **Advanced** and follow the prompts
+
+Each script page lists what the container includes, the default resources and
+the post-install notes.
+
+> These commands run as root on your host. Every script is readable in this
+> repository, and each script page links to its source — read it before you
+> paste it, as you would with any installer.
+
+---
+
+## How scripts work
+
+**Default** picks sensible resources and asks only what it has to. Most installs
+finish in a few minutes.
+
+**Advanced** hands you container settings, networking, storage backend and
+application options before anything is created.
+
+Every container gets an `update` command. Type it in the container console:
+
+```bash
+update
+```
+
+It updates the installed application and reaches settings that would otherwise
+mean editing config files by hand. VM scripts have no built-in updater — use the
+guest's own package manager.
---
## Requirements
-| Component | Details |
-| -------------- | ------------------------------------------------ |
-| **Proxmox VE** | Version 8.4, 9.0, 9.1, or 9.2 |
-| **Host OS** | Proxmox VE (Debian-based) |
-| **Access** | Root shell access on the Proxmox host |
-| **Network** | Internet connection required during installation |
+| Component | Details |
+| --------- | ------- |
+| **Proxmox VE** | 8.0 – 8.4, or 9.0 – 9.2 |
+| **Access** | Root shell on the Proxmox host |
+| **Network** | Internet access during installation |
+
+Virtual machine scripts need the same versions as containers.
---
-## Getting Started
+## Repository map
-The fastest way to find and run scripts:
-
-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 install command from the script page
-4. Open your **Proxmox Shell** and paste it
-5. Choose between **Default** or **Advanced** setup and follow the prompts
-
-Each script page documents what the container includes, default resource allocation, and post-install notes.
+| Repository | Contains |
+| ---------- | -------- |
+| [core](https://github.com/community-scripts/core) | The engine — container and VM creation, the wizard, error handling |
+| **ProxmoxVE** (this repo) | Canonical application scripts, plus `tools/pve/`, `vm/` and `turnkey/` |
+| [Incus](https://github.com/community-scripts/Incus) | The same scripts on an Incus host, plus Incus VMs and host tooling |
+| [DevScripts](https://github.com/community-scripts/DevScripts) | Where new scripts are tested before they land here |
---
-## How Scripts Work
+## Layout
-Every script follows the same pattern:
+| Folder | Contents |
+| ------ | -------- |
+| `ct/` | Application scripts — the command you paste |
+| `install/` | What each script installs inside the container |
+| `vm/` | Virtual machine scripts |
+| `tools/pve/` | Host tooling: post-install, hardware passthrough, maintenance |
+| `turnkey/` | TurnKey Linux appliance helper |
+| `misc/` | Legacy engine copies — current scripts load [core](https://github.com/community-scripts/core) at runtime, so changes here never reach a running install |
-**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
+Application metadata — name, description, logo, tags — is managed on the website,
+not in this repository. Use the **Report Issue** link on any script page to
+request a change.
---
-## What's Included
+## Testing a fork or branch
-The repository covers a wide range of categories. A few examples:
+Engine and scripts resolve independently, so either can point somewhere else.
+Put the variable on the command itself — nothing needs exporting.
-| 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 |
+To run your own copy of the scripts:
-> Browse the full list at **[community-scripts.org/categories](https://community-scripts.org/categories)** — new scripts are added regularly.
+```bash
+COMMUNITY_SCRIPTS_URL=https://raw.githubusercontent.com/YOU/ProxmoxVE/my-branch \
+ bash -c "$(curl -fsSL https://raw.githubusercontent.com/YOU/ProxmoxVE/my-branch/ct/debian.sh)"
+```
+
+A `ct/` script fetched with `curl` cannot tell the engine where it came from, so
+without that variable it would look for its `install/` half upstream.
+
+Only when you are changing the engine itself:
+
+```bash
+COMMUNITY_SCRIPTS_CORE_URL=https://raw.githubusercontent.com/YOU/core/my-branch \
+ bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/debian.sh)"
+```
+
+A local checkout of core wins over both — point at it with
+`COMMUNITY_SCRIPTS_CORE_DIR`.
---
## Contributing
-This project runs on community contributions. Whether you want to write new scripts, improve existing ones, or just report a bug — every bit helps.
+This project runs on community contributions. New scripts, fixes, bug reports —
+all of it helps.
-### Where to start
-
-| I want to… | Go here |
-| ------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| Add a **new** script | [DevScripts](https://github.com/community-scripts/DevScripts) — new scripts are tested here first |
-| Fix or improve an **existing** script | [Contributing Guidelines](CONTRIBUTING.md) — open a PR in this repo |
-| 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) |
-| Report a security vulnerability | [Security Policy](SECURITY.md) |
-| Get help or chat with other users | [Discord](https://discord.gg/3AnUqsXnmK) |
+| I want to… | Go here |
+| ---------- | ------- |
+| Add a **new** script | [DevScripts](https://github.com/community-scripts/DevScripts) — new scripts are tested there first |
+| Fix or improve an **existing** script | [Contributing Guidelines](CONTRIBUTING.md) — open a PR here |
+| Change how containers are built | [core](https://github.com/community-scripts/core) |
+| Report a bug or a broken script | [Issues](https://github.com/community-scripts/ProxmoxVE/issues) |
+| Request a script or a feature | [Discussions](https://github.com/community-scripts/ProxmoxVE/discussions) |
+| Report a security vulnerability | [Security Policy](SECURITY.md) |
+| Ask a question | [Discord](https://discord.gg/3AnUqsXnmK) |
### Before you open a PR
-- **New scripts go to [DevScripts](https://github.com/community-scripts/DevScripts), not here.** PRs with new scripts opened directly against this repo will be closed.
-- Bug fixes and improvements to existing scripts belong in this repo — read the [Contributing Guidelines](CONTRIBUTING.md) first.
-- Keep PRs focused. One fix or feature per PR.
-- Document what your script installs and any non-obvious decisions in the corresponding JSON metadata file.
+- **New scripts go to [DevScripts](https://github.com/community-scripts/DevScripts), not here.** PRs adding new scripts to this repository will be closed.
+- Keep a PR to one fix or one feature.
+- A bug that also happens on Incus is an application or engine bug — say so in the report.
+- Read the [Contributing Guidelines](CONTRIBUTING.md) before your first PR.
---
@@ -137,6 +191,8 @@ This project runs on community contributions. Whether you want to write new scri
+ 
+
- 
