mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
60f83aa683
* 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>
51 lines
1.6 KiB
ReStructuredText
51 lines
1.6 KiB
ReStructuredText
.. _service_wrapper:
|
|
|
|
=======
|
|
Wrapper
|
|
=======
|
|
|
|
Each service is bound with a wrapper repository, which contains everything you need to build a service.
|
|
|
|
The purpose of this repo is:
|
|
|
|
- To define the necessary Manifest and configuration options (ie. config spec and rules)
|
|
- To build the project into the ``.s9pk`` format digestible to StartOS
|
|
- Link to the source project as a git submodule
|
|
- Define the Dockerfile for running the project on StartOS
|
|
- Provide documentation for the project, especially user runbook instructions
|
|
|
|
File Structure
|
|
--------------
|
|
|
|
The project structure should be used as a model:
|
|
|
|
.. code-block:: bash
|
|
|
|
├── Dockerfile
|
|
├── LICENSE
|
|
├── Makefile
|
|
├── README.md
|
|
├── assets
|
|
│ └── compat
|
|
│ ├── config_rules.yaml
|
|
│ └── config_spec.yaml
|
|
├── docker_entrypoint.sh
|
|
├── <submodule-project>
|
|
├── <package-id>>.s9pk
|
|
├── icon.png
|
|
├── image.tar
|
|
├── instructions.md
|
|
└── manifest.yaml
|
|
|
|
|
|
Submodule
|
|
---------
|
|
|
|
`Git submodules <https://www.git-scm.com/book/en/v2/Git-Tools-Submodules>`__ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that its context is available. The submodule is added into the wrapper so that the wrapper can build the submodule and also track the exact code that's being built.
|
|
|
|
Run:
|
|
|
|
.. code:: bash
|
|
|
|
git submodule add <link_to_source_project>
|