mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
* change embassyOS to StartOS & nuance * Update conf.py * Update manifest.rst * say start9 instead of embassy in two links * progress * scrubbed faqs - basic-use, lightning, service-packaging, services, startos * add a few fixes * more * more 'embassy' cleanup * more * the last of embassy (aside from sdk and cli commands, links, etc) * some fixes * update icon, logo, and theme * Update site/source/user-manual/upgrade-hardware/upgrade-pro.rst * Update site/source/developer-docs/packaging.rst * Update site/source/developer-docs/specification/config-spec.rst * Update site/source/learn/concepts/networks.rst * Update site/source/learn/concepts/networks.rst * Update site/source/user-manual/customize.rst * Update site/source/support/faq/faq-basic-use.rst * Update site/source/user-manual/upgrade-hardware/naspi-upgrade.rst * Update site/source/user-manual/upgrade-hardware/upgrade-pro.rst * Update site/source/support/faq/faq-bitcoin.rst * Update site/source/support/faq/faq-bitcoin.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-services.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-startos.rst * Update site/source/support/faq/faq-troubleshooting.rst * Update site/source/support/faq/faq-startos.rst * Minor fixes * Fix build errors, ready to roll * Add Beethoven * More fixes * More nother fix * More nother fixes agin * Remove sentence * cards instead --------- Co-authored-by: Matt Hill <matthewonthemoon@gmail.com> Co-authored-by: Shadowy Super Coder <musashidisciple@proton.me> Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Co-authored-by: kn0wmad <39687477+kn0wmad@users.noreply.github.com> Co-authored-by: agent <kn0wmad@protonmail.com>
33 lines
977 B
ReStructuredText
33 lines
977 B
ReStructuredText
.. _package:
|
|
|
|
==============
|
|
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:
|
|
|
|
.. code:: bash
|
|
|
|
embassy-sdk pack
|
|
|
|
Let's also make sure to verify the validity of the package:
|
|
|
|
.. code:: bash
|
|
|
|
embassy-sdk verify s9pk /path/to/hello-world.s9pk
|
|
|
|
If anything goes wrong, an error message will indicate the missing component or other failure. |