starred/ProxmoxVE
1
0
Fork 0
mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2026-10-28 02:00:14 +01:00
Code Issues Packages Projects Releases 10 Wiki Activity

Ref: Docs / Readme (#18233)

Browse Source
This commit is contained in:
CanbiZ (MickLesk)
2026-10-26 17:47:22 +01:00
committed by GitHub
parent 5d477b0b6e
commit 23d0c904a3
8 changed files with 144 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
-1
View File
@@ -191,7 +191,6 @@ create` still ran and the container was still built.
## Notes ## Notes
- **Website metadata** (name, description, logo, tags) is managed via the website — use the "Report Issue" link on any script page to request changes. Do not submit metadata changes via repo files. - **Website metadata** (name, description, logo, tags) is managed via the website — use the "Report Issue" link on any script page to request changes. Do not submit metadata changes via repo files.
- **JSON files** in `json/` define script properties used by the website. See existing files for structure reference.
- Keep PRs small and focused. One fix or feature per PR is ideal. - Keep PRs small and focused. One fix or feature per PR is ideal.
- PRs with **new scripts** opened against ProxmoxVE will be closed — submit them to [DevScripts](https://github.com/community-scripts/DevScripts) instead. - PRs with **new scripts** opened against ProxmoxVE will be closed — submit them to [DevScripts](https://github.com/community-scripts/DevScripts) instead.
- PRs that fail CI checks will not be merged. - PRs that fail CI checks will not be merged.
README.md
+129 -71
View File
@@ -1,16 +1,17 @@
<div align="center"> <div align="center">
<img src="https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo-81x112.png" height="112px" alt="Proxmox VE Helper-Scripts Logo" /> <a href="misc/images/community-scripts.svg"><img src="misc/images/community-scripts.png" width="112" height="112" alt="Community Scripts — Proxmox VE logo" /></a>
<!-- Editable artwork: misc/images/community-scripts.svg; PNG export: 512 × 512. -->
<h1>Proxmox VE Helper-Scripts</h1> <h1>Community Scripts — Proxmox VE</h1>
<p><strong>One-command installations for services, containers, and VMs on Proxmox VE</strong><br/> <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> A community project — built on the foundation of <a href="https://github.com/tteck">@tteck</a>'s original work</p>
<p> <p>
<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://community-scripts.org"><img src="https://img.shields.io/badge/Website-community--scripts.org-4c9b3f?style=flat-square" alt="Website" /></a>
<a href="https://discord.gg/3AnUqsXnmK"><img src="https://img.shields.io/badge/Discord-Join_us-7289da?style=flat-square&logo=discord&logoColor=white" /></a> <a href="https://discord.gg/3AnUqsXnmK"><img src="https://img.shields.io/badge/Discord-Join_us-7289da?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
<a href="https://github.com/community-scripts/ProxmoxVE/stargazers"><img src="https://img.shields.io/github/stars/community-scripts/ProxmoxVE?style=flat-square&label=Stars&color=f5a623" /></a> <a href="https://github.com/community-scripts/ProxmoxVE/stargazers"><img src="https://img.shields.io/github/stars/community-scripts/ProxmoxVE?style=flat-square&label=Stars&color=f5a623" alt="Stars" /></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="https://github.com/community-scripts/ProxmoxVE/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/Changelog-view-6c5ce7?style=flat-square" alt="Changelog" /></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=flat-square" /></a> <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=flat-square" alt="License" /></a>
</p> </p>
</div> </div>
@@ -18,94 +19,147 @@
## What is this? ## 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 ## Requirements
| Component | Details | | Component | Details |
| -------------- | ------------------------------------------------ | | --------- | ------- |
| **Proxmox VE** | Version 8.4, 9.0, 9.1, or 9.2 | | **Proxmox VE** | 8.0 – 8.4, or 9.0 – 9.2 |
| **Host OS** | Proxmox VE (Debian-based) | | **Access** | Root shell on the Proxmox host |
| **Access** | Root shell access on the Proxmox host | | **Network** | Internet access during installation |
| **Network** | Internet connection required during installation |
Virtual machine scripts need the same versions as containers.
--- ---
## Getting Started ## Repository map
The fastest way to find and run scripts: | Repository | Contains |
| ---------- | -------- |
1. Go to **[community-scripts.org](https://community-scripts.org)** | [core](https://github.com/community-scripts/core) | The engine — container and VM creation, the wizard, error handling |
2. Search for the service you want (e.g. "Home Assistant", "Nginx Proxy Manager", "Jellyfin") | **ProxmoxVE** (this repo) | Canonical application scripts, plus `tools/pve/`, `vm/` and `turnkey/` |
3. Copy the one-line install command from the script page | [Incus](https://github.com/community-scripts/Incus) | The same scripts on an Incus host, plus Incus VMs and host tooling |
4. Open your **Proxmox Shell** and paste it | [DevScripts](https://github.com/community-scripts/DevScripts) | Where new scripts are tested before they land here |
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.
--- ---
## 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. 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
**Advanced mode** — Gives you full control over container settings, networking, storage backends, and application-level configuration before anything is installed. request a change.
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
--- ---
## 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 | To run your own copy of the scripts:
| --------------- | --------------------------------------------------- |
| 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 |
> 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 ## 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 |
| ---------- | ------- |
| 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 |
| Add a **new** script | [DevScripts](https://github.com/community-scripts/DevScripts) — new scripts are tested here first | | Change how containers are built | [core](https://github.com/community-scripts/core) |
| Fix or improve an **existing** script | [Contributing Guidelines](CONTRIBUTING.md) — open a PR in this repo | | Report a bug or a broken script | [Issues](https://github.com/community-scripts/ProxmoxVE/issues) |
| Report a bug or broken script | [Issues](https://github.com/community-scripts/ProxmoxVE/issues) | | Request a script or a feature | [Discussions](https://github.com/community-scripts/ProxmoxVE/discussions) |
| Request a new script or feature | [Discussions](https://github.com/community-scripts/ProxmoxVE/discussions) | | Report a security vulnerability | [Security Policy](SECURITY.md) |
| Report a security vulnerability | [Security Policy](SECURITY.md) | | Ask a question | [Discord](https://discord.gg/3AnUqsXnmK) |
| Get help or chat with other users | [Discord](https://discord.gg/3AnUqsXnmK) |
### Before you open a PR ### 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. - **New scripts go to [DevScripts](https://github.com/community-scripts/DevScripts), not here.** PRs adding new scripts to this repository will be closed.
- Bug fixes and improvements to existing scripts belong in this repo — read the [Contributing Guidelines](CONTRIBUTING.md) first. - Keep a PR to one fix or one feature.
- Keep PRs focused. One fix or feature per PR. - A bug that also happens on Incus is an application or engine bug — say so in the report.
- Document what your script installs and any non-obvious decisions in the corresponding JSON metadata file. - 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
<sub><b>CrazyWolf13</b></sub> <sub><b>CrazyWolf13</b></sub>
</a> </a>
</td> </td>
</tr>
<tr>
<td align="center"> <td align="center">
<a href="https://github.com/tremor021"> <a href="https://github.com/tremor021">
<img src="https://github.com/tremor021.png" width="80" height="80" style="border-radius:50%" alt="tremor021" /><br/> <img src="https://github.com/tremor021.png" width="80" height="80" style="border-radius:50%" alt="tremor021" /><br/>
@@ -155,6 +211,7 @@ This project runs on community contributions. Whether you want to write new scri
<sub><b>asylumexp</b></sub> <sub><b>asylumexp</b></sub>
</a> </a>
</td> </td>
<td></td>
</tr> </tr>
</table> </table>
@@ -194,9 +251,11 @@ This project runs on community contributions. Whether you want to write new scri
## Support the Project ## Support the Project
This project is maintained by volunteers. All infrastructure costs come out of pocket, and the work is done in people's spare time. This project is maintained by volunteers. Infrastructure costs come out of
pocket and the work happens 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. **30% of all donations are forwarded directly to cancer research and hospice
care** — a cause that was important to tteck.
<div align="center"> <div align="center">
<a href="https://ko-fi.com/community_scripts"> <a href="https://ko-fi.com/community_scripts">
@@ -212,14 +271,13 @@ This project is maintained by volunteers. All infrastructure costs come out of p
## License ## License
This project is licensed under the [MIT License](LICENSE) — free to use, modify, and redistribute for personal and commercial purposes. MIT — free to use, modify and redistribute, for personal and commercial
purposes. See [LICENSE](LICENSE).
See the full license text in [LICENSE](LICENSE).
--- ---
<div align="center"> <div align="center">
<sub>Built on the foundation of <a href="https://github.com/tteck">tteck</a>'s original work · <a href="https://github.com/tteck/Proxmox">Original Repository</a></sub><br/> <sub>Built on the foundation of <a href="https://github.com/tteck">tteck</a>'s original work · <a href="https://github.com/tteck/Proxmox">Original Repository</a></sub><br/>
<sub>Maintained and expanded by the community · In memory of tteck</sub><br/> <sub>Maintained and expanded by the community · In memory of tteck</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> <sub><i>This is an independent community project. <b>Proxmox</b>® is a registered trademark of <a href="https://www.proxmox.com/en/about/company">Proxmox Server Solutions GmbH</a>.</i></sub>
</div> </div>
misc/images/community-scripts.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

misc/images/community-scripts.svg
+15
View File
@@ -0,0 +1,15 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" role="img" aria-labelledby="title desc">
<title id="title">Community Scripts - CS Amber</title>
<desc id="desc">A continuous ivory C interlocks with a warm orange S on charcoal. Both letterforms use rounded, folded geometry.</desc>
<rect width="512" height="512" rx="112" fill="#29262b"/>
<defs>
<mask id="weave-clearance" maskUnits="userSpaceOnUse" x="0" y="0" width="512" height="512">
<rect width="512" height="512" fill="white"/>
<path d="M390 142H322L270 172V220L322 250H348L392 276V338L338 370H284" fill="none" stroke="black" stroke-width="72" stroke-linecap="round" stroke-linejoin="round"/>
</mask>
</defs>
<g fill="none" stroke-width="56" stroke-linecap="round" stroke-linejoin="round">
<path d="M254 142H186L118 182V330L186 370H254" stroke="#f5f4eb" mask="url(#weave-clearance)"/>
<path d="M390 142H322L270 172V220L322 250H348L392 276V338L338 370H284" stroke="#f29a67"/>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 997 B

misc/images/logo-81x112.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

misc/images/logo.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 17 KiB

misc/images/old_logo-81x112.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.4 KiB

misc/images/old_logo.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 63 KiB