The App Manifest

Every Octostar app needs a manifest.yaml that registers it with the platform. It controls how the app appears in the UI, what resources it receives, which entity types it accepts, and how it's launched.

# ── Identity ───────────────────────────────────────────────────────────────────
name: My Octostar App               # Display name shown in the platform
description: Short description of what the app does
icon: fa-circle-question            # FontAwesome icon name (fa-*)
alias: my-octostar-app              # Unique URL-safe slug — no spaces
image: octostar/app.my-octostar-app # Docker image (org/app.your-slug)

# ── Resources ──────────────────────────────────────────────────────────────────
storage_limit: 2Gi
memory_limit: 2Gi
cpu_priority: normal                # normal | high

# ── Entity filters (optional) ──────────────────────────────────────────────────
# Restrict which entity types can open this app.
# Omit this section entirely if your app doesn't target specific entity types.
filters:
  is_file:
    type: semantically_bound
    concepts:
      - os_file       # any file
      # - os_image    # images only
      # - os_document # documents only
  is_folder:
    type: semantically_bound
    concepts:
      - os_folder

# ── Transforms ─────────────────────────────────────────────────────────────────
# Define how the app is opened. "iframe" embeds it as a panel inside Octostar.
transforms:
  open_iframe:
    description: Opens the app as an iframe panel
    type: iframe
    title: My Octostar App
    icon: fa-circle-question

# ── Services (optional) ────────────────────────────────────────────────────────
# Adds an entry to the right-click context menu for matching entities.
# Omit this section if your app doesn't need a context menu entry.
services:
  open_my_app:
    order: 60
    role: context_menu
    group: general
    label: My Octostar App
    icon: fa-circle-question
    show_progress: false
    description: What the app does in one sentence
    accepts:
      - is_file
      - is_folder
    transforms:
      - open_iframe

Key fields

Field	Description
alias	Unique identifier used in URLs. Must be URL-safe (hyphens, no spaces).
image	Docker Hub image in org/app.your-slug format. Must match your CI/CD pipeline.
filters	Named entity selectors. Each filter defines an Octostar concept type that can trigger this app. Optional.
transforms	Defines launch modes. type: iframe embeds the app as a panel. The transform name (e.g. open_iframe) is referenced by services.
services	Registers entries in the right-click context menu. Optional.
accepts	List of filter names (defined in filters) that control when a context menu entry is visible.
transforms (under a service)	List of transform names to invoke — references the keys defined in the top-level transforms block.