Service Script Types - OneCDOnly/sherpa GitHub Wiki

An attempt to define the types of service-script required to support sherpa packaged applications:

• type 0 (or unspecified)

  Application is bundled within developer-maintained QPKG. Static release. Called on-demand. No TCP ports. Is usually made available to QTS via syminks.

  Examples: Entware, inxi, Par2, Par2turbo, sha3sum, SortMyQPKGs, Unrar
  
  

• type 1

  Application source is pulled/updated from an online repository before every start. Has a daemon that is launched with a language interpreter. Has TCP ports that can be queried. Backup supported.

  Examples: HeadPhones, LazyLibrarian, Medusa, Mylar3, SABnzbd, SickGear, Watcher3, Kapowarr, Tautulli
  
  

• type 2

  Application source is pulled/updated from an online repository before every start. Called on-demand. No TCP ports. Offers online scripts to be run locally via an interpreter. Backup supported.

  Example: nzbToMedia
  
  

• type 3

  Application is installed from Entware. Has a daemon. Has TCP ports that can be queried. Backup supported. Service-script provides enhancements to permit application to be stopped/started via QTS App Center.

  Examples: qBittorrent, Transmission
  
  

• type 4

  Application is installed from Entware. Called on-demand. No TCP ports. Backup unsupported. Service-script provides enhancements to permit application to be stopped/started via QTS App Center.

  Example: ClamAV
  
  

• type 5

  Application release archive is pulled/updated from an online repository. Has a daemon. Has TCP ports that can be queried. Backup supported.

  Examples: OliveTin, Sonarr, Lidarr, Readarr
  
  

• type 6

  Application is installed from PyPI. Has a daemon that is launched with a language interpreter. Has TCP ports that can be queried. Backup may be supported.

  Examples: Glances, pyLoad, WebSSH
  
  

• type 7

  Application is installed from PyPI. Called on-demand with a language interpreter. No TCP ports. Backup unsupported.

  Example: gpt-engineer
  
  

• type 8

  A mix of type 1 and type 5: application release archive is pulled/updated from an online repository. Has a daemon that is launched with a language interpreter. Has TCP ports that can be queried. Backup supported.

  Examples: NZBHydra2
  
  

• type 9

  Application is bundled within developer-maintained QPKG. Static release. Has a daemon. Has TCP ports that can be queried. Backup unsupported.

  Examples: NZBGet