KNELProductionContainers/CloudronPackages/PackageTemplate/README.md

Package Template for Cloudron Apps

This is a minimal template to package an application for Cloudron.

Replace placeholders in files with your app specifics:

• __APP_ID__ (e.g., com.example.myapp)
• __APP_TITLE__ (human name)
• __HTTP_PORT__ (default internal app port)
• __CLOUDRON_BASE__ (Cloudron base image tag, e.g., 5.0.0)

Files

• CloudronManifest.json – base manifest
• Dockerfile – uses cloudron/base, non-root user, healthcheck
• start.sh – startup script with addon detection examples
• nginx.conf (optional) – example reverse proxy
• supervisord.conf (optional) – process manager example
• config.yaml (optional) – sample app config
• logo.png – add your 512x512 PNG icon here (not provided in template)

Usage

1. Create a new package from this template using scripts/new-package.sh: scripts/new-package.sh MyApp --id com.example.myapp --title "My App" --port 3000
2. Adjust Dockerfile and start.sh to run your app.
3. Build and test locally; then commit and push.