Merge pull request #130 from mag37/osx_support

Some osx / bsd compatibility changes.
Rewritten the dependency (jq + regctl) install method.
Many thanks to @pshannon-git for testing!

.gitignore

@@ -0,0 +1,5 @@
+# ignore users custom notify.sh
+/notify.sh
+/urls.list
+# ignore the auto-installed regctl
+regctl

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+    - id: check-yaml
+    - id: check-added-large-files
+    - id: trailing-whitespace
+      args: [--markdown-linebreak-ext=md]
+    - id: end-of-file-fixer
+    - id: mixed-line-ending
+      args: ['--fix=lf']

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,32 +1,60 @@
-# dockcheck
-### A script checking updates for docker images **without the need of pulling** - then having the option to auto-update either all or selecting specific containers.
+<p align="center">
+  <img src="extras/dockcheck_logo_by_booYah187.png" width="160" title="dockcheck">
+</p>
+<p align="center">
+  <img src="https://img.shields.io/badge/bash-4.3-green?style=flat-square&logo=gnubash" alt="bash">
+  <a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/badge/license-GPLv3-red?style=flat-square" alt="GPLv3"></a>
+  <img src="https://img.shields.io/github/v/tag/mag37/dockcheck?style=flat-square&label=release" alt="release">
+  <a href="https://ko-fi.com/mag37"><img src="https://img.shields.io/badge/-Ko--fi-grey?style=flat-square&logo=Ko-fi" alt="Buy me a Coffee"></a>
+  <a href="https://liberapay.com/user-bin-rob/donate"><img src="https://img.shields.io/badge/-LiberaPay-grey?style=flat-square&logo=liberapay" alt="LiberaPay"></a>
+  <a href="https://github.com/sponsors/mag37"><img src="https://img.shields.io/badge/-Sponsor-grey?style=flat-square&logo=github" alt="Github Sponsor"></a>
+</p>
 
