Skip to Content
DocumentationContributingAdding Apps to the Store

Adding Apps to the Store

Want to add an app to the Companion App Store? Submit through our web form or open a pull request.

Quick submit

Visit ci.computer/store-submitΒ  β€” the fastest path to get your app reviewed and listed.

See the full Submitting to the Marketplace guide for requirements, examples, and review process.

Prerequisites

  • The app must run as a Docker container
  • A public or submit-able Docker image (or build with the Static Container Builder)
  • A GitHub account (for PR submissions)

App structure

Each app lives in apps/<slug>/ in the CI-MarketplaceΒ  repository. Use NextcloudΒ  as a reference.

    • config.json
    • docker-compose.json
    • README.md
      • description.md
      • logo.png

Required files

FilePurpose
config.jsonMetadata, form fields, categories, Hub integration β€” see config.json reference
docker-compose.jsonService definition (preferred) or legacy docker-compose.yml
metadata/description.mdLong description for the App Store detail page
metadata/logo.pngSquare logo (~256Γ—256 px)
README.mdDeveloper docs for reviewers

config.json

Contains name, description, port, categories, form fields, supported architectures, and optional hub_integration for AI/MCP apps.

docker-compose.json

Dynamic compose schema (version 2) defining images, ports, volumes, health checks, and ${ENV_VAR} references. See Dynamic Compose.

Process

  1. Create apps/<slug>/ with the required files
  2. Test locally via a custom app store pointing at your fork
  3. Submit via store-submitΒ  or open a PR to CI-Marketplace

Guidelines

  • Use official Docker images where possible
  • Provide sensible defaults; use random fields for secrets
  • Set supported_architectures accurately
  • Add hub_integration.inference if your app uses Hub AI variables
  • Test a clean install on a fresh Hub instance

For AI apps, see AI & Inference. For container builds, see Static Container Builder.

Last updated on