mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2026-02-05 21:03:24 +01:00

Go to file

CanbiZ (MickLesk) 2c18646d82 Docs: expand developer/debugging and tools references

Add extensive documentation and examples across contribution, guides, templates and tools references. Key changes:
- Introduce a Developer Mode & Debugging section (dev_mode flags: trace, keep, pause, breakpoint, logs, dryrun, motd) in CONTRIBUTING.md with usage example.
- Provide a standard update_script() pattern and BookStack example in GUIDE.md to clarify update flow (stop services, backup, deploy, restore, migrate, restart).
- Add new helper entries (BookLore, KaraKeep) and advanced repository helpers (setup_deb822_repo, prepare_repository_setup, cleanup_tool_keyrings) plus utilities (setup_meilisearch, verify_tool_version) in HELPER_FUNCTIONS.md.
- Update install template to suggest PNPM, Java 21 and Meilisearch; update example DB setup notes in AppName-install.sh.
- Add var_diagnostics option and switch var_fuse to boolean/toggle wording in CONFIGURATION_REFERENCE.md; clarify privacy and defaults.
- Adjust example container definitions in UNATTENDED_DEPLOYMENTS.md (container entries and resource values).
- Change storage and flag variables and examples in BUILD_FUNC_USAGE_EXAMPLES.md (ssd-storage, var_fuse/var_tun, etc.).
- Expand TOOLS_FUNC_FUNCTIONS_REFERENCE.md with many setup_* function signatures, environment vars, clarified fetch_and_deploy_gh_release modes/parameters, and additional tool docs (nodejs, php, mariadb_db, postgresql_db, java, uv, yq, meilisearch, composer, build tools).

These updates improve onboarding, debugging guidance, and operational clarity for contributors and maintainers.

2026-02-05 15:16:35 +01:00

.github

action: prevent duplicate History section in changelog-archive workflow

2026-02-04 14:04:34 +01:00

.vscode

re-add shellcheck exclusions (#10586 )

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

api

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

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

OpenCloud (#11538 )

2026-02-05 14:16:36 +01:00

docs

Docs: expand developer/debugging and tools references

2026-02-05 15:16:35 +01:00

frontend

Update date in json (#11577 )

2026-02-05 13:16:59 +00:00

install

OpenCloud (#11538 )

2026-02-05 14:16:36 +01:00

misc

feat(cloud-init): add interactive SSH key discovery and selection (#11547 )

2026-02-05 08:11:13 +01:00

tools

Update .app files (#11550 )

2026-02-04 21:06:58 +01:00

turnkey

core: validate container ID before pct create to prevent failures (#10729 )

2026-01-12 14:04:28 +01:00

Update .app files (#11570 )

2026-02-05 12:02:06 +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

ignore vscode/settings.json

2025-04-15 15:58:05 +02:00

CHANGELOG.md

Update CHANGELOG.md (#11579 )

2026-02-05 13:17:09 +00:00

LICENSE

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

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

README.md

Update project statistics in README

2025-12-15 10:06:07 +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 helper-scripts.com 🌐
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}