1Panel Appstore Skills

English | 简体中文

1panel-appstore-skills is a skill for creating 1Panel App Store app installation packages.

It is designed for applications that already support Docker-based deployment. It can generate a package that follows the 1Panel App Store app format from official repositories, official documentation, Docker images, docker-compose.yml, or a prepared intermediate spec.

When to Use

Suitable for:

• Packaging a Dockerized application as a 1Panel App Store app.
• Converting Docker / Docker Compose installation methods from official repositories or official documentation into a 1Panel app package.
• Organizing an existing docker-compose.yml into the 1Panel App Store directory structure.
• Generating data.yml, docker-compose.yml, README files, and data directories from a prepared app spec.

Not suitable for:

• Applications without a reliable Docker-based installation method.
• Scenarios that require inventing the application deployment architecture, image, ports, data directories, or environment variables.
• Publishing to a remote app store repository. This skill only generates app package content.

Supported Inputs

• Application name or official repository URL.
• Docker image and required deployment parameters.
• Official docker-compose.yml / compose.yml file.
• Intermediate JSON spec that follows references/appspec.md.

Output

The generated result is a 1Panel App Store app package directory. The default structure is:

apps//
  logo.png
  README.md
  README_en.md
  data.yml
  /
    data.yml
    docker-compose.yml
    data/
    scripts/        # Optional: generated init.sh and manually added lifecycle scripts

Based on the input and official sources, it handles:

• Basic app information, version, type, tags, website, documentation, and repository URL.
• Main service and dependent service images, ports, environment variables, data volumes, and startup dependencies.
• data.yml fields, form fields, and multilingual descriptions required by 1Panel.
• Chinese README; English README when the official application or documentation supports English.
• Persistent directory permission initialization script, generated only when official sources prove it is required.

Project Layout

1panel-appstore-skills/
  README.md
  README.zh-CN.md
  SKILL.md
  assets/
  references/
  scripts/

Core files:

• SKILL.md: defines trigger scenarios, workflow, and packaging rules.
• assets/sample-appspec.json: intermediate spec example, useful for understanding the generation flow.
• references/appstore-format.md: 1Panel app package directory and field rules.
• references/appspec.md: intermediate spec fields and generation boundaries.
• references/review-checklist.md: package review and local testing checklist.