You are not reading the latest stable version of this documentation. If you want up-to-date information, please have a look at 0.3.5.x.

Packaging FAQ

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 StartOS!

What considerations are there when choosing a service for packaging?

There are several things you will want to consider. Requirements include:

  1. Most importantly, pick a service you are passionate about seeing on StartOS

  2. Make sure it is Open Source

  3. A service that incorporates a ‘self-hosting’ option, or is capable of being self-hosted

Recommendations that may ease the process:

  1. A service that has already been ‘dockerized’ (has a working Dockerfile)

  2. A service written in a language you are familiar with

  3. A service with a strong community

You can check this expansive list if you are in search of ideas: Awesome Self-Hosted

What if I don’t need a Config in my service?

Config files can be empty( {} ), if you do not require config. File Browser is an example of a service with no Config.

How can my service access the data directory of another service?

  1. Provider service needs to expose datadir to other services on StartOS

  2. 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 and RTL 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.`