Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 18:31:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

SPG 1st draft complete

Browse Source
This commit is contained in:
kn0wmad
2021-12-07 20:01:46 -07:00
committed by Lucy Cifferello
parent 4d6ae8b0e2
commit ff5871dd9a
3 changed files with 389 additions and 365 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
source/dev-docs/service-packaging/manifest.rst
View File

@@ -1,4 +1,4 @@
.. _manifest:
.. _service_manifest:
****************
Service Manifest
@@ -15,9 +15,9 @@ This file describes the service and it's requirements. It is used to:
Each time a service is updated, the manifest should be updated to include the new version, release notes, and any pertinent updates to the install, uninstall, or restoration flows. All this information is displayed in the marketplace listing, and the optionally denoted alerts will be displayed when appropriate to provide the user with more information.
For instance, `LND displays alerts <https://github.com/Start9Labs/lnd-wrapper/blob/master/manifest.yaml#L28>`_ around restoration since data will be overwritten.
For instance, `LND displays alerts <https://github.com/Start9Labs/lnd-wrapper/blob/master/manifest.yaml#L28>`_ around restoration since data will be overwritten.
There is nothing you need to do as a developer to set up Tor for running a service. This is *completely* handled by EmbassyOS - a Tor address will be automatically generated when the service is installed. Just define the port and which version of Tor the service needs in this manifest file! You do, however, need to ensure the service is in fact capable of running over Tor.
There is nothing you need to do as a developer to set up Tor for running a service. This is *completely* handled by EmbassyOS - a Tor address will be automatically generated when the service is installed. Just define the port and which version of Tor the service needs in this manifest file! You do, however, need to ensure the service is in fact capable of running over Tor.
The manifest is also responsible for outlining service :ref:`dependencies <dependencies>`. By defining rules using the :ref:`EmbassyOS DSL specification <config_rules>`, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. EmbassyOS presents this information in a polished install/uninstall/update wizard, so there's no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest!
@@ -349,4 +349,4 @@ Cups
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`
:raw-html:`<br />`