-With the help of [`regctl`](https://github.com/regclient/regclient). This is just a concept for inspiration, use with care.
+<h2 align="center">CLI tool to automate docker image updates or notifying when updates are available.</h2>
+<h3 align="center">Features:</h3>
+<h3 align="center">selective updates, exclude containers, custom labels, notification plugins, prune when done and more.</h3>
+
+<h4 align="center">For Podman - see the fork <a href="https://github.com/sudo-kraken/podcheck">sudo-kraken/podcheck</a>!</h4>
+
+___
+## :bell: Changelog
+
+- **v0.5.5.0**: osx and bsd compatibility changes + rewrite of dependency installer
+- **v0.5.4.0**: Added support for a Prometheus+node_exporter metric collection through a file collector.
+- **v0.5.3.0**: Local image check changed (use imageId instead of name) and Gotify-template fixed (whale icon removed).
+- **v0.5.2.1**: Rewrite of dependency downloads, jq can be installed with package manager or static binary.
+- **v0.5.1**: DEPENDENCY WARNING: now requires **jq**. + Upstreaming changes from [sudo-kraken/podcheck](https://github.com/sudo-kraken/podcheck)
 ___
 
-## Dependencies:
-Running docker (duh) and compose, either standalone or plugin.   
-`regctl` by [regclient](https://github.com/regclient/regclient)  
-The script will ask to download `regctl` if it's not in PATH or current directory.
-___
-## `dockcheck.sh`
-```bash
+
+![](extras/example.gif)
+
+## :mag_right: `dockcheck.sh`
+```
 $ ./dockcheck.sh -h
 Syntax:     dockcheck.sh [OPTION] [part of name to filter]
-Example:    dockcheck.sh -a ng
+Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall
 
-Options:
--h     Print this Help.
+Options:"
 -a|y   Automatic updates, without interaction.
+-c D   Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory.
+-d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
+-e X   Exclude containers, separated by comma.
+-f     Force stack restart after update. Caution: restarts once for every updated container within stack.
+-h     Print this Help.
+-i     Inform - send a preconfigured notification.
+-l     Only update if label is set. See readme.
+-m     Monochrome mode, no printf color codes.
 -n     No updates, only checking availability.
+-p     Auto-Prune dangling images after update.
+-r     Allow updating images for docker run, wont update the container.
+-s     Include stopped containers in the check. (Logic: docker ps -a).
+-t     Set a timeout (in seconds) per container for registry checkups, 10 is default.
+-v     Prints current version.
 ```
 
-
-
-![](https://github.com/mag37/dockcheck/blob/main/example_run.gif)
-
-Basic example:
-```bash
+### Basic example:
+```
 $ ./dockcheck.sh
 . . .
 Containers on latest version:
@@ -34,59 +62,152 @@ glances
 homer
 
 Containers with updates available:
-0) ALL
 1) adguardhome
 2) syncthing
 3) whoogle-search
 
-
-Do you want to update? y/[n] y
-What containers do you like to update? 
-Enter number(s) separated by comma: 1,3
-
+Choose what containers to update:
+Enter number(s) separated by comma, [a] for all - [q] to quit:
 ```
-Then it proceedes to run `pull` and `up -d` on every container with updates.   
+Then it proceeds to run `pull` and `up -d` on every container with updates.  
+After the updates are complete, you'll get prompted if you'd like to prune dangling images.
+
+___
+
+## :nut_and_bolt: Dependencies
+- Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck)  
+- Bash shell or compatible shell of at least v4.3
+- [jq](https://github.com/jqlang/jq)
+  - User will be prompted to install with package manager or download static binary.
+- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))  
+  - User will be prompted to download `regctl` if not in `PATH` or `PWD`.  
+  - regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
+
+## :tent: Install Instructions
+Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.   
+For OSX/macOS preferably use `/usr/local/bin`.
+```sh
+# basic example with curl:
+curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o ~/.local/bin/dockcheck.sh
+chmod +x ~/.local/bin/dockcheck.sh
+
+# or oneliner with wget:
+wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" && chmod +x ~/.local/bin/dockcheck.sh
+
+# OSX or macOS version with curl:
+ curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o /usr/local/bin/dockcheck.sh && chmod +x /usr/local/bin/dockcheck.sh
+```
+Then call the script anywhere with just `dockcheck.sh`.
+Add preferred `notify.sh`-template to the same directory - this will not be touched by the scripts self-update function.
 
 
+## :loudspeaker: Notifications
+Trigger with the `-i` flag.  
+Run it scheduled with `-ni` to only get notified when there's updates available!  
 
-And with `-n` *No updates* and `gl` for `*gl*` filtering:
-```bash
-$ ./dockcheck.sh -n gl
-. . .
-Containers with updates available:
-whoogle-search
+Use a `notify_X.sh` template file from the **notify_templates** directory, copy it to `notify.sh` alongside the script, modify it to your needs! (notify.sh is added to .gitignore)  
+**Current templates:**
+- Synology [DSM](https://www.synology.com/en-global/dsm)
+- Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
+- Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications)
+  - both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api)
+  - Read the [QuickStart](extras/apprise_quickstart.md)
+- [ntfy.sh](https://ntfy.sh/) - HTTP-based pub-sub notifications.
+- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
+- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
+- [Telegram](https://telegram.org/) - Telegram chat API.
+- [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication.
+- [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops)
+- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks.
 
-Containers on latest version:
-glances
+Further additions are welcome - suggestions or PR!  
+<sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>  
 
-No updates installed, exiting
+### :date: Release notes addon to Notifications
+There's a function to use a lookup-file to add release note URL's to the notification message.  
+Copy the notify_templates/`urls.list` file to the script directory, it will be used automatically if it's there.   Modify it as necessary, the names of interest in the left column needs to match your container names.  
+The output of the notification will look something like this:
+```
+Containers on hostname with updates available:
+apprise-api  ->  https://github.com/linuxserver/docker-apprise-api/releases
+homer  ->  https://github.com/bastienwirtz/homer/releases
+nginx  ->  https://github.com/docker-library/official-images/blob/master/library/nginx
+...
+```
+The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists.
+
+## :chart_with_upwards_trend: Prometheus and node_exporter
+Dockcheck can be used together with [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter) to export metrics via the file collector, scheduled with cron or likely.
+This is done with the `-c` option, like this:
+```
+dockcheck.sh -c /path/to/exporter/directory
 ```
 
-### :beetle: Squashed Bugs:
-- ~~No options for running without updates or auto update.~~
-- ~~No filter to check only specific containers.~~
-- ~~Faulty registry checkups stopped the updates completely.~~
-- ~~No clear checks to skip containers producing errors.~~
-- ~~Multi-digest images didn't correctly check with registry, giving false positives on updates.~~
+See the [README.md](./addons/prometheus/README.md) for more detailed information on how to set it up!
 
-### :hammer: Known issues
-- ~~No granular choice of what to update (except initial name filter).~~
-- No detailed error feedback (just skip + list what's skipped) .
+<sub><sup>Contributed by [tdralle](https://github.com/tdralle).</sup></sub>  
 
-## `dockcheck_docker-run_ver.sh`
-### Wont auto-update the containers, only their images. (compose is recommended)
-Alternative version for people who use `docker run` and no composes.   
+## :bookmark: Labels
+Optionally add labels to compose-files. Currently these are the usable labels:
+```
+    labels:
+      mag37.dockcheck.restart-stack: true
+      mag37.dockcheck.update: true
+```
+- `mag37.dockcheck.restart-stack: true` works instead of the `-f` option, forcing stop+restart on the whole compose-stack (Caution: Will restart on every updated container within stack).
+- `mag37.dockcheck.update: true` will when used with the `-l` option only update containers with this label and skip the rest. Will still list updates as usual.
+
+## :roller_coaster: Workaround for non **amd64** / **arm64**
+`regctl` provides binaries for amd64/arm64, to use on other architecture you could try this workaround.
+Run regctl in a container wrapped in a shell script. Copied from [regclient/docs/install.md](https://github.com/regclient/regclient/blob/main/docs/install.md):
+
+```sh
+cat >regctl <<EOF
+#!/bin/sh
+opts=""
+case "\$*" in
+  "registry login"*) opts="-t";;
+esac
+docker container run \$opts -i --rm --net host \\
+  -u "\$(id -u):\$(id -g)" -e HOME -v \$HOME:\$HOME \\
+  -v /etc/docker/certs.d:/etc/docker/certs.d:ro \\
+  ghcr.io/regclient/regctl:latest "\$@"
+EOF
+chmod 755 regctl
+```
+Test it with `./regctl --help` and then either add the file to the same path as *dockcheck.sh* or in your path (eg. `~/.local/bin/regctl`).
+
+## :guardsman: Function to auth with docker hub before running
+**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
+```sh
+function dchk {
+  cat ~/pwd.txt | docker login --username YourUser --password-stdin
+  ~/dockcheck.sh "$@"
+}
+```
+
+## :hammer: Known issues
+- No detailed error feedback (just skip + list what's skipped).
+- Not respecting `--profile` options when re-creating the container.
+- Not working well with containers created by **Portainer**.
+- **Watchtower** might cause issues due to retagging images when checking for updates (and thereby pulling new images).
+
+## :warning: `-r flag` disclaimer and warning
+**Wont auto-update the containers, only their images. (compose is recommended)**  
 `docker run` dont support using new images just by restarting a container.  
-Containers need to be stopped, removed and created again to run on the new image.
+Containers need to be manually stopped, removed and created again to run on the new image.
 
+## :wrench: Debugging
+If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues.
+Another option is to run the main script with debugging in a subshell `bash -x dockcheck.sh` - if there's a particular container/image that's causing issues you can filter for just that through `bash -x dockcheck.sh nginx`.
 
-## `dupc_function.sh`
-Function to quickly check for updates on a single contianer or list of containers by name. **Without the need of pulling**.  
-Preferably placed in `.bashrc` or similar.
-Example:
-```
-$ dupc ng
-Updates available for local_nginx.
-nginx_reverse is already latest.
-Updates available for paperless-ng.
-```
+## :scroll: License
+dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
+
+## :heartpulse: Sponsorlist
+
+- [avegy](https://github.com/avegy)
+
+___
+
+### :floppy_disk: The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect.

addons/prometheus/README.md

@@ -0,0 +1,61 @@
+## [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter)
+Dockcheck is capable to export metrics to prometheus via the text file collector provided by the node_exporter.
+In order to do so the -c flag has to be specified followed by the file path that is configured in the text file collector of the node_exporter.
+A simple cron job can be configured to export these metrics on a regular interval as shown in the sample below:
+
+```
+0 1 * * * /root/dockcheck.sh -n -c /var/lib/node_exporter/textfile_collector
+```
+
+The following metrics are exported to prometheus
+
+```
+# HELP dockcheck_images_analyzed Docker images that have been analyzed
+# TYPE dockcheck_images_analyzed gauge
+dockcheck_images_analyzed 22
+# HELP dockcheck_images_outdated Docker images that are outdated
+# TYPE dockcheck_images_outdated gauge
+dockcheck_images_outdated 7
+# HELP dockcheck_images_latest Docker images that are outdated
+# TYPE dockcheck_images_latest gauge
+dockcheck_images_latest 14
+# HELP dockcheck_images_error Docker images with analysis errors
+# TYPE dockcheck_images_error gauge
+dockcheck_images_error 1
+# HELP dockcheck_images_analyze_timestamp_seconds Last dockercheck run time
+# TYPE dockcheck_images_analyze_timestamp_seconds gauge
+dockcheck_images_analyze_timestamp_seconds 1737924029
+```
+
+Once those metrics are exported they can be used to define alarms as shown below
+
+```
+- alert: dockcheck_images_outdated
+  expr: sum by(instance) (dockcheck_images_outdated) > 0
+  for: 15s
+  labels:
+    severity: warning
+  annotations:
+    summary: "{{ $labels.instance }} has {{ $value }} outdated docker images."
+    description: "{{ $labels.instance }} has {{ $value }} outdated docker images."
+- alert: dockcheck_images_error
+  expr: sum by(instance) (dockcheck_images_error) > 0
+  for: 15s
+  labels:
+    severity: warning
+  annotations:
+    summary: "{{ $labels.instance }} has {{ $value }} docker images having an error."
+    description: "{{ $labels.instance }} has {{ $value }} docker images having an error."
+- alert: dockercheck_image_last_analyze
+  expr: (time() - dockcheck_images_analyze_timestamp_seconds) > (3600 * 24 * 3)
+  for: 15s
+  labels:
+    severity: warning
+  annotations:
+    summary: "{{ $labels.instance }} has not updated the dockcheck statistics for more than  3 days."
+    description: "{{ $labels.instance }} has not updated the dockcheck statistics for more than 3 days."
+```
+
+There is a reference Grafana dashboard in [grafana/grafana_dashboard.json](./grafana/grafana_dashboard.json).
+
+![](./grafana/grafana_dashboard.png)

addons/prometheus/grafana/grafana_dashboard.json

@@ -0,0 +1,382 @@
+{
+  "__inputs": [
+    {
+      "name": "DS_PROMETHEUS",
+      "label": "prometheus",
+      "description": "",
+      "type": "datasource",
+      "pluginId": "prometheus",
+      "pluginName": "Prometheus"
+    }
+  ],
+  "__elements": {},
+  "__requires": [
+    {
+      "type": "grafana",
+      "id": "grafana",
+      "name": "Grafana",
+      "version": "11.4.0"
+    },
+    {
+      "type": "datasource",
+      "id": "prometheus",
+      "name": "Prometheus",
+      "version": "1.0.0"
+    },
+    {
+      "type": "panel",
+      "id": "table",
+      "name": "Table",
+      "version": ""
+    }
+  ],
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": {
+          "type": "grafana",
+          "uid": "-- Grafana --"
+        },
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "editable": true,
+  "fiscalYearStartMonth": 0,
+  "graphTooltip": 0,
+  "id": null,
+  "links": [],
+  "panels": [
+    {
+      "datasource": {
+        "type": "prometheus",
+        "uid": "${DS_PROMETHEUS}"
+      },
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "thresholds"
+          },
+          "custom": {
+            "align": "auto",
+            "cellOptions": {
+              "type": "auto"
+            },
+            "inspect": false
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": [
+          {
+            "matcher": {
+              "id": "byName",
+              "options": "last_analyze_timestamp"
+            },
+            "properties": [
+              {
+                "id": "unit",
+                "value": "dateTimeAsIso"
+              }
+            ]
+          },
+          {
+            "matcher": {
+              "id": "byName",
+              "options": "last_analyze_since"
+            },
+            "properties": [
+              {
+                "id": "unit",
+                "value": "s"
+              },
+              {
+                "id": "custom.cellOptions",
+                "value": {
+                  "mode": "gradient",
+                  "type": "color-background"
+                }
+              },
+              {
+                "id": "thresholds",
+                "value": {
+                  "mode": "absolute",
+                  "steps": [
+                    {
+                      "color": "green",
+                      "value": null
+                    },
+                    {
+                      "color": "red",
+                      "value": 259200
+                    }
+                  ]
+                }
+              }
+            ]
+          },
+          {
+            "matcher": {
+              "id": "byName",
+              "options": "images_outdated"
+            },
+            "properties": [
+              {
+                "id": "custom.cellOptions",
+                "value": {
+                  "mode": "gradient",
+                  "type": "color-background"
+                }
+              },
+              {
+                "id": "thresholds",
+                "value": {
+                  "mode": "absolute",
+                  "steps": [
+                    {
+                      "color": "green",
+                      "value": null
+                    },
+                    {
+                      "color": "red",
+                      "value": 1
+                    }
+                  ]
+                }
+              }
+            ]
+          },
+          {
+            "matcher": {
+              "id": "byName",
+              "options": "images_error"
+            },
+            "properties": [
+              {
+                "id": "custom.cellOptions",
+                "value": {
+                  "mode": "gradient",
+                  "type": "color-background"
+                }
+              },
+              {
+                "id": "thresholds",
+                "value": {
+                  "mode": "absolute",
+                  "steps": [
+                    {
+                      "color": "green",
+                      "value": null
+                    },
+                    {
+                      "color": "red",
+                      "value": 1
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        ]
+      },
+      "gridPos": {
+        "h": 14,
+        "w": 24,
+        "x": 0,
+        "y": 0
+      },
+      "id": 2,
+      "options": {
+        "cellHeight": "sm",
+        "footer": {
+          "countRows": false,
+          "fields": "",
+          "reducer": [
+            "sum"
+          ],
+          "show": false
+        },
+        "frameIndex": 1,
+        "showHeader": true,
+        "sortBy": []
+      },
+      "pluginVersion": "11.4.0",
+      "targets": [
+        {
+          "disableTextWrap": false,
+          "editorMode": "code",
+          "exemplar": false,
+          "expr": "sum by(instance) (dockcheck_images_analyzed)",
+          "format": "table",
+          "fullMetaSearch": false,
+          "hide": false,
+          "includeNullMetadata": true,
+          "instant": true,
+          "interval": "",
+          "legendFormat": "{{instance}}",
+          "range": false,
+          "refId": "dockcheck_images_analyzed",
+          "useBackend": false,
+          "datasource": {
+            "type": "prometheus",
+            "uid": "${DS_PROMETHEUS}"
+          }
+        },
+        {
+          "datasource": {
+            "type": "prometheus",
+            "uid": "${DS_PROMETHEUS}"
+          },
+          "disableTextWrap": false,
+          "editorMode": "code",
+          "exemplar": false,
+          "expr": "sum by(instance) (dockcheck_images_outdated)",
+          "format": "table",
+          "fullMetaSearch": false,
+          "hide": false,
+          "includeNullMetadata": true,
+          "instant": true,
+          "legendFormat": "{{instance}}",
+          "range": false,
+          "refId": "dockcheck_images_outdated",
+          "useBackend": false
+        },
+        {
+          "datasource": {
+            "type": "prometheus",
+            "uid": "${DS_PROMETHEUS}"
+          },
+          "disableTextWrap": false,
+          "editorMode": "code",
+          "exemplar": false,
+          "expr": "sum by(instance) (dockcheck_images_latest)",
+          "format": "table",
+          "fullMetaSearch": false,
+          "hide": false,
+          "includeNullMetadata": true,
+          "instant": true,
+          "legendFormat": "{{instance}}",
+          "range": false,
+          "refId": "dockcheck_images_latest",
+          "useBackend": false
+        },
+        {
+          "datasource": {
+            "type": "prometheus",
+            "uid": "${DS_PROMETHEUS}"
+          },
+          "editorMode": "code",
+          "exemplar": false,
+          "expr": "sum by(instance) (dockcheck_images_error)",
+          "format": "table",
+          "hide": false,
+          "instant": true,
+          "legendFormat": "{{instance}}",
+          "range": false,
+          "refId": "dockcheck_images_error"
+        },
+        {
+          "datasource": {
+            "type": "prometheus",
+            "uid": "${DS_PROMETHEUS}"
+          },
+          "editorMode": "code",
+          "exemplar": false,
+          "expr": "dockcheck_images_analyze_timestamp_seconds * 1000",
+          "format": "table",
+          "hide": false,
+          "instant": true,
+          "legendFormat": "{{instance}}",
+          "range": false,
+          "refId": "dockcheck_images_analyze_timestamp_seconds"
+        },
+        {
+          "datasource": {
+            "type": "prometheus",
+            "uid": "${DS_PROMETHEUS}"
+          },
+          "editorMode": "code",
+          "exemplar": false,
+          "expr": "time() - dockcheck_images_analyze_timestamp_seconds",
+          "format": "table",
+          "hide": false,
+          "instant": true,
+          "legendFormat": "{{instance}}",
+          "range": false,
+          "refId": "dockcheck_images_last_analyze"
+        }
+      ],
+      "title": "Dockcheck Status",
+      "transformations": [
+        {
+          "id": "merge",
+          "options": {}
+        },
+        {
+          "id": "organize",
+          "options": {
+            "excludeByName": {
+              "Time": true,
+              "__name__": true,
+              "job": true
+            },
+            "includeByName": {},
+            "indexByName": {
+              "Time": 0,
+              "Value #dockcheck_images_analyze_timestamp_seconds": 2,
+              "Value #dockcheck_images_analyzed": 4,
+              "Value #dockcheck_images_error": 7,
+              "Value #dockcheck_images_last_analyze": 3,
+              "Value #dockcheck_images_latest": 5,
+              "Value #dockcheck_images_outdated": 6,
+              "instance": 1,
+              "job": 8
+            },
+            "renameByName": {
+              "Value #A": "analyze_timestamp",
+              "Value #dockcheck_images_analyze_timestamp_seconds": "last_analyze_timestamp",
+              "Value #dockcheck_images_analyzed": "images_analyzed",
+              "Value #dockcheck_images_error": "images_error",
+              "Value #dockcheck_images_last_analyze": "last_analyze_since",
+              "Value #dockcheck_images_latest": "images_latest",
+              "Value #dockcheck_images_outdated": "images_outdated"
+            }
+          }
+        }
+      ],
+      "type": "table"
+    }
+  ],
+  "schemaVersion": 40,
+  "tags": [],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "now-6h",
+    "to": "now"
+  },
+  "timepicker": {},
+  "timezone": "browser",
+  "title": "Dockcheck Status",
+  "uid": "feb4pv3kv1hxca",
+  "version": 17,
+  "weekStart": ""
+}

addons/prometheus/prometheus_collector.sh

@@ -0,0 +1,28 @@
+prometheus_exporter() {
+  checkedImages=$(($1 + $2 + $3))
+  checkTimestamp=$(date +%s)
+  
+  promFileContent=()
+  promFileContent+=("# HELP dockcheck_images_analyzed Docker images that have been analyzed")
+  promFileContent+=("# TYPE dockcheck_images_analyzed gauge")
+  promFileContent+=("dockcheck_images_analyzed $checkedImages")
+  
+  promFileContent+=("# HELP dockcheck_images_outdated Docker images that are outdated")
+  promFileContent+=("# TYPE dockcheck_images_outdated gauge")
+  promFileContent+=("dockcheck_images_outdated ${#GotUpdates[@]}")
+
+  promFileContent+=("# HELP dockcheck_images_latest Docker images that are outdated")
+  promFileContent+=("# TYPE dockcheck_images_latest gauge")
+  promFileContent+=("dockcheck_images_latest ${#NoUpdates[@]}")
+  
+  promFileContent+=("# HELP dockcheck_images_error Docker images with analysis errors")
+  promFileContent+=("# TYPE dockcheck_images_error gauge")
+  promFileContent+=("dockcheck_images_error ${#GotErrors[@]}")
+  
+  promFileContent+=("# HELP dockcheck_images_analyze_timestamp_seconds Last dockercheck run time")
+  promFileContent+=("# TYPE dockcheck_images_analyze_timestamp_seconds gauge")
+  promFileContent+=("dockcheck_images_analyze_timestamp_seconds $checkTimestamp")
+  
+  printf "%s\n" "${promFileContent[@]}" > "$CollectorTextFileDirectory/dockcheck_info.prom\$\$"
+  mv -f "$CollectorTextFileDirectory/dockcheck_info.prom\$\$" "$CollectorTextFileDirectory/dockcheck_info.prom"
+}

dockcheck.sh

@@ -1,137 +1,408 @@
-#!/bin/bash
+#!/usr/bin/env bash
+VERSION="v0.5.5.0"
+### ChangeNotes: osx and bsd compatibility changes + rewrite of dependency installer
+Github="https://github.com/mag37/dockcheck"
+RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
-# Help Function:
+# Variables for self updating
+ScriptArgs=( "$@" )
+ScriptPath="$(readlink -f "$0")"
+ScriptWorkDir="$(dirname "$ScriptPath")"
+
+# Check if there's a new release of the script
+LatestRelease="$(curl -s -r 0-50 $RawUrl | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
+LatestChanges="$(curl -s -r 0-200 $RawUrl | sed -n "/ChangeNotes/s/# ChangeNotes: //p")"
+
+# Help Function
 Help() {
-  echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]" 
-  echo "Example:    dockcheck.sh -a ng"
+  echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]"
+  echo "Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall"
   echo
   echo "Options:"
-  echo "-h     Print this Help."
   echo "-a|y   Automatic updates, without interaction."
-  echo "-n     No updates, only checking availability."
+  echo "-c     Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory."
+  echo "-d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
+  echo "-e X   Exclude containers, separated by comma."
+  echo "-f     Force stack restart after update. Caution: restarts once for every updated container within stack."
+  echo "-h     Print this Help."
+  echo "-i     Inform - send a preconfigured notification."
+  echo "-l     Only update if label is set. See readme."
+  echo "-m     Monochrome mode, no printf color codes."
+  echo "-n     No updates; only checking availability."
+  echo "-p     Auto-prune dangling images after update."
+  echo "-r     Allow updating images for docker run; won't update the container."
+  echo "-s     Include stopped containers in the check. (Logic: docker ps -a)."
+  echo "-t     Set a timeout (in seconds) per container for registry checkups, 10 is default."
+  echo "-v     Prints current version."
+  echo
+  echo "Project source: $Github"
 }
 
-while getopts "aynh" options; do
+# Colors
+c_red="\033[0;31m"
+c_green="\033[0;32m"
+c_yellow="\033[0;33m"
+c_blue="\033[0;34m"
+c_teal="\033[0;36m"
+c_reset="\033[0m"
+
+Timeout=10
+Stopped=""
+while getopts "aynpfrhlisvmc:e:d:t:" options; do
   case "${options}" in
-    a|y) UpdYes="yes" ;;
-    n) UpdYes="no" ;;
-    h|*) Help ; exit 0 ;;
+    a|y) AutoUp="yes" ;;
+    c)   CollectorTextFileDirectory="${OPTARG}"
+         if ! [[ -d  $CollectorTextFileDirectory ]] ; then { printf "The directory (%s) does not exist.\n" "${CollectorTextFileDirectory}"  ; exit 2; } fi ;;
+    n)   AutoUp="no" ;;
+    r)   DRunUp="yes" ;;
+    p)   AutoPrune="yes" ;;
+    l)   OnlyLabel=true ;;
+    f)   ForceRestartStacks=true ;;
+    i)   [ -s "$ScriptWorkDir"/notify.sh ] && { source "$ScriptWorkDir"/notify.sh ; Notify="yes" ; } ;;
+    e)   Exclude=${OPTARG} ;;
+    m)   declare c_{red,green,yellow,blue,teal,reset}="" ;;
+    s)   Stopped="-a" ;;
+    t)   Timeout="${OPTARG}" ;;
+    v)   printf "%s\n" "$VERSION" ; exit 0 ;;
+    d)   DaysOld=${OPTARG}
+         if ! [[ $DaysOld =~ ^[0-9]+$ ]] ; then { printf "Days -d argument given (%s) is not a number.\n" "${DaysOld}" ; exit 2 ; } ; fi ;;
+    h|*) Help ; exit 2 ;;
   esac
 done
 shift "$((OPTIND-1))"
 
-### Set $1 to a variable for later
-SearchName="$1"
-
-### Check if required binary exists in PATH or directory:
-if [[ $(builtin type -P "regctl") ]]; then 
-  regbin="regctl"
-elif [[ -f "./regctl" ]]; then
-  regbin="./regctl"
-else
-  printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n] "
-  read GetDep
-  if [ "$GetDep" != "${GetDep#[Yy]}" ]; then
-    ### Check arch:
-    case "$(uname --machine)" in
-      x86_64|amd64) architecture="amd64" ;;
-      arm64|aarch64) architecture="arm64";;
-      *) echo "Architecture not supported, exiting." ; exit ;;
-    esac
-    curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture >./regctl
-    chmod 755 ./regctl
-    regbin="./regctl"
+# Self-update function
+self_update_curl() {
+  cp "$ScriptPath" "$ScriptPath".bak
+  if [[ $(command -v curl) ]]; then
+    curl -L $RawUrl > "$ScriptPath" ; chmod +x "$ScriptPath"
+    printf "\n%s\n" "--- starting over with the updated version ---"
+    exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
+    exit 1 # Exit the old instance
+  elif [[ $(command -v wget) ]]; then
+    wget $RawUrl -O "$ScriptPath" ; chmod +x "$ScriptPath"
+    printf "\n%s\n" "--- starting over with the updated version ---"
+    exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
+    exit 1 # Exit the old instance
   else
-    printf "%s\n" "Dependency missing, quitting."
-    exit
+    printf "curl/wget not available - download the update manually: %s \n" "$Github"
+  fi
+}
+
+self_update() {
+  cd "$ScriptWorkDir" || { printf "Path error, skipping update.\n" ; return ; }
+  if [[ $(command -v git) ]] && [[ "$(git ls-remote --get-url 2>/dev/null)" =~ .*"mag37/dockcheck".* ]] ; then
+    printf "\n%s\n" "Pulling the latest version."
+    git pull --force || { printf "Git error, manually pull/clone.\n" ; return ; }
+    printf "\n%s\n" "--- starting over with the updated version ---"
+    cd - || { printf "Path error.\n" ; return ; }
+    exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
+    exit 1 # exit the old instance
+  else
+    cd - || { printf "Path error.\n" ; return ; }
+    self_update_curl
+  fi
+}
+
+# Choose from list function
+choosecontainers() {
+  while [[ -z "$ChoiceClean" ]]; do
+    read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice
+    if [[ "$Choice" =~ [qQnN] ]] ; then
+      exit 0
+    elif [[ "$Choice" =~ [aAyY] ]] ; then
+      SelectedUpdates=( "${GotUpdates[@]}" )
+      ChoiceClean=${Choice//[,.:;]/ }
+    else
+      ChoiceClean=${Choice//[,.:;]/ }
+      for CC in $ChoiceClean ; do
+        if [[ "$CC" -lt 1 || "$CC" -gt $UpdCount ]] ; then # Reset choice if out of bounds
+          echo "Number not in list: $CC" ; unset ChoiceClean ; break 1
+        else
+          SelectedUpdates+=( "${GotUpdates[$CC-1]}" )
+        fi
+      done
+    fi
+  done
+  printf "\nUpdating containers:\n"
+  printf "%s\n" "${SelectedUpdates[@]}"
+  printf "\n"
+}
+
+datecheck() {
+  ImageDate=$($regbin -v error image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1 )
+  ImageEpoch=$(date -d "$ImageDate" +%s 2>/dev/null) || ImageEpoch=$(date -f "%Y-%m-%d" -j "$ImageDate" +%s)
+  ImageAge=$(( ( $(date +%s) - $ImageEpoch )/86400 ))
+  if [ "$ImageAge" -gt "$DaysOld" ] ; then
+    return 0
+  else
+    return 1
+  fi
+}
+
+progress_bar() {
+  QueCurrent="$1"
+  QueTotal="$2"
+  ((Percent=100*QueCurrent/QueTotal))
+  ((Complete=50*Percent/100)) # Change first number for width (50)
+  ((Left=50-Complete)) # Change first number for width (50)
+  BarComplete=$(printf "%${Complete}s" | tr " " "#")
+  BarLeft=$(printf "%${Left}s" | tr " " "-")
+  [[ "$QueTotal" == "$QueCurrent" ]] || printf "\r[%s%s] %s/%s " "$BarComplete" "$BarLeft" "$QueCurrent" "$QueTotal"
+  [[ "$QueTotal" == "$QueCurrent" ]] && printf "\r[%b%s%b] %s/%s \n" "$c_teal" "$BarComplete" "$c_reset" "$QueCurrent" "$QueTotal"
+}
+
+# Function to add user-provided urls to releasenotes
+releasenotes() {
+  for update in ${GotUpdates[@]}; do
+    found=false
+    while read -r container url; do
+      [[ $update == $container ]] && Updates+=("$update  ->  $url") && found=true
+    done < "$ScriptWorkDir"/urls.list
+    [[ $found == false ]] && Updates+=("$update  ->  url missing") || continue
+  done
+}
+
+# Version check & initiate self update
+if [[ "$VERSION" != "$LatestRelease" ]] ; then
+  printf "New version available! %b%s%b ⇒ %b%s%b \n Change Notes: %s \n" "$c_yellow" "$VERSION" "$c_reset" "$c_green" "$LatestRelease" "$c_reset" "$LatestChanges"
+  if [[ -z "$AutoUp" ]] ; then
+    read -r -p "Would you like to update? y/[n]: " SelfUpdate
+    [[ "$SelfUpdate" =~ [yY] ]] && self_update
   fi
 fi
-### Check docker compose binary:
-if docker compose &> /dev/null ; then 
-  DockerBin="docker compose"
-elif docker-compose &> /dev/null; then
-  DockerBin="docker-compose"
+
+# Set $1 to a variable for name filtering later
+SearchName="$1"
+# Create array of excludes
+IFS=',' read -r -a Excludes <<< "$Exclude" ; unset IFS
+
+# Static binary downloader for dependencies
+binary_downloader() {
+  BinaryName="$1"
+  BinaryUrl="$2"
+  case "$(uname -m)" in
+    x86_64|amd64) architecture="amd64" ;;
+    arm64|aarch64) architecture="arm64";;
+    *) printf "\n%bArchitecture not supported, exiting.%b\n" "$c_red" "$c_reset" ; exit 1;;
+  esac
+  GetUrl="${BinaryUrl/TEMP/"$architecture"}"
+  if [[ $(command -v curl) ]]; then curl -L $GetUrl > "$ScriptWorkDir/$BinaryName" ;
+  elif [[ $(command -v wget) ]]; then wget $GetUrl -O "$ScriptWorkDir/$BinaryName" ;
+  else printf "%s\n" "curl/wget not available - get $BinaryName manually from the repo link, exiting."; exit 1;
+  fi
+  [[ -f "$ScriptWorkDir/$BinaryName" ]] && chmod +x "$ScriptWorkDir/$BinaryName"
+}
+
+distro_checker() {
+  if [[ -f /etc/arch-release ]] ; then PkgInstaller="pacman -S"
+  elif [[ -f /etc/redhat-release ]] ; then PkgInstaller="sudo dnf install"
+  elif [[ -f /etc/SuSE-release ]] ; then PkgInstaller="sudo zypper install"
+  elif [[ -f /etc/debian_version ]] ; then PkgInstaller="sudo apt-get install"
+  elif [[ $(uname -s) == "Darwin" ]] ; then PkgInstaller="brew install"
+  else PkgInstaller="ERROR" ; printf "\n%bNo distribution could be determined%b, falling back to static binary.\n" "$c_yellow" "$c_reset"
+  fi
+}
+
+# Dependency check + installer function
+dependency_check() {
+  AppName="$1"
+  AppVar="$2"
+  AppUrl="$3"
+  if [[ $(command -v $AppName) ]]; then export $AppVar="$AppName" ;
+  elif [[ -f "$ScriptWorkDir/$AppName" ]]; then export $AppVar="$ScriptWorkDir/$AppName" ;
+  else
+    printf "%s\n" "Required dependency '$AppName' missing, do you want to install it?"
+    read -r -p "y: With packagemanager (sudo). / s: Download static binary. y/s/[n] " GetBin
+    GetBin=${GetBin:-no} # set default to no if nothing is given
+    if [[ "$GetBin" =~ [yYsS] ]] ; then
+      [[ "$GetBin" =~ [yY] ]] && distro_checker
+      if [[ -n "$PkgInstaller" && "$PkgInstaller" != "ERROR" ]] ; then
+        [[ $(uname -s) == "Darwin" && "$AppName" == "regctl" ]] && AppName="regclient"
+        ($PkgInstaller $AppName) ; PkgExitcode="$?" && AppName="$1"
+        if [[ "$PkgExitcode" == 0 ]] ; then { export $AppVar="$AppName" && printf "\n%b$AppName installed.%b\n" "$c_green" "$c_reset"; }
+        else printf "\n%bPackagemanager install failed%b, falling back to static binary.\n" "$c_yellow" "$c_reset"
+        fi
+      fi
+      if [[ "$GetBin" =~ [sS] || "$PkgInstaller" == "ERROR" || "$PkgExitcode" != 0 ]] ; then
+          binary_downloader "$AppName" "$AppUrl"
+          [[ -f "$ScriptWorkDir/$AppName" ]] && { export $AppVar="$ScriptWorkDir/$1" && printf "\n%b$AppName downloaded.%b\n" "$c_green" "$c_reset"; }
+      fi
+    else printf "\n%bDependency missing, exiting.%b\n" "$c_red" "$c_reset" ; exit 1 ;
+    fi
+  fi
+  # Final check if binary is correct
+  [[ "$1" == "jq" ]] && VerFlag="--version"
+  [[ "$1" == "regctl" ]] && VerFlag="version"
+  ${!AppVar} $VerFlag &> /dev/null  || { printf "%s\n" "$AppName is not working - try to remove it and re-download it, exiting."; exit 1; }
+}
+
+dependency_check "regctl" "regbin" "https://github.com/regclient/regclient/releases/latest/download/regctl-linux-TEMP"
+dependency_check "jq" "jqbin" "https://github.com/jqlang/jq/releases/latest/download/jq-linux-TEMP"
+
+# Check docker compose binary
+if docker compose version &> /dev/null ; then DockerBin="docker compose" ;
+elif docker-compose -v &> /dev/null; then DockerBin="docker-compose" ;
+elif docker -v &> /dev/null; then
+  printf "%s\n" "No docker compose binary available, using plain docker (Not recommended!)"
+  printf "%s\n" "'docker run' will ONLY update images, not the container itself."
 else
-  printf "%s\n" "No docker compose binary available, quitting."
-  exit
+  printf "%s\n" "No docker binaries available, exiting."
+  exit 1
 fi
 
-### Numbered List -function:
+# Numbered List function
 options() {
-num=0
-for i in "${NumberedUpdates[@]}"; do
+num=1
+for i in "${GotUpdates[@]}"; do
   echo "$num) $i"
   ((num++))
 done
 }
 
-### Choose from list -function:
-choosecontainers() {
-  while [[ "$ChoiceClean" =~ [A-Za-z] || -z "$ChoiceClean" ]]; do
-    printf "What containers do you like to update? \n"
-    # options
-    read -p 'Enter number(s) separated by comma (eg. 1,3,4): ' Choice
-    if [ "$Choice" == "0" ] ; then 
-      SelectedUpdates=( ${NumberedUpdates[@]:1} )
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
-    else
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
-      for s in $ChoiceClean; do
-        SelectedUpdates+=( ${NumberedUpdates[$s]} )
-      done
-    fi
-  done
-  printf "\nYou've SelectedUpdates:\n"
-  printf "%s\n" "${SelectedUpdates[@]}"
-}
+# Listing typed exclusions
+if [[ -n ${Excludes[*]} ]] ; then
+  printf "\n%bExcluding these names:%b\n" "$c_blue" "$c_reset"
+  printf "%s\n" "${Excludes[@]}"
+  printf "\n"
+fi
 
-### Check the image-hash of every running container VS the registry
-for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
-  printf ". "
+# Variables for progress_bar function
+ContCount=$(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}' | wc -l)
+RegCheckQue=0
+
+# Testing and setting timeout binary
+t_out=$(command -v timeout)
+if [[ $t_out ]]; then
+  t_out=$(realpath $t_out 2>/dev/null || readlink -f $t_out)
+  if [[ $t_out =~ "busybox" ]]; then
+    t_out="timeout ${Timeout}"
+  else t_out="timeout --foreground ${Timeout}"
+  fi
+else t_out=""
+fi
+
+# Check the image-hash of every running container VS the registry
+for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}') ; do
+  ((RegCheckQue+=1))
+  progress_bar "$RegCheckQue" "$ContCount"
+  # Looping every item over the list of excluded names and skipping
+  for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done
+  ImageId=$(docker inspect "$i" --format='{{.Image}}')
   RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
-  LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
-  RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null)
-  # Check if regtcl produces errors - add to GotErrors if so.
-  if [ $? -eq 0 ] ; then
-    if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi
+  LocalHash=$(docker image inspect "$ImageId" --format '{{.RepoDigests}}')
+  # Checking for errors while setting the variable
+  if RegHash=$(${t_out} $regbin -v error image digest --list "$RepoUrl" 2>&1) ; then
+    if [[ "$LocalHash" = *"$RegHash"* ]] ; then
+      NoUpdates+=("$i")
+    else
+      if [[ -n "$DaysOld" ]] && ! datecheck ; then
+        NoUpdates+=("+$i ${ImageAge}d")
+      else
+        GotUpdates+=("$i")
+      fi
+    fi
   else
-    GotErrors+=("$i")
+    # Here the RegHash is the result of an error code
+    GotErrors+=("$i - ${RegHash}")
   fi
 done
 
-### Create new Array to use for the numbered list:
-NumberedUpdates=(ALL "${GotUpdates[@]}")
+# Sort arrays alphabetically
+IFS=$'\n'
+NoUpdates=($(sort <<<"${NoUpdates[*]}"))
+GotUpdates=($(sort <<<"${GotUpdates[*]}"))
+unset IFS
 
-### List what containers got updates or not
-if [ -n "$NoUpdates" ] ; then
-  printf "\n\033[32;1mContainers on latest version:\033[0m\n"
+# Run the prometheus exporter function
+if [ -n "$CollectorTextFileDirectory" ] ; then
+  source "$ScriptWorkDir"/addons/prometheus/prometheus_collector.sh && prometheus_exporter ${#NoUpdates[@]} ${#GotUpdates[@]} ${#GotErrors[@]}
+fi
+
+# Define how many updates are available
+UpdCount="${#GotUpdates[@]}"
+
+# List what containers got updates or not
+if [[ -n ${NoUpdates[*]} ]] ; then
+  printf "\n%bContainers on latest version:%b\n" "$c_green" "$c_reset"
   printf "%s\n" "${NoUpdates[@]}"
 fi
-if [ -n "$GotErrors" ] ; then
-  printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n"
+if [[ -n ${GotErrors[*]} ]] ; then
+  printf "\n%bContainers with errors, won't get updated:%b\n" "$c_red" "$c_reset"
   printf "%s\n" "${GotErrors[@]}"
+  printf "%binfo:%b 'unauthorized' often means not found in a public registry.\n" "$c_blue" "$c_reset"
 fi
-if [ -n "$GotUpdates" ] ; then 
-   printf "\n\033[31;1mContainers with updates available:\033[0m\n"
-   [ -z "$UpdYes" ] && options || printf "%s\n" "${GotUpdates[@]}"
+if [[ -n ${GotUpdates[*]} ]] ; then
+   printf "\n%bContainers with updates available:%b\n" "$c_yellow" "$c_reset"
+   [[ -z "$AutoUp" ]] && options || printf "%s\n" "${GotUpdates[@]}"
+   [[ -n "$Notify" ]] && { [[ $(type -t send_notification) == function ]] && send_notification "${GotUpdates[@]}" || printf "Could not source notification function.\n" ; }
 fi
 
-### Optionally get updates if there's any 
+# Optionally get updates if there's any
 if [ -n "$GotUpdates" ] ; then
-  if [ -z "$UpdYes" ] ; then
-  printf "\n\033[36;1mDo you want to update? y/[n]\033[0m "
-  read UpdYes
-  [ "$UpdYes" != "${UpdYes#[Yy]}" ] && choosecontainers
+  if [ -z "$AutoUp" ] ; then
+    printf "\n%bChoose what containers to update.%b\n" "$c_teal" "$c_reset"
+    choosecontainers
   else
     SelectedUpdates=( "${GotUpdates[@]}" )
   fi
-  if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then
+  if [ "$AutoUp" == "${AutoUp#[Nn]}" ] ; then
+    NumberofUpdates="${#SelectedUpdates[@]}"
+    CurrentQue=0
     for i in "${SelectedUpdates[@]}"
-    do 
-      ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir"}}')
-      $DockerBin -f "$ContPath/docker-compose.yml" pull 
-      $DockerBin -f "$ContPath/docker-compose.yml" up -d
+    do
+      ((CurrentQue+=1))
+      unset CompleteConfs
+      # Extract labels and metadata
+      ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}')
+      ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
+      ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
+      [ "$ContPath" == "null" ] && ContPath=""
+      ContConfigFile=$($jqbin -r '."com.docker.compose.project.config_files"' <<< "$ContLabels")
+      [ "$ContConfigFile" == "null" ] && ContConfigFile=""
+      ContName=$($jqbin -r '."com.docker.compose.service"' <<< "$ContLabels")
+      [ "$ContName" == "null" ] && ContName=""
+      ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
+      [ "$ContEnv" == "null" ] && ContEnv=""
+      ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
+      [ "$ContUpdateLabel" == "null" ] && ContUpdateLabel=""
+      ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
+      [ "$ContRestartStack" == "null" ] && ContRestartStack=""
+
+      # Checking if compose-values are empty - hence started with docker run
+      if [ -z "$ContPath" ] ; then
+        if [ "$DRunUp" == "yes" ] ; then
+          docker pull "$ContImage"
+          printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
+        else
+          printf "\n%b%s%b has no compose labels, probably started with docker run - %bskipping%b\n\n" "$c_yellow" "$i" "$c_reset" "$c_yellow" "$c_reset"
+        fi
+        continue
+      fi
+      # cd to the compose-file directory to account for people who use relative volumes
+      cd "$ContPath" || { echo "Path error - skipping $i" ; continue ; }
+      ## Reformatting path + multi compose
+      if [[ $ContConfigFile = '/'* ]] ; then
+        CompleteConfs=$(for conf in ${ContConfigFile//,/ } ; do printf -- "-f %s " "$conf"; done)
+      else
+        CompleteConfs=$(for conf in ${ContConfigFile//,/ } ; do printf -- "-f %s/%s " "$ContPath" "$conf"; done)
+      fi
+      printf "\n%bNow updating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
+      # Checking if Label Only -option is set, and if container got the label
+      [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping." ; continue ; } }
+      docker pull "$ContImage"
+      # Check if the container got an environment file set and reformat it
+      if [ -n "$ContEnv" ]; then ContEnvs=$(for env in ${ContEnv//,/ } ; do printf -- "--env-file %s " "$env"; done) ; fi
+      # Check if the whole stack should be restarted
+      if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]] ; then
+        $DockerBin ${CompleteConfs} stop ; $DockerBin ${CompleteConfs} ${ContEnvs} up -d
+      else
+        $DockerBin ${CompleteConfs} ${ContEnvs} up -d ${ContName}
+      fi
     done
+    printf "\n%bAll done!%b\n" "$c_green" "$c_reset"
+    if [[ -z "$AutoPrune" ]] && [[ -z "$AutoUp" ]]; then read -r -p "Would you like to prune dangling images? y/[n]: " AutoPrune ; fi
+    [[ "$AutoPrune" =~ [yY] ]] && docker image prune -f
   else
     printf "\nNo updates installed, exiting.\n"
   fi

dockcheck_docker-run_ver.sh

@@ -1,146 +0,0 @@
-#!/bin/bash
-
-### DOCKER RUN - VERSION
-
-### WARNING WONT REBUILD CONTAINERS - ONLY GRAB NEW IMAGES
-### If running docker compose, use the main version. (recommended!)
-
-# Help Function:
-Help() {
-  echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]" 
-  echo "Example:    dockcheck.sh -a ng"
-  echo
-  echo "Options:"
-  echo "-h     Print this Help."
-  echo "-a|y   Automatic updates, without interaction."
-  echo "-n     No updates, only checking availability."
-}
-
-while getopts "aynh" options; do
-  case "${options}" in
-    a|y) UpdYes="yes" ;;
-    n) UpdYes="no" ;;
-    h|*) Help ; exit 0 ;;
-  esac
-done
-shift "$((OPTIND-1))"
-
-### Set $1 to a variable for later
-SearchName="$1"
-
-### Check if required binary exists in PATH or directory:
-if [[ $(builtin type -P "regctl") ]]; then 
-  regbin="regctl"
-elif [[ -f "./regctl" ]]; then
-  regbin="./regctl"
-else
-  printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n] "
-  read GetDep
-  if [ "$GetDep" != "${GetDep#[Yy]}" ]; then
-    ### Check arch:
-    case "$(uname --machine)" in
-      x86_64|amd64) architecture="amd64" ;;
-      arm64|aarch64) architecture="arm64";;
-      *) echo "Architecture not supported, exiting." ; exit ;;
-    esac
-    curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture >./regctl
-    chmod 755 ./regctl
-    regbin="./regctl"
-  else
-    printf "%s\n" "Dependency missing, quitting."
-    exit
-  fi
-fi
-### Check docker compose binary:
-if docker compose &> /dev/null ; then 
-  DockerBin="docker compose"
-elif docker-compose &> /dev/null; then
-  DockerBin="docker-compose"
-else
-  printf "%s\n" "No docker compose binary available, quitting."
-  exit
-fi
-
-### Numbered List -function:
-options() {
-num=0
-for i in "${NumberedUpdates[@]}"; do
-  echo "$num) $i"
-  ((num++))
-done
-}
-
-### Choose from list -function:
-choosecontainers() {
-  while [[ "$ChoiceClean" =~ [A-Za-z] || -z "$ChoiceClean" ]]; do
-    printf "What containers do you like to update? \n"
-    # options
-    read -p 'Enter number(s) separated by comma (eg. 1,3,4): ' Choice
-    if [ "$Choice" == "0" ] ; then 
-      SelectedUpdates=( ${NumberedUpdates[@]:1} )
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
-    else
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
-      for s in $ChoiceClean; do
-        SelectedUpdates+=( ${NumberedUpdates[$s]} )
-      done
-    fi
-  done
-  printf "\nYou've SelectedUpdates:\n"
-  printf "%s\n" "${SelectedUpdates[@]}"
-}
-
-### Check the image-hash of every running container VS the registry
-for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
-  printf ". "
-  RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
-  LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
-  RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null)
-  # Check if regtcl produces errors - add to GotErrors if so.
-  if [ $? -eq 0 ] ; then
-    if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi
-  else
-    GotErrors+=("$i")
-  fi
-done
-
-### Create new Array to use for the numbered list:
-NumberedUpdates=(ALL "${GotUpdates[@]}")
-
-### List what containers got updates or not
-if [ -n "$NoUpdates" ] ; then
-  printf "\n\033[32;1mContainers on latest version:\033[0m\n"
-  printf "%s\n" "${NoUpdates[@]}"
-fi
-if [ -n "$GotErrors" ] ; then
-  printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n"
-  printf "%s\n" "${GotErrors[@]}"
-fi
-if [ -n "$GotUpdates" ] ; then 
-   printf "\n\033[31;1mContainers with updates available:\033[0m\n"
-   [ -z "$UpdYes" ] && options || printf "%s\n" "${GotUpdates[@]}"
-fi
-
-### Optionally get updates if there's any 
-if [ -n "$GotUpdates" ] ; then
-  if [ -z "$UpdYes" ] ; then
-  printf "\n\033[36;1mDo you want to update? y/[n]\033[0m "
-  read UpdYes
-  [ "$UpdYes" != "${UpdYes#[Yy]}" ] && choosecontainers
-  else
-    SelectedUpdates=( "${GotUpdates[@]}" )
-  fi
-  if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then
-    for i in "${SelectedUpdates[@]}"; do 
-      ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
-      docker pull $ContImage
-      printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
-    done
-  else
-    printf "\nNo updates installed, exiting.\n"
-  fi
-else
-  printf "\nNo updates available, exiting.\n"
-fi
-
-exit 0

dupc_function.sh

@@ -1,29 +0,0 @@
-#!/bin/bash
-
-### Requires the regctl binary.
-### Get it here: https://github.com/regclient/regclient/releases
-
-### Preferably placed in .bashrc or similar
-
-### Set the full path to the binary or just regctl if in PATH:
-regctl="/home/gw-tdc/dockers/regctl"
-
-dupc () {
-  if [[ "$@" == "help" ]]; then 
-    echo "No container name given, here's the list of currently running containers:" 
-    docker ps --format '{{.Names}}'
-  else
-    for i in $(docker ps --filter "name=$@" --format '{{.Names}}')
-    do
-      RepoUrl=$(docker inspect $i --format='{{.Config.Image}}')
-      LocalHash=$(docker image inspect $RepoUrl --format '{{.RepoDigests}}')
-      RegHash=$($regctl image digest --list $RepoUrl 2>/dev/null)
-      if [ $? -eq 0 ] ; then
-        if [[ "$LocalHash" = *"$RegHash"* ]] ; then printf "$i is already latest.\n" ; else printf "$i got updates.\n" ; fi
-      else
-        printf "$i got errors, no check possible.\n"
-      fi 
-    done
-  fi
-}
-dupc $1

extras/apprise_quickstart.md

@@ -0,0 +1,130 @@
+# A small guide on getting started with Apprise notifications.
+
+
+## Standalone docker container: [linuxserver/apprise-api](https://hub.docker.com/r/linuxserver/apprise-api)
+
+Set up the docker compose as preferred:
+```yaml
+---
+version: "2.1"
+services:
+  apprise-api:
+    image: lscr.io/linuxserver/apprise-api:latest
+    container_name: apprise-api
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Etc/UTC
+    volumes:
+      - /path/to/apprise-api/config:/config
+    ports:
+      - 8000:8000
+    restart: unless-stopped
+```
+
+Then browse to the webui.
+![](apprise-ex1.png)
+Here you'll click **Configuration Manager**, read the overview and then click on **Configuration**.
+Under **Configuration** you'll craft/paste your notification config.
+
+![](apprise-ex2.png)
+The simplest way is just paste the url's as is (like in the example above).  
+There are many ways to customize with tags, groups, json and more. Read [caronc/apprise-api](https://github.com/caronc/apprise-api) for more info!  
+
+Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.  
+
+
+You can also use the [caronc/apprise-api](https://github.com/caronc/apprise-api) to host the api as a frontend to an already existing **Apprise**-setup on the host.
+
+
+### Customize the **notify.sh** file.
+After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.
+
+Comment out/remove the bare metal apprise-command (starting with `apprise -vv -t...`).
+Uncomment and edit the `AppriseURL` variable and *curl* line
+It should look something like this when curling the API:
+```bash
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending Apprise notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+read -d '\n' MessageBody << __EOF
+Containers on $FromHost with updates available:
+
+$UpdToString
+
+__EOF
+
+AppriseURL="http://IP.or.mydomain.tld:8000/notify/apprise"
+curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
+
+}
+```
+
+That's all!
+___
+___
+
+
+## On host installed **Apprise**
+Follow the official guide on [caronc/apprise](https://github.com/caronc/apprise)!
+
+### A brief, basic "get started"
+
+- Install **apprise**
+    - python package `pip install apprise`
+    - packaged in EPEL/Fedora `dnf install apprise`
+    - packaged in AUR `[yay/pikaur/paru/other] apprise`
+
+- Create a config file with your notification credentials (source of notifications):
+```ini
+mailto://user:password@yahoo.com
+slack://token_a/token_b/token_c
+kodi://example.com
+```
+Then either source the notifications with `-c=/path/to/config/apprise` or store them in *PATH* to skip referencing (`~/.apprise` or `~/.config/apprise`).
+
+- Test apprise with a single notification:
+    - `apprise -vv -t 'test title' -b 'test notification body' 'mailto://myemail:mypass@gmail.com'`
+- Set up your notification URL's and test them.
+    - Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.  
+
+### When done, customize the **notify.sh** file.
+After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.
+
+Replace the url's corresponding to the services you've configured.
+```bash
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending Apprise notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+read -d '\n' MessageBody << __EOF
+Containers on $FromHost with updates available:
+
+$UpdToString
+
+__EOF
+
+# Modify to fit your setup:
+apprise -vv -t "$MessageTitle" -b "$MessageBody" \
+   mailto://myemail:mypass@gmail.com \
+   mastodons://{token}@{host} \
+   pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b \
+   tgram://{bot_token}/{chat_id}/
+
+}
+```
+
+That's all!
+___
+___

extras/dc_brief.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+### If not in PATH, set full path. Else just "regctl"
+regbin="regctl"
+### options to allow exclude:
+while getopts "e:" options; do
+  case "${options}" in
+    e) Exclude=${OPTARG} ;;
+    *) exit 0 ;;
+  esac
+done
+shift "$((OPTIND-1))"
+### Create array of excludes
+IFS=',' read -r -a Excludes <<< "$Exclude" ; unset IFS
+
+SearchName="$1"
+
+for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
+  for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done
+  printf ". "
+  RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
+  LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
+  ### Checking for errors while setting the variable:
+  if RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null) ; then
+    if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi
+  else
+    GotErrors+=("$i")
+  fi
+done
+
+### Sort arrays alphabetically
+IFS=$'\n'
+NoUpdates=($(sort <<<"${NoUpdates[*]}"))
+GotUpdates=($(sort <<<"${GotUpdates[*]}"))
+GotErrors=($(sort <<<"${GotErrors[*]}"))
+unset IFS
+
+### List what containers got updates or not
+if [[ -n ${NoUpdates[*]} ]] ; then
+  printf "\n\033[0;32mContainers on latest version:\033[0m\n"
+  printf "%s\n" "${NoUpdates[@]}"
+fi
+if [[ -n ${GotErrors[*]} ]] ; then
+  printf "\n\033[0;31mContainers with errors, wont get updated:\033[0m\n"
+  printf "%s\n" "${GotErrors[@]}"
+fi
+if [[ -n ${GotUpdates[*]} ]] ; then
+   printf "\n\033[0;33mContainers with updates available:\033[0m\n"
+   printf "%s\n" "${GotUpdates[@]}"
+fi
+printf "\n\n"

extras/errorCheck.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+SearchName="$1"
+for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
+  echo "------------ $i ------------"
+  ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}')
+  ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
+  ContPath=$(jq -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
+  [ "$ContPath" == "null" ] && ContPath=""
+  [ -z "$ContPath" ] && { "$i has no compose labels - skipping" ; continue ; }
+  ContConfigFile=$(jq -r '."com.docker.compose.project.config_files"' <<< "$ContLabels")
+  [ "$ContConfigFile" == "null" ] && ContConfigFile=""
+  ContName=$(jq -r '."com.docker.compose.service"' <<< "$ContLabels")
+  [ "$ContName" == "null" ] && ContName=""
+  ContEnv=$(jq -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
+  [ "$ContEnv" == "null" ] && ContEnv=""
+  ContUpdateLabel=$(jq -r '."mag37.dockcheck.update"' <<< "$ContLabels")
+  [ "$ContUpdateLabel" == "null" ] && ContUpdateLabel=""
+  ContRestartStack=$(jq -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
+  [ "$ContRestartStack" == "null" ] && ContRestartStack=""
+
+  if [[ $ContConfigFile = '/'* ]] ; then
+    ComposeFile="$ContConfigFile"
+  else
+    ComposeFile="$ContPath/$ContConfigFile"
+  fi
+
+  echo -e "Service name:\t\t$ContName"
+  echo -e "Project working dir:\t$ContPath"
+  echo -e "Compose files:\t\t$ComposeFile"
+  echo -e "Environment files:\t$ContEnv"
+  echo -e "Container image:\t$ContImage"
+  echo -e "Update label:\t$ContUpdateLabel"
+  echo -e "Restart Stack label:\t$ContRestartStack"
+  echo
+  echo "Mounts:"
+  docker inspect  -f '{{ range .Mounts }}{{ .Source }}:{{ .Destination }}{{ printf "\n" }}{{ end }}' "$i"
+  echo
+done

extras/temp

@@ -0,0 +1 @@
+temp

notify_templates/notify_DSM.sh

@@ -0,0 +1,54 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+# INFO: ssmtp is depcerated - consider to use msmtp instead.
+#
+# Copy/rename this file to notify.sh to enable the notification snipppet.
+# mSMTP/sSMTP has to be installed and configured manually.
+# The existing DSM Notification Email configuration will be used automatically.
+# Modify to your liking - changing SendMailTo and Subject and content.
+
+MSMTP=$(which msmtp)
+SSMTP=$(which ssmtp)
+
+if [ -n "$MSMTP" ] ; then
+	MailPkg=$MSMTP
+elif [ -n "$SSMTP" ] ; then
+	MailPkg=$SSMTP
+else
+	echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
+fi
+
+send_notification() {
+[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+FromHost=$(hostname)
+CfgFile="/usr/syno/etc/synosmtp.conf"
+
+# User variables:
+# Automatically sends to your usual destination for synology DSM notification emails.
+# You can also manually override by assigning something else to SendMailTo below.
+SendMailTo=$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
+#SendMailTo="me@mydomain.com"
+
+SubjectTag=$(grep 'eventsubjectprefix' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
+SenderName=$(grep 'smtp_from_name' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
+SenderMail=$(grep 'smtp_from_mail' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
+SenderMail=${SenderMail:-$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')}
+
+printf "\nSending email notification.\n"
+
+printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
+
+$MailPkg $SendMailTo << __EOF
+From: "$SenderName" <$SenderMail>
+date:$(date -R)
+To: <$SendMailTo>
+Subject: $SubjectTag Updates available on $FromHost
+Content-Type: text/plain; charset=UTF-8; format=flowed
+Content-Transfer-Encoding: 7bit
+
+$MessageBody
+ From $SenderName
+__EOF
+# This ensures DSM's container manager will also see the update
+/var/packages/ContainerManager/target/tool/image_upgradable_checker
+}

notify_templates/notify_apprise.sh

@@ -0,0 +1,30 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Modify to fit your setup - if API, set AppriseURL to your Apprise ip/domain.
+
+send_notification() {
+[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending Apprise notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+# Modify to fit your setup:
+apprise -vv -t "$MessageTitle" -b "$MessageBody" \
+   mailto://myemail:mypass@gmail.com \
+   mastodons://{token}@{host} \
+   pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b \
+   tgram://{bot_token}/{chat_id}/
+
+### If you use the Apprise-API - Comment out the apprise command above.
+### Uncomment the AppriseURL and the curl-line below:
+# AppriseURL="http://apprise.mydomain.tld:1234/notify/apprise"
+# curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
+
+}

notify_templates/notify_discord.sh

@@ -0,0 +1,28 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Modify to fit your setup - set DiscordWebhookUrl
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    echo "$UpdToString"
+    FromHost=$(hostname)
+
+    # platform specific notification code would go here
+    printf "\nSending Discord notification\n"
+
+    # Setting the MessageBody variable here.
+    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+
+    # Modify to fit your setup:
+    DiscordWebhookUrl="PasteYourFullDiscordWebhookURL"
+
+    MsgBody="{\"username\":\"$FromHost\",\"content\":\"$MessageBody\"}"
+
+    curl -sS -o /dev/null --fail -X POST -H "Content-Type: application/json" -d "$MsgBody" "$DiscordWebhookUrl"
+
+}
+

notify_templates/notify_generic.sh

@@ -0,0 +1,16 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# generic sample, the "Hello World" of notification addons
+
+send_notification() {
+  [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+  UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+  FromHost=$(hostname)
+
+  # platform specific notification code would go here
+  printf "\n%bGeneric notification addon:%b" "$c_green" "$c_reset"
+  printf "\nThe following docker containers on %s need to be updated:\n" "$FromHost"
+  printf "$UpdToString"
+}

notify_templates/notify_gotify.sh

@@ -0,0 +1,29 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Modify to fit your setup - set GotifyUrl and GotifyToken.
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+    FromHost=$(hostname)
+
+    # platform specific notification code would go here
+    printf "\nSending Gotify notification\n"
+
+    # Setting the MessageTitle and MessageBody variable here.
+    MessageTitle="${FromHost} - updates available."
+    printf -v MessageBody "Containers on $FromHost with updates available:\n$UpdToString"
+
+    # Modify to fit your setup:
+    GotifyToken="Your Gotify token here"
+    GotifyUrl="https://api.gotify/message?token=${GotifyToken}"
+
+    curl \
+        -F "title=${MessageTitle}" \
+        -F "message=${MessageBody}" \
+        -F "priority=5" \
+        -X POST "${GotifyUrl}" 1> /dev/null
+
+}

notify_templates/notify_matrix.sh

@@ -0,0 +1,28 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Modify to fit your setup - set MatrixServer, Room_id and AccessToken
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+    FromHost=$(hostname)
+
+    # platform specific notification code would go here
+    printf "\nSending Matrix notification\n"
+
+    # Setting the MessageBody variable here.
+    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+
+    # Modify to fit your setup:
+    AccessToken="Your Matrix token here"
+    Room_id="Enter Room_id here"
+    MatrixServer="Enter Your HomeServer URL"
+    MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
+
+    # URL Example:  https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
+
+    curl -sS -o /dev/null --fail -X POST "$MatrixServer/_matrix/client/r0/rooms/$Room_id/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
+
+}

notify_templates/notify_ntfy-sh.sh

@@ -0,0 +1,26 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Setup app and subscription at https://ntfy.sh
+# Use your unique Topic Name in the URL below.
+
+send_notification() {
+[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending ntfy.sh notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+# Modify to fit your setup:
+NtfyUrl="ntfy.sh/YourUniqueTopicName"
+
+curl -sS -o /dev/null --show-error --fail \
+  -H "Title: $MessageTitle" \
+  -d "$MessageBody" \
+  $NtfyUrl
+
+}

notify_templates/notify_pushbullet.sh

@@ -0,0 +1,27 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Requires jq installed and in PATH.
+# Modify to fit your setup - set Url and Token.
+
+send_notification() {
+[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+FromHost=$(hostname)
+
+# platform specific notification code would go here
+printf "\nSending pushbullet notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+# Modify to fit your setup:
+PushUrl="https://api.pushbullet.com/v2/pushes"
+PushToken="Your Pushbullet token here"
+
+# Requires jq to process json data
+jq -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -sS -o /dev/null --show-error --fail -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @-
+
+}

notify_templates/notify_pushover.sh

@@ -0,0 +1,32 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Requires jq installed and in PATH.
+# Modify to fit your setup - set Url and Token.
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+    FromHost=$(hostname)
+
+    # platform specific notification code would go here
+    printf "\nSending pushover notification\n"
+
+    MessageTitle="$FromHost - updates available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+    # Modify to fit your setup:
+    PushoverUrl="https://api.pushover.net/1/messages.json"
+    PushoverUserKey="Your Pushover User Key Here"
+    PushoverToken="Your Pushover API Token Here"
+
+    # Sending the notification via Pushover
+    curl -sS -o /dev/null --show-error --fail -X POST \
+        -F "token=$PushoverToken" \
+        -F "user=$PushoverUserKey" \
+        -F "title=$MessageTitle" \
+        -F "message=$MessageBody" \
+        $PushoverUrl
+}

notify_templates/notify_smtp.sh

@@ -0,0 +1,44 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+# INFO: ssmtp is depcerated - consider to use msmtp instead.
+#
+# Copy/rename this file to notify.sh to enable the notification snipppet.
+# mSMTP/sSMTP has to be installed and configured manually.
+# Modify to fit your setup - changing SendMailFrom, SendMailTo, SubjectTag
+
+MSMTP=$(which msmtp)
+SSMTP=$(which ssmtp)
+
+if [ -n "$MSMTP" ] ; then
+	MailPkg=$MSMTP
+elif [ -n "$SSMTP" ] ; then
+	MailPkg=$SSMTP
+else
+	echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
+fi
+
+send_notification() {
+[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+FromHost=$(hostname)
+
+# User variables:
+SendMailFrom="me@mydomain.tld"
+SendMailTo="me@mydomain.tld"
+SubjectTag="dockcheck"
+
+printf "\nSending email notification.\n"
+
+printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
+
+$MailPkg $SendMailTo << __EOF
+From: "$FromHost" <$SendMailFrom>
+date:$(date -R)
+To: <$SendMailTo>
+Subject: [$SubjectTag] Updates available on $FromHost
+Content-Type: text/plain; charset=UTF-8; format=flowed
+Content-Transfer-Encoding: 7bit
+
+$MessageBody
+
+__EOF
+}

notify_templates/notify_telegram.sh

@@ -0,0 +1,27 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Modify to fit your setup - set TelegramChatId and TelegramToken.
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+    FromHost=$(hostname)
+
+    # platform specific notification code would go here
+    printf "\nSending Telegram notification\n"
+
+    # Setting the MessageBody variable here.
+    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+
+    # Modify to fit your setup:
+    TelegramToken="Your Telegram token here"
+    TelegramChatId="Your Telegram ChatId here"
+    TelegramUrl="https://api.telegram.org/bot$TelegramToken"
+    TelegramTopicID=12345678 ## Set to 0 if not using specific topic within chat
+    TelegramData="{\"chat_id\":\"$TelegramChatId\",\"text\":\"$MessageBody\",\"message_thread_id\":\"$TelegramTopicID\",\"disable_notification\": false}"
+
+    curl -sS -o /dev/null --fail -X POST "$TelegramUrl/sendMessage" -H 'Content-Type: application/json' -d "$TelegramData"
+
+}

notify_templates/urls.list

@@ -0,0 +1,35 @@
+# This is a list of container names and releasenote urls, separated by space.
+# Modify, add and (if necessary) remove to fit your needs.
+# Additions are welcome! Append your list to the git-repo, use generic names and sensible urls.
+
+apprise-api https://github.com/linuxserver/docker-apprise-api/releases
+homer https://github.com/bastienwirtz/homer/releases
+nginx https://github.com/docker-library/official-images/blob/master/library/nginx
+vaultwarden-server https://github.com/dani-garcia/vaultwarden/releases
+bruceforce-vaultwarden-backup https://github.com/Bruceforce/vaultwarden-backup/blob/main/CHANGELOG.md
+actual_server https://actualbudget.org/blog
+gotify https://github.com/gotify/server/releases
+traefik https://github.com/traefik/traefik/releases
+caddy https://github.com/caddyserver/caddy/releases
+
+calibre https://github.com/linuxserver/docker-calibre/releases
+calibre-web https://github.com/linuxserver/docker-calibre-web/releases
+readarr https://github.com/Readarr/Readarr/releases
+audiobookshelf https://github.com/advplyr/audiobookshelf/releases
+
+gluetun https://github.com/qdm12/gluetun/releases
+bazarr https://github.com/morpheus65535/bazarr/releases
+bazarr-ls https://github.com/linuxserver/docker-bazarr/releases
+prowlarr https://github.com/Prowlarr/Prowlarr/releases
+prowlarr-ls https://github.com/linuxserver/docker-prowlarr/releases
+recyclarr https://github.com/recyclarr/recyclarr/releases
+sabnzbd https://github.com/linuxserver/docker-sabnzbd/releases
+sonarr https://github.com/linuxserver/docker-sonarr/releases
+radarr https://github.com/linuxserver/docker-radarr/releases
+lidarr https://github.com/linuxserver/docker-lidarr/releases
+jellyseerr https://github.com/Fallenbagel/jellyseerr/releases
+jellyfin https://github.com/jellyfin/jellyfin/releases
+
+home-assistant https://github.com/home-assistant/docker/releases
+zigbee2mqtt https://github.com/Koenkk/zigbee2mqtt/releases
+mqtt https://github.com/eclipse/mosquitto/tags