onecdonly / sortmyqpkgs Goto Github PK

Ensure your installed QPKGs start in a compatible sequence during NAS bootup

License: GNU General Public License v3.0

Shell 100.00%

qnap boot nas sorter bash qts linux shell-script automation ssh

sortmyqpkgs's Introduction

Description

SortMyQPKGs is an automated sorter for installed QPKGs to ensure they launch in correct sequence when your NAS next powers-up.

There are a few known packages need to launch sequentially (example: Qmono before QSonarr) but due to flaws in QNAP's package registration process, this may not occur.

This package will automatically ensure the launch-order of your other QPKGs is correct.

Every QPKG will fit into one of three possible groups:

ALPHA - must be launched before other packages, and in a specific order (these are high-level apps like command interpreters, virtual environments and the like),
UNSPECIFIED - the majority of QPKGs out there that are not explicitly named, but should be launched after ALPHA and before OMEGA packages,
OMEGA - packages that should be launched after everything else, and in a specific order. These are generally dependent on some other package.

The order is hardcoded into this QPKG but can be modified on request by posting in the forum topic. Please advise of new QPKGs to add and where on the current lists the new package should be placed. Only packages that must be placed correctly should be requested.

This package was initially suggested by @father_mande & @zyxmon in this thread, and is thanks to the research efforts of @zyxmon, @father_mande, myself and many other QNAP community members. Thank you to all who have contributed with feedback and suggestions.

Installation

Download the latest QPKG here.
Also available via sherpa.
And it's in the myQNAP repository.

Notes

When the sorter is installed, there's not much to see. Find the package icon and click the 'Open' button to display the current log file - any changes made to your package order will be shown here. Sorting is automatically performed during each NAS shutdown. No need to run it manually.
The log is viewable via your web browser but is not a real web document, so it can change without your browser noticing. Whenever viewing the log, ensure you force a page refresh: CTRL+F5.
The current internal order preference list can be viewed with:

    /etc/init.d/sortmyqpkgs.sh pref

Changelog

sortmyqpkgs's People

Contributors

Stargazers

Watchers

Forkers

timkatje esenzet gum0x1a jmzhuang mrlucas84

sortmyqpkgs's Issues

ERROR: SortMyQPKGs (20180320) [Sun Apr 1 15:49:30 PDT 2018] 'install' requested

I'm getting this error when I open the app in QNAP? Any tips? Newest OS.

SortMyQPKGs (20180320)
[Sun Apr 1 15:49:30 PDT 2018] 'install' requested

add system log entries for auto sort operations

add completion message to each log entry

Currently, a log entry is created with a requested action like 'install'. But nothing follows this.

Some users then think this action didn't complete. Fair enough.

log file needs a title

When opening the runtime log via the GUI, it's not readily apparent that you're only viewing a log. You haven't actually just run a sort operation.

Let's include a title that can be removed while prepending operations, then put back again.

ensure config block spacing is consistent throughout `qpkg.conf`

https://forum.qnap.com/viewtopic.php?p=857923#p857923

trim log entries

Only keep last 20 operations?

Qtransmission should be before NGiNX

Hello

I am using NGiNX to proxy to QTransmission webui.
And for some reason if it is in the current order:

...
(15) (Φ) NGinX
(21) (Ω) QTransmission

I need to restart QTransmission for WebUI to be avaialble through proxy.
Would the startup order fix that issue?

Thanks

not sorting packages when required!

Oh dear. 😞

[/share/Public] # /etc/init.d/sort-my-qpkgs.sh fix
ALPHA=default, OMEGA=default

 * Original order *
(01) (A) HideThatBanner
(02) (A) Entware
(03) (A) Python
(04) (Φ) QDK
(05) (Φ) QcloudSSLCertificate
(06) (Φ) sherpa
(07) (Φ) Par2
(08) (Φ) helpdesk
(09) (Ω) SABnzbd
(10) (Ω) MalwareRemover
(11) (Ω) SortMyQPKGs
(12) (Φ) sha3sum

 * New order *
(01) (A) HideThatBanner
(02) (A) Entware
(03) (A) Python
(04) (Φ) QDK
(05) (Φ) QcloudSSLCertificate
(06) (Φ) sherpa
(07) (Φ) Par2
(08) (Φ) helpdesk
(09) (Ω) SABnzbd
(10) (Ω) MalwareRemover
(11) (Ω) SortMyQPKGs
(12) (Φ) sha3sum

 Packages will be loaded in this order during next boot-up.

Something for me to investigate.

add comments for each input list item

Each ALPHA and OMEGA list item should have a short comment explaining why it's there.

allow custom ALPHA and OMEGA lists

These would be used instead of the preset lists.

QPKGs with '1' in the internal name are not being recognised correctly

Example here: https://pastebin.com/QgUKhB02 and was reported here: https://forum.qnap.com/viewtopic.php?p=748859#p748859

This might be due to the '1' being seen as a grep command option.

don't rewrite if order won't change

This will require a temporary sort to compare against the current order.

Qnapclub down

Hi it's impossible to add install your qpkg as the qnapclub is down since several days.

OMEGA.default lacks qBittorrent

OMEGA.default lacks qBittorrent (letter case sensitivity), which prevents qBittorrent from being sorted correctly and starts after QPython3xx.
After manually adding qBittorrent, it will be sorted normally. Please add qBittorrent in OMEGA.default in subsequent updates. Thank you!

not running on shutdown

[~] # head -n6 /etc/config/uLinux.conf 
[System]
Model=TS-XA28A
Internal Model = TS-XA28A
Server Comment = NAS Server
Version = 5.0.0
Build Number = 20220129

QPython310 is not loaded before qBittorrent

QPython310 is in the alpha list, but when I run sudo /etc/init.d/sortmyqpkgs.sh fix, the new order is:
(01) (A) netmgr
(02) (A) QJDK17
(03) (A) Apache80
(04) (A) MultimediaConsole
(05) (A) PlexMediaServer
(06) (A) HybridBackup
(07) (Φ) LicenseCenter
(08) (Φ) NotificationCenter
(09) (Φ) QuLog
(10) (Φ) ResourceMonitor
(11) (Φ) helpdesk
(12) (Φ) CloudLink
(13) (Φ) QDMS
(14) (Φ) QcloudSSLCertificate
(15) (Φ) Qboost
(16) (Φ) qBittorrent
(17) (Φ) RadarrDotNet80
(18) (Φ) JackettdotNET80
(19) (Φ) QPython310
(20) (Φ) Prowlarr80
(21) (Φ) SecurityCounselor
(22) (Φ) qufirewall
(23) (Φ) QDK
(24) (Ω) QBazarr
(25) (Ω) MalwareRemover
(26) (Ω) SortMyQPKGs

input lists should perform basic validation

Currently, ALPHA.list and OMEGA.list are blindly imported with zero checking. :(