Files

ReachableCEO 11aac9ffc8 feat: add Cloudron packaging templates

- Create Package-Templates directory structure
- Add official-wrapper Dockerfile template
- Add Django application template (Dockerfile + start.sh)
- Add README template with comprehensive documentation
- Create template usage documentation

Templates include:
- Official Image Wrapper pattern (simple wrapper for existing images)
- Django Application pattern (with PostgreSQL integration)
- Standardized README template with all sections
- Django start.sh with database wait, migrations, admin creation
- Template documentation and usage instructions

Benefits:
- Accelerates packaging for similar applications
- Ensures consistency across packages
- Reduces repetitive work
- Documents Cloudron best practices
- Reference for future packaging

Template patterns covered:
- Official image wrapper
- Django application with PostgreSQL
- Database wait logic
- Migration execution
- Admin user creation
- Health check implementation
- Environment variable configuration

💘 Generated with Crush

Assisted-by: GLM-4.7 via Crush <crush@charm.land>

2026-02-04 15:41:08 -05:00

3.5 KiB

Raw Permalink Blame History

<APP_NAME> Cloudron Package

Description

Features

Core Capabilities

Feature 1: Description
Feature 2: Description
Feature 3: Description

Application Features

Feature A: Description with details
Feature B: Description with details
Feature C: Description with details

Configuration

Environment Variables

Application Configuration

CONFIG_VAR_1: Description (default: value1)
CONFIG_VAR_2: Description (default: value2)

Ports

8080: Main HTTP port (description)

Addons

PostgreSQL: Required for database storage
Localstorage: Used for file storage
Redis: Optional caching

Usage

1. Initial Setup

Open <APP_NAME>
Create admin account (if applicable)
Configure system settings
Verify application is running

2. Basic Usage

Step 1: Do something

Navigate to section
Click button
Configure settings
Save

Step 2: Do something else

Use feature
Configure options
Test functionality

3. Configuration

# Example configuration
CONFIG_VAR_1=value1
CONFIG_VAR_2=value2

4. API Usage (if applicable)

# Example API call
curl -X POST http://localhost:8080/api/endpoint \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Architecture

                    ┌─────────────┐
                    │   Client    │
                    │  (Browser)   │
                    └──────┬──────┘
                           │
                    HTTP Request
                           ▼
                   ┌──────────────┐
                   │ <APP_NAME>   │
                   │  (<TYPE>)     │
                   │  Application   │
                   └──────┬──────┘
                           │
              ┌────────────┼────────────┐
              │            │            │
              ▼            ▼            ▼
       ┌──────────┐  ┌──────────┐  ┌──────────┐
       │ Database  │  │ Storage   │  │  Cache    │
       │ (PostgreSQL│  │  (Local   │  │  (Redis)  │
       │            │  │  storage)  │  │            │
       └──────────┘  └──────────┘  └──────────┘

Security

Authentication

User management
Role-based access control (if applicable)
Session management
API token authentication (if applicable)

Data Protection

<Security feature 1>
<Security feature 2>
<Security feature 3>

Troubleshooting

Issue 1

Problem: Description Solution: Steps to resolve Check: Verify by doing X

Issue 2

Problem: Description Solution: Steps to resolve Check: Verify by doing Y

Documentation

For more information:

Support

For issues and questions:

Upstream

GitHub Repository Official Website

3.5 KiB Raw Permalink Blame History