mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2026-03-17 15:33:00 +01:00

Files

Michel Roegl-Brunner 3c582e37dc docs: update contribution docs for website metadata workflow (fixes #12839 )

- Request metadata via website Report issue button instead of JSON in repo
- PRs now include only 2 files: ct/*.sh and install/*-install.sh
- Update README, GUIDE, CONTRIBUTING, AI.md, CODE-AUDIT, templates
- Fix docs/ct README link from CONTRIBUTION_GUIDE to contribution/README

Made-with: Cursor

2026-03-13 12:46:28 +01:00

2.1 KiB

Raw Blame History

Container Scripts Documentation (/ct)

This directory contains comprehensive documentation for container creation scripts in the /ct directory.

Overview

Container scripts (ct/*.sh) are the entry points for creating LXC containers in Proxmox VE. They run on the host and orchestrate the entire container creation process.

Documentation Structure

Each script has standardized documentation following the project pattern.

Key Resources

DETAILED_GUIDE.md - Complete reference for creating ct scripts
../contribution/README.md - How to contribute
../misc/build.func/ - Core orchestrator documentation

Container Creation Flow

ct/AppName.sh (host-side)
    │
    ├─ Calls: build.func (orchestrator)
    │
    ├─ Variables: var_cpu, var_ram, var_disk, var_os
    │
    └─ Creates: LXC Container
                │
                └─ Runs: install/appname-install.sh (inside)

Available Scripts

See /ct directory for all container creation scripts. Common examples:

pihole.sh - Pi-hole DNS/DHCP server
docker.sh - Docker container runtime
wallabag.sh - Article reading & archiving
nextcloud.sh - Private cloud storage
debian.sh - Basic Debian container
And 30+ more...

Quick Start

To understand how to create a container script:

Read: UPDATED_APP-ct.md
Study: A similar existing script in /ct
Copy template and customize
Test locally
Submit PR

Contributing a New Container

Create ct/myapp.sh
Create install/myapp-install.sh
Follow template in UPDATED_APP-ct.md
Test thoroughly
Submit PR with both files

Common Tasks

Add new container application → contribution/README.md
Debug container creation → EXIT_CODES.md
Understand build.func → misc/build.func/
Development mode debugging → DEV_MODE.md

Last Updated: December 2025 Maintainers: community-scripts team

2.1 KiB Raw Blame History