Skip to content

Host Manifest.md

Latest commit

 

History

History
166 lines (96 loc) · 2.22 KB

Host Manifest.md

File metadata and controls

166 lines (96 loc) · 2.22 KB

Host Manifest

The host manifest file describes the relationship
between an application a browser extensions.


My Host Manifest.json

{
    "allowed_origins" : [ "<Extension Url>" ] ,
    "description" : "" ,
    "type" : "<Communication Type>" ,
    "path" : "<App Path>" ,
    "name" : "<App Id>"
}

» Check out the example



Name

Unique identifier that, in extensions,
is used to connect to one another.


Windows

For windows users, the appId is the name of the
registry key that points towards this host manifest.


Format

  • Cannot have multiple . in a row

  • Cannot start / end with .

  • a - Z 0 - 9 . _


Examples

  • microsoft.graph_editor.updater

  • mike00341.important_project

  • cakemakers.editor



Type

The communication interface used.
Currently only has one valid type.


Types


  • stdio

    Indicates communication with stdin / stdout



Description

A simple description of the native app.



Path

System path to the application that will be used
when in communication with the extension.


Relative

Relative paths start from this host manifest.

OS Windows Linux OSX
🟢 🔴 🔴

Examples


  • Relative

    /Editor.js

    With the manifest located in
    the same folder as Editor.js


  • Absolute

    C:/cakeMaker/Editor.js


Process

The current working directory will be set
to the folder of the binary as it is started.

C:\myApplication\App.exe
⤷ C:\myApplication\



Allowed Origins

A list of extensions that are allowed
to communicate with the native app.


Format

chrome-extension://<Extension Id>/


Extension Id

You can find your extension's
Id at chrome://extensions/


Example

chrome-extension://bgfcmdaggdanlogtkdephpqcojfbobmm/