CanbiZ 3998b80194 Add comprehensive documentation for all project sections

Introduced new and updated documentation files across the docs/ directory, including project structure guides, function library references, and standardized READMEs for ct, install, vm, tools, api, and misc. This update fully documents all nine function libraries, provides quick start and learning paths, and mirrors the project structure for easier navigation and contribution.

2025-12-01 11:40:38 +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

UPDATED_APP-ct.md - Complete guide for creating ct scripts
CONTRIBUTION_GUIDE.md - Contribution workflow
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_GUIDE.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