Caution

You are not reading the latest stable version of this documentation. If you want up-to-date information, please have a look at 0.3.5.x.

Start9 Docs Developer Docs Specification Package Bundle

Package Bundle¶

All assets get bundled into a custom filetype with an extension of .s9pk, short for Start9 Package. This is the file that will be downloaded from a marketplace. When the user clicks a service’s “Install” button, StartOS unpacks and installs the service.

The minimum necessary files for this bundle are:

image.tar (the result of a Dockerfile build)
instructions.md
LICENSE
icon.png

Each new version release of a service should include the updated version of these files re-bundled into a new .s9pk. .

Building¶

To package all components into an .s9pk, run the following command from the root of your project directory:

embassy-sdk pack

Let’s also make sure to verify the validity of the package:

embassy-sdk verify s9pk /path/to/hello-world.s9pk

If anything goes wrong, an error message will indicate the missing component or other failure.