Adding Apps to the Store

Want to add an app to the Companion App Store? Here’s how.

Prerequisites

• The app must be available as a Docker image
• You need a GitHub account

App Structure

Each app lives in its own folder under apps/<slug>/ in the App Store repository. The minimum required files are:

• apps
  • my-app
    • config.json
    • docker-compose.yml
    • description.md
    • metadata
      • logo.jpg

config.json

Contains all app metadata — name, description, port, categories, form fields, supported architectures, and more. See the config.json reference for all available options.

docker-compose.yml

Standard Docker Compose file that defines how the app runs. Use environment variables like ${APP_PORT} and form field variables to make the app configurable.

description.md

A longer description of the app displayed on the app’s detail page. Supports HTML.

metadata/logo.jpg

A square logo image for the app (recommended 256×256px).

Process

1. Create a new folder under apps/ with your app’s slug (lowercase, hyphenated)
2. Add the required files listed above
3. Test your app locally by adding a custom app store pointing to your repo
4. Submit a pull request to the Companion App Store

Guidelines

• Use official Docker images where possible
• Provide sensible default configuration
• Include all required environment variables in config.json
• Set supported_architectures accurately — don’t claim arm64 support if the image doesn’t have it
• Test that the app installs and runs correctly on a fresh Companion Home instance