mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2026-04-05 18:13:50 +00:00

Go to file

CanbiZ (MickLesk) 1c3c223e51 Turnkey: modernize turnkey.sh with shared libraries (#13242 )

* refactor(turnkey): modernize turnkey.sh with shared libraries and telemetry

- Source core.func, error_handler.func, api.func instead of custom error/msg functions
- Replace custom error_exit/warn/info/msg with msg_info/msg_ok/msg_error/msg_warn
- Upgrade validate_container_id to cluster-aware (pvesh + all-node config check)
- Add diagnostics_check() and telemetry (post_to_api / post_update_to_api)
- Add pve_check, shell_check, root_check for environment validation
- Use proper EXIT trap for cleanup (destroy container on error, restart monitor)
- Improve quoting throughout (PCT_OPTIONS as array, quoted variables)
- Secure credentials file with chmod 600
- Use exit_script for user cancellations (consistent with other scripts)

* fix(turnkey): replace diagnostics_check with inline config read

diagnostics_check() is defined in build.func which is not sourced.
Read the diagnostics config file directly instead — respects existing
user preference without prompting (turnkey has no settings menu).

* bump hardcoded names to dynamic list

* Preserve telemetry type and report failures

Respect a pre-set TELEMETRY_TYPE in misc/api.func and use it in the API payload instead of the hardcoded "lxc". In turnkey/turnkey.sh, set TELEMETRY_TYPE="turnkey" for turnkey installs and enhance turnkey_cleanup() to report failed installs to telemetry (calls post_update_to_api "failed" with the exit code when POST_TO_API_DONE is true and POST_UPDATE_DONE is not), then destroy the failed container. These changes ensure correct telemetry type propagation and that failed turnkey deployments are reported.

---------

Co-authored-by: Slaviša Arežina <58952836+tremor021@users.noreply.github.com>

2026-03-24 15:54:01 +01:00

.github

Update script timestamp handling and dev promotion

2026-03-23 10:37:57 +01:00

.vscode

re-add shellcheck exclusions (#10586 )

2026-01-06 13:27:23 +01:00

Update .app files (#13254 )

2026-03-24 11:51:32 +01:00

docs

Update: Docs/website metadata workflow (#12858 )

2026-03-13 15:15:21 +01:00

install

qf typo

2026-03-24 15:10:33 +01:00

misc

Turnkey: modernize turnkey.sh with shared libraries (#13242 )

2026-03-24 15:54:01 +01:00

tools

Homebrew (Addon) (#13249 )

2026-03-24 11:51:35 +01:00

turnkey

Turnkey: modernize turnkey.sh with shared libraries (#13242 )

2026-03-24 15:54:01 +01:00

VM's: add input validation and hostname sanitization to all VM scripts (#12973 )

2026-03-20 13:18:01 +01:00

.editorconfig

Update repo tree to fix .editorconfig beign ignored. (#3302 )

2025-03-21 15:53:30 +01:00

.gitattributes

linguist - enable visible jsons in pr's

2025-07-17 15:14:05 +02:00

.gitignore

Cleanup: remove frontend, move JSONs to json/ top-level (#12813 )

2026-03-12 13:59:18 +01:00

CHANGELOG.md

Update CHANGELOG.md (#13255 )

2026-03-24 10:51:59 +00:00

LICENSE

chore: bump copyright to 2026 - happy new year (#10585 )

2026-01-06 13:28:12 +01:00

README.md

Update link from helper-scripts.com to community-scripts.org (#13098 )

2026-03-19 20:34:34 +01:00

SECURITY.md

gh: update supported PVE Version (#9422 )

2025-11-25 08:52:46 +01:00

README.md

Proxmox VE Helper-Scripts

A Community Legacy in Memory of @tteck

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

⚡ 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

📋 Requirements

🖥️ Proxmox VE

Version: 8.4.x | 9.0.x | 9.1.x

🐧 Operating System

Debian-based with Proxmox Tools

🌐 Network

Internet connection required

📥 Getting Started

Choose your preferred installation method:

Method 1: One-Click Web Installer

The fastest way to get started:

Visit community-scripts.org 🌐
Search for your desired script (e.g., "Home Assistant", "Docker")
Copy the bash command displayed on the script page
Open your Proxmox Shell and paste the command
Press Enter and follow the interactive prompts

Method 2: PVEScripts-Local

Install a convenient script manager directly in your Proxmox UI:

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

💬 Join the Community

💬 Discord

Real-time chat, support, and discussions

💭 Discussions

Feature requests, Q&A, and ideas

🐛 Issues

Bug reports and issue tracking

🛠️ Contribute

💻 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

👉 Check our Contributing Guidelines to get started

❤️ Support the Project

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

_{Every contribution helps keep this project alive and supports meaningful causes}

📈 Project Statistics

📜 License

This project is licensed under the MIT 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}