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

Files

CanbiZ b87fddbf6a Update contribution docs for fork setup and metadata

Revised documentation to standardize use of 'bash docs/contribution/setup-fork.sh --full' for fork configuration, clarified install script execution flow, and updated JSON metadata template and field references. Improved helper function docs, resource requirements, and category lists. Updated references and instructions throughout for consistency and accuracy.

2026-01-18 18:56:21 +01:00

1.3 KiB

Raw Blame History

🧪 Code Audit: LXC Script Flow

This guide explains the current execution flow and what to verify during reviews.

Execution Flow (CT + Install)

ct/appname.sh runs on the Proxmox host and sources misc/build.func.
build.func orchestrates prompts, container creation, and invokes the install script.
Inside the container, misc/install.func exposes helper functions via $FUNCTIONS_FILE_PATH.
install/appname-install.sh performs the application install.
The CT script prints the completion message.

Audit Checklist

CT Script (ct/)

Sources misc/build.func from community-scripts/ProxmoxVE/main (setup-fork.sh updates for forks).
Uses check_for_gh_release + fetch_and_deploy_gh_release for updates.
No Docker-based installs.

Install Script (install/)

Sources $FUNCTIONS_FILE_PATH.
Uses tools.func helpers (setup_*).
Ends with motd_ssh, customize, cleanup_lxc.

JSON Metadata

File in frontend/public/json/<appname>.json matches template schema.

Testing

Test via curl from your fork (CT script only).
Wait 10-30 seconds after push.

References

docs/contribution/templates_ct/AppName.sh
docs/contribution/templates_install/AppName-install.sh
docs/contribution/templates_json/AppName.json
docs/contribution/GUIDE.md

1.3 KiB Raw Blame History