mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +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>
44 lines
2.5 KiB
ReStructuredText
44 lines
2.5 KiB
ReStructuredText
.. _faq-service-packaging:
|
|
|
|
=============
|
|
Packaging FAQ
|
|
=============
|
|
|
|
.. contents::
|
|
:depth: 2
|
|
:local:
|
|
|
|
Do I need programming experience to package a service for StartOS?
|
|
------------------------------------------------------------------
|
|
It would be helpful, but is not a pre-requisite. Linux, dev-ops, and/or systems administration experience would all be helpful as well. Keep in mind that everyone has to start somewhere, and perhaps your journey to development begins with packaging a service for eOS!
|
|
|
|
What considerations are there when choosing a service for packaging?
|
|
--------------------------------------------------------------------
|
|
There are several things you will want to consider. Requirements include:
|
|
|
|
#. Most importantly, pick a service you are passionate about seeing on StartOS
|
|
#. Make sure it is :ref:`Open Source <open-source>`
|
|
#. A service that incorporates a 'self-hosting' option, or is capable of being self-hosted
|
|
|
|
Recommendations that may ease the process:
|
|
|
|
#. A service that has already been 'dockerized' (has a **working** ``Dockerfile``)
|
|
#. A service written in a language you are familiar with
|
|
#. A service with a strong community
|
|
|
|
You can check this expansive list if you are in search of ideas: `Awesome Self-Hosted <https://github.com/awesome-selfhosted/awesome-selfhosted>`_
|
|
|
|
What if I don't need a Config in my service?
|
|
--------------------------------------------
|
|
Config files can be empty( ``{}`` ), if you do not require config. `File Browser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/config_spec.yaml>`_ is an example of a service with no Config.
|
|
|
|
How can my service access the data directory of another service?
|
|
----------------------------------------------------------------
|
|
#. Provider service needs to expose datadir to other services on StartOS
|
|
#. Consumer services needs to list the provider service as a dependency AND set a particular config value, stating that it wants data from that particular service
|
|
|
|
Check out `LND <https://github.com/Start9Labs/lnd-wrapper/blob/master/manifest.yaml>`_ and `RTL <https://github.com/Start9Labs/ride-the-lightning-wrapper/blob/master/manifest.yaml>`_ as an example.
|
|
|
|
Why am I getting the error "No rule to make target yq, needed by manifest.yaml?"
|
|
--------------------------------------------------------------------------------
|
|
This is the message you get when you're missing the yq executable on your ``$PATH``. You can find details to `install yq here <https://github.com/mikefarah/yq#install>`_.` |