Index

mainfest.yml file

• The manifest.yml file is a YAML based schema definition of how to map external ports, directories, environment variables and various configuration options for your custom image.

• manifest.yml is required with every custom image. The following describes the minimum parameters needed.

• Example manifest.yml:

  application:
    name: MyApp
    version: 1.0.0
    description: This is a sample application for MiniDock.
    author: John Doe
    author_email: [email protected]
    bugs: https://github.com/johndoe/myapp/issues
    repository: https://github.com/johndoe/myapp
    licenses: MIT
  
  system_requirements:
    minimum_version: 1.1.0
    compatible_devices:
      - MiniDock
  
  files:
    include:
      - __init__.py
      - ui.py
  

Description:

• Required parameters:
  • name: APP name
  • descript: APP introduction
  • version: current version
  • minimum_version: minimum supported version
  • compatible_devices: supported devices
• Other optional fields:
  • author: App author
  • author_email: author’s email
  • licenses: license list.
  • bugs: web address or email address for reporting bugs
  • repository: web page address used to access source code
  • include: list of files that need to be included when packaging. If not filled in, all files will be included by default.