Files
documentation/source/contributing/services/index.rst
Lucy Cifferello a099290fc7 examples and copy
2021-02-08 08:15:13 -07:00

27 lines
1.1 KiB
ReStructuredText

.. _service_sdk:
***********************
Service Packaging Guide
***********************
This technical guide covers the necessary steps to package up a service for deployment to an Embassy. To start, you will need to acquire :ref:`EmbassyOS <purchasing>` for testing the packaged service.
While you are waiting to assemble a device, you can begin the process of building your project in the format necessary to run on the Embassy. The sections below outline these steps in detail.
For reference, the `Hello world <https://github.com/Start9Labs/hello-world-wrapper>`_ repository should be used as an example. A project template can be cloned using the "Use this template" button in GitHub.
.. toctree::
:maxdepth: 2
Overview <overview>
Wrapper <wrapper>
Docker <docker>
Manifest <manifest>
Config <config>
Properties <properties>
Docs <docs>
Submission process
------------------
When you have built and tested your project for EmbassyOS, please send us a submission with the project repository to ``dev@start9labs.com``. Reach out with questions in the Matrix community `dev channel <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_.