add MILA_GROUP to combine.yml

Reviewed-on: toolshed/alakazam#8

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "abra"]
+	path = abra
+	url = https://git.coopcloud.tech/toolshed/abra.git

LICENCE

@@ -0,0 +1,662 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are 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.
+
+  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.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  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 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 work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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 Affero 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 Affero 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 Affero 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 }}  {{ organization }}
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  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 AGPL, see
+<http://www.gnu.org/licenses/>.

README.md

@@ -1,87 +1,214 @@
 # Alakazam
 
-Proof-of-concept meta-configuration app-connector abra wrapper.
+Alakazam is a meta-configuration app-connector and an abra wrapper, designed as a proof-of-concept to simplify the management of environment configuration files across multiple instances.
+
+> [!WARNING]
+> This software is in an experimental stage and has to be used with caution, expect things to break. 
+>
+> At the moment it is used in production for a [very tailored use case](https://wiki.local-it.cloud/s/kollicloud-wiki/doc/installation-wVp2LfBbg7).
+> We try to mainline features of this project to `abra` and make the tool more accessible by everyone.
+> Any feedback is highly appreciated.
 
 ## Problem Statement
 
-- managing a lot of env files can be error prone
-    - copy pasting env files
-- loosing the overview of configuration differences between instances
-- updating env files is a manual process of comparing the env files
-- no way to define default configurations that should always be applied
-- connecting two apps requires manual effort of specific env file changes and sharing secrets
 
-## Advantages
+Managing numerous environment (env) files can be prone to errors such as:
+
+- Frequent copy-pasting mistakes.
+- Difficulty maintaining an overview of configuration differences across instances.
+- Laborious manual processes required for updating env files, particularly when underlying recipe env configurations change.
+- Challenges in defining default configurations that should consistently apply across all apps and all instances.
+- Manual effort required for app integration (e.g., SSO), including configuring environment files and exchanging secrets.
+
+## Advantages of Alakazam
+
+- **Global Configuration**: Prevents errors related to manual copying and pasting and ensures no critical configurations are overlooked.
+- **Reduced Manual Configuration**: Facilitates the connection between multiple applications (i.E. SSO) through domain exchanges, secret sharing, and specific environmental variables.
+- **Minimal Configuration Files**: Each instance configuration only contains parameters that deviate from the defaults or global configurations, simplifying management.
+- **Standardized Subdomain Conventions**: Ensures consistent subdomain use across apps.
+- **Simplified Setup**: Allows for the setup of an instance with multiple connected apps in one run.
+- **Automatic Env Configuration Updates**: Eliminates manual env configuration.
+- **Automatic Batch Updates**: update all apps of a group of instances at once.
+- **Hierarchical Configuration Structure**: Supports configuration inheritance for ease of managing large-scale configurations.
+
+## How does it work
+
+`alakazam` serves as a wrapper for `abra`, automating the deployment process for multiple apps.
+It utilizes YAML configuration files to generate the necessary .env files and manage secret exchanges between applications.
+It supports the deployment or updating of multiple apps simultaneously and can execute post-deploy hooks.
+All configurations are hierarchically structured in YAML files, which can inherit properties from the layers above.
+
+## Tutorial
+
+### Install alakazam
+
+To install Alakazam, follow these steps to clone the repository and set up the executable.
+Replace `apt` with your package manager of choice.
+
+```bash
+sudo apt update
+sudo apt install curl git python3.11-venv
+# Install golang
+curl -sS https://webi.sh/golang | sh; \
+source ~/.config/envman/PATH.env
+# clone alakazam
+git clone --recursive https://git.coopcloud.tech/moritz/alakazam.git
+# install alakazam
+cd alakazam
+ln -s $PWD/alakazam.sh ~/.local/bin/alakazam
+# Ensure `~/.local/bin` is in your `$PATH`
+alakazam install
+```
+
+Create a global `~/.config/alakazam.yml` that contains at least the `root` path, see [Global Settings](#global-settings)
+
+### Create a new instance:
+
+To set up a new instance with Alakazam, begin by specifying the required applications in `example.com.yml`. The name of this file determines the domain for the instance.
+Here's an example configuration:
+
+```yaml
+traefik:
+backup-bot-two:
+authentik:
+nextcloud:
+onlyoffice:
+wordpress:
+vikunja:
+matrix-synapse:
+element-web:
+rallly:
+```
+
+Ensure that DNS records are set up for all your applications. The simplest approach is to create a `CNAME` record for the wildcard domain `*.example.com` to cover all subdomains used by the apps.
+
+For a more comprehensive configuration, refer to the example in [./examples](./examples), which can also serve as a template for single-instance configurations (`example.com.yml`).
+
+Steps to initialize the instance:
+
+1. **Generate .env Files**: `alakazam example.com.yml config`
+2. **Insert Secrets**: `alakazam example.com.yml secrets`
+3. **Deploy Applications**: `alakazam example.com.yml deploy -e` 
+    - the `-e` flag executes post-deployment hooks after each deployment
+
+### Updating All Instances
+
+To update all instances:
+
+1. **Update Environment Files**: `alakazam example.com.yml config` to refresh .env files. It's a good practice to keep these files under version control (e.g., in a Git repository at `~/.abra/example.com`) and review changes with `git diff` before proceeding.
+2. **Upgrade Applications**: `alakazam example.com.yml upgrade` to update all applications.
+
+### Run CMDs
+
+Escaping can be akward:
+```
+alakazam example.com.yml cmd -c 'app run_occ ''"config:app:get sociallogin custom_providers"''' -r nextcloud
+```
 
-- Have a global configuration that applies on every instance:
-    - avoid copy pasta errors
-    - avoid forgetting important configurations
-- Reduce manual configuration overhead for connecting multiple apps
-    - exchange domains
-    - share secrets
-    - set specific env vars
-- Have a minimal configuration file for each instance
-    - it should only contain parameters that differ from the defaults and the global configuration
-- Set a global subdomain convention
-    - each app will always have the same subdomain
-- Set up an instance with multiple connected apps in one run
-- Automatic updates of the env configurations 
-    - avoid manual env configuration at all
 
 ## Configuration
 
-### Concept
+### Instance Configuration
 
-This concept contains the following configuration files.
-Each configuration can be templated with jinja2 and global variables.
+Configuration files support templating with Jinja2 and global variables, facilitating dynamic adjustments. The primary types of configuration files include:
+
+1. **`alaka.yml`**/**`alaka-*.yml`**: Contains global configurations for a hierarchical layer, affecting all subordinate apps.
+2. **`example.com.yml`** (`<your-domain>.yml`): A minimalist configuration for each instance, specifying the apps to be installed, the instance domain and optionally instance specific configurations.
+    - an **instance** means a collection of apps that are integrated with each other (one server / vm can contain multiple instances)
+3. **`combine.yml`**: Manages configurations required to integrate multiple apps with each other.
+    - This configuration should not be touched by the operator.
+    - At the moment it's part of the `alakazam` repository.
+    - In future it should be split into the recipes repositories and maintained by the recipe maintainer.
+        - We started to move each app entry as `alaconnect.yml` into the respective repositories.
+4. **`config-sets.yml`**: Optional file placed at the `root` path. Defines named sets of per-app configurations that can be activated or deactivated per instance or group, avoiding duplication across instance files. See [examples/config-sets.yml](./examples/config-sets.yml).
+
+### Global Settings
+
+**`~/.config/alakazam.yml`**: The global settings for alakazam.
+It must contain the `root` path to all instance configurations. This path contains all the `alaka.yml`,`alaka-*.yml` and `example.com.yml` files.
+Further it can contain settings for an Uptime Kuma instance.
+
+```
+root: ~/root/path/to/my/instance/configurations
+uptime_kuma:
+    url: https://status.example.com
+    user: <username>
+    password: <password>
+    parameter:
+        interval: 300
+        retryInterval: 360
+        timeout: 48
+        maxretries: 5
+        ignoreTls: False
+        notificationIDList: [15, 16]
+        expiryNotification: True
+```
 
-1. `~/.abra/defaults.yml`
-    - It contains global configurations for each app that are applied on each instance
-        - i.e. smtp config, language...
-    - It contains a mapping for each app to a subdomain
-        - i.e. `cloud.example.com` for each nextcloud instance
-    - This configuration is for the operator to avoid copy pasta errors, reduce manual configurations and keep the same naming convention
-2. `./config.yml`
-    - a minimalist configuration per instance
-    - contains at least:
-        - the domain (and the server, if they differ)
-        - the apps to be installed
-    - can optionally contain instance specific configurations for each app, overwriting the `defaults.yml` configurations
-3. `combine.yml`
-    - contains the configuration steps that are required to combine apps with each other
-    - This configuration should not be touched by the operator
-        - It should be either split into the recipes repositories and maintained by the recipe maintainer or it should be maintained by the alakazam maintainer
 
 ### App Configuration
 
-`defaults.yml`, `config.yml` and `combine.yml` contain a similar structure to configure the individual apps.
-For each app the following `<app_configurations>` steps can be used:
+`alaka.yml`/`alaka-*.yml`, `example.com.yml` and `combine.yml`/`alaconnect.yml` contain a similar configuration structure.
+For each app/recipe the following `<app_configurations>` can be used:
 
-- `uncomment:`
-    - uncomment each matching line
+- **`uncomment`/`comment`**: Manages the active status of lines in configuration files, such as uncommenting needed variables .
+    - it matches against parts of the line (i.E. `compose.smtp.yml`)
     - this is useful for env variables that are used multiple times like `COMPOSE_FILE`
-- `env:`
-    - set the value for env variables
-- `execute:`
-    - `abra.sh` commands that should be executed after deployment
-- `secrets:`
-    - insert a specific value into a secret
-    - for secrets that can not be generated, i.e. smtp passwords
-- `subdomain`:
-    - contains the subdomain that should be used for a specific app
+- **`env`**: Sets values for environment variables.
+- **`*-hooks`**: Specifies `abra.sh` commands to run at specific stages.
+    - **`initial-hooks`**: commands for initialisation
+    - **`deploy-hooks`**: commands that should be run after each deployment
+    - **`upgrade-hooks`**: commands that should be run after each upgrade
+- **`secrets`**: Inserts specific values (i.E. smtp passwords) into secrets; future updates will support encrypted file usage.
+- **`secret-hooks`**: Run `abra.sh` commands locally for secrets that need to be generated.
+- **`subdomain`**: Specifies the subdomain scheme for individual recipes and apps. (not available in `combine.yml`/`alaconnect.yml`)
     - i.e. `cloud.example.com` for nextcloud
-    - (not available in `combine.yml`)
+- **`version`**: Controls the recipe version to deploy; if unspecified, the latest version is used. (not available in `combine.yml`/`alaconnect.yml`)
 
-The `combine.yml` configuration additionally contains
+The `combine.yml`/`alaconnect.yml` configuration additionally contains:
 
-- `shared_secrets:`
+- **`shared_secrets`**: Specifies secret sharing between apps.
      - `<source_secret_name>:<target_secret_name>`
-     - a mapping to define which secrets should be shared between two apps
 
-Each configuration file can have a `GLOBALS` section, that cat be used to template the configuration with global variables.
+### Configuration Structure
 
-```
+Configuration can be simplified into a single `example.com.yml` or expanded into multiple layered `alaka.yml`/`alaka-*.yml` files for complex deployments. This allows for easy maintenance of multiple instances or groups.
+These configurations are designed to modularize and simplify the management of app settings and integrations, making it easier to maintain and scale your deployments.
+
+1. **`alaka.yml`/`alaka-*.yml` and `example.com.yml`**
+    - **`alaka.yml`/`alaka-*.yml`**: Contain global app configurations (`<app_recipe>`) which are inherited by all configurations within its hierarchical layer. This ensures consistent settings across multiple applications. All `alaka-*.yml` files inside a directory are merged into one configuration. Avoid overrides between `alaka-*.yml` inside of one layer.
+    - **`example.com.yml`**: Specifies which apps should be deployed (`<app_recipe>` entries), focusing on the individual needs of each instance.
+    - Configurations within these files are structured as follows, with specific `<app_configuration>` settings detailed in the [App Configuration](#app-configuration) section:
+
+    ```
+    <app_recipe>:
+        <app_configurations>
+    ```
+
+2. **`combine.yml`**
+    - This file orchestrates the integration between multiple apps within the same instance (`example.com.yml`), applying `<target_app_configurations>` to ensure seamless functionality between connected applications.
+    - The configuration for each app combination is structured as follows, again `<target_app_configurations>` is following the guidelines set in the [App Configuration](#app-configuration) section:
+
+    ```
+    <target_app_recipe>:
+        <source_app_recipe>:
+            <target_app_configurations>
+    ```
+
+    - In future each `<source_app_recipe>` entry will be placed in the `alaconnect.yml` inside the `<target_app_recipe>` folder.
+
+3. **`config-sets.yml`**
+    - Optional file at the `root` path that defines named sets of per-app configurations. Each top-level key is a config-set name; its value is a map of `<app_recipe>` to `<app_configurations>`.
+    - Activate or disable sets per instance or group via `CONFIG-SETS` in any `alaka.yml` or `example.com.yml`. Merge priority: group < config-set < instance.
+    - See [examples/config-sets.yml](./examples/config-sets.yml).
+
+
+### Templating Configurations
+
+Each configuration file can include a `GLOBALS` section that allows for templating with global variables, making it easier to manage repetitive values across different configurations. Here is how you can define and use these global variables:
+
+```yaml
 GLOBALS:
+    server: example-server.com
     smtp_user: noreply
     smtp_domain: example.org
 authentik:
@@ -92,78 +219,21 @@ nextcloud:
         MAIL_FROM_ADDRESS: "{{smtp_user}}"
 ```
 
-### Configuration Structure
+- **`server`**: Specifies the server where the instance will be deployed. If not provided, the instance domain is automatically taken from the `example.com.yml` file name.
 
-1. `defaults.yml`
-    - there is an entry for each `<app_recipe>` that should have a global configuration
-    - the `<app_configuration>` is configured according to [App Configuration](#app-configuration) above
+## Inheriting Configuration Structure
 
-    ```
-    <app_recipe>:
-        <app_configurations>
-    ```
+Alakazam supports a flexible inheritance model for configuration management, allowing for both simplicity and complexity depending on your deployment needs:
 
-2. `config.yml`
+- **Simple Configuration**: For straightforward setups, you can manage everything within a single `example.com.yml` file, placing all necessary configurations directly in this document.
+- **Multiple Similar Instances**: To manage multiple similar instances efficiently, common application configurations can be centralized in a global `alaka.yml`. This method reduces duplication by allowing shared settings across multiple instances. The global `alaka.yml` can also be split into multiple `alaka-*.yml` files which are merged together.
+- **Grouped Instances**: For more complex setups, instances can be organized into folders, each with its own `alaka.yml`/`alaka-*.yml`. This structure allows for group-specific configurations, making it easier to manage settings at different levels of your infrastructure hierarchy.
+- **Inherited Configurations**: In even more complex scenarios, each group can inherit configurations from the levels above it. This cascading setup ensures that changes at a higher level can be automatically applied to all subordinate groups and instances, maintaining consistency and ease of updates across your entire environment.
 
-    ```
-    domain: <instance_domain>
-    server: <instance_server>
-    apps:
-        <app_recipe>:
-            <app_configurations>
-    ```
+This hierarchical approach to configuration is designed to scale with your system’s complexity and can be visualized through the following example diagram:
 
-3. `combine.yml`
-    - To combine two deployed apps each `<target_app_configurations>` of a specific `<target_app_recipe>` is only applied if the `config.yml` also contains the belonging `<source_app_recipe>`
+![File Structure](./config_file_structure.png)
 
-    ```
-    <target_app_recipe>:
-        <source_app_recipe>:
-            <target_app_configurations>
-    ```
+![Configuration Structure](./config_structure.png)
 
 
-## Process
-
-Create a new instance:
-
-1. The `config.yml` is created by the operator to define the domain and required apps
-2. `./alakazam.py init-server`
-    - installs `traefik` and `backup-bot-two`
-3. `./alakazam.py setup-apps`
-    1. for each app the env files are created
-    2. for each app the `defaults.yml` configs are applied on the env files and secrets are inserted
-    3. for each app the `config.yml` configs are applied on the env files and secrets are inserted
-    4. for each app the `combine.yml` configs are applied on the env files and secrets are inserted
-        - the shared_secrets are generated
-        - `<source_app_recipe>.example.com` is replaced in the `<target_app_recipe>` env file according to `subdomain` configuration
-    5. all the remaining secrets are generated
-4. `./alakazam.py deploy-apps`
-    - each app is deployed
-    - the `execute` commands from `defaults.yml`, `configs.yml` and `combine.yml` are executed
-
-Step 3. (`./alakazam.py setup-apps`) should be executed every time the config is changed or the recipe env file is updated. It regenerates the env files and creates all the necessary secrets. 
-The env files itself shouldn't be edited manually anymore.
-
-## Conceptual Questions
-
-Please note any ideas and arguments you have: https://pad.local-it.org/dB0FsiomRCOCPs7rS40YSQ
-
-- Possible abra integration
-    - An independent wrapper for abra, that uses abras `--machine` output
-    - A go binary that is build on top of the abra library
-    - An abra command like `abra compose`
-
-- Put `config.yml` into `~/.abra/servers/<server>/` or let the user decide?
-
-- Should we move completely away from .env files?
-    - This would skip the translation step into env files
-    - It reduces the complexity!
-    - Recipes couldn't be run with `docker compose` only anymore
-        - Is this still possible?
-
-- Where should the `combine.yml` be maintained?
-    - Separated config for each recipe?
-        - better configuration versioning for different recipe versions
-        - harder to maintain the recipes: requires knowledge about the connectable apps
-    - Global config?

alakazam.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# Get the directory of the script being run.
+SCRIPT_DIR="$( cd "$( dirname "$( readlink -f "${BASH_SOURCE[0]}" )" )" &> /dev/null && pwd )"
+VENV_PATH=$SCRIPT_DIR/.venv
+
+# check if venv exists
+if [ ! -d $VENV_PATH -o "$1" == "install" ]; then
+    cd $SCRIPT_DIR
+    git pull --recurse-submodules
+    echo install virtual environment: $VENV_PATH
+    rm -rf $VENV_PATH
+    python3 -m venv $VENV_PATH
+    source $VENV_PATH/bin/activate
+    pip3 install -r $SCRIPT_DIR/requirements.txt
+    deactivate
+    cd $SCRIPT_DIR/abra
+    make install
+    exit 0
+fi
+
+# Activate the virtual environment
+source $VENV_PATH/bin/activate
+python3 -u $SCRIPT_DIR/alakazam.py "$@"
+py_exit=$?
+deactivate
+exit "$py_exit"

combine.yml

@@ -18,6 +18,7 @@ authentik:
         uncomment:
             - compose.matrix.yml
             - ELEMENT_DOMAIN
+            - MATRIX_DOMAIN
             - SECRET_MATRIX_ID_VERSION
             - SECRET_MATRIX_SECRET_VERSION
             - matrix.svg
@@ -41,13 +42,25 @@ authentik:
             - vikunja.svg
         secrets:
             vikunja_id: vikunja
-    monitoring:
+    kimai:
+        uncomment:
+            - compose.kimai.yml
+            - KIMAI_DOMAIN
+            - SECRET_KIMAI_ID_VERSION
+            - SECRET_KIMAI_SECRET_VERSION
+            - kimai_logo.png
+    zammad:
+        uncomment:
+            - compose.zammad.yml
+            - ZAMMAD_DOMAIN
+            - zammad.svg
+    monitoring-ng:
         uncomment:
             - compose.monitoring.yml
             - MONITORING_DOMAIN
             - SECRET_MONITORING_ID_VERSION
             - SECRET_MONITORING_SECRET_VERSION
-            - monitoring.png
+            - monitoring.svg
     outline:
         uncomment:
             - compose.outline.yml
@@ -66,6 +79,58 @@ authentik:
             - rallly.png
         secrets:
             rallly_id: rallly
+    hedgedoc:
+        uncomment:  
+            - compose.hedgedoc.yml
+            - HEDGEDOC_DOMAIN
+            - SECRET_HEDGEDOC_ID_VERSION
+            - SECRET_HEDGEDOC_SECRET_VERSION
+            - hedgedoc.png
+        secrets:
+            hedgedoc_id: hedgedoc
+    pretix:
+        env:
+            APPLICATIONS: 
+                Pretix:
+                    url: https://pretix.example.com/control/
+                    group:
+            EXTRA_ICONS:
+                Pretix: ~/.abra/recipes/authentik/icons/pretix.svg
+    vaultwarden:
+        env:
+            APPLICATIONS: 
+                Vaultwarden:
+                    url: https://vaultwarden.example.com/
+                    group:
+            EXTRA_ICONS:
+                Vaultwarden: ~/.abra/recipes/authentik/icons/vaultwarden.svg
+    mila:
+        uncomment:
+            - compose.mila.yml
+            - MILA_DOMAIN
+            - MILA_GROUP
+            - SECRET_MILA_ID_VERSION
+            - SECRET_MILA_SECRET_VERSION
+            - mila.svg
+        secrets:
+            mila_id: mila
+kimai:
+    authentik:
+        uncomment:
+            - SSO_ENABLED
+            - SSO_PROVIDER_URL
+            - SSO_SAML_URL
+            - SSO_LOGOUT_URL
+        secret_hooks:
+            - insert_authentik_certificate
+zammad:
+    authentik:
+        uncomment:
+            - SSO_PROVIDER_DOMAIN
+            - IDP_SSO_TARGET_URL
+            - IDP_SLO_SERVICE_URL
+        initial-hooks:
+            - local enable_authentik_sso
 nextcloud:
     authentik:
         uncomment:
@@ -74,21 +139,22 @@ nextcloud:
             - AUTHENTIK_DOMAIN
             - SECRET_AUTHENTIK_SECRET_VERSION
             - SECRET_AUTHENTIK_ID_VERSION
-        execute:
+        initial-hooks:
             - app set_authentik
         shared_secrets:
             nextcloud_secret: authentik_secret
             nextcloud_id: authentik_id
     onlyoffice:
         uncomment:
+            - compose.onlyoffice.yml
             - ONLYOFFICE_URL
             - SECRET_ONLYOFFICE_JWT_VERSION
-        execute:
+        initial-hooks:
             - app install_onlyoffice
     collabora:
         uncomment:
             - COLLABORA_URL
-        execute:
+        initial-hooks:
             - app install_collabora
 onlyoffice:
     nextcloud:
@@ -121,7 +187,7 @@ wordpress:
             - SECRET_AUTHENTIK_SECRET_VERSION
             - SECRET_AUTHENTIK_ID_VERSION
             - LOGIN_TYPE
-        execute:
+        initial-hooks:
             - app set_authentik
         shared_secrets:
             wordpress_secret: authentik_secret
@@ -139,9 +205,8 @@ vikunja:
             - OAUTH_ENABLED
             - SECRET_OAUTH_SECRET_VERSION
         shared_secrets:
-            vikunja_secret: oauth_secret
             #vikunja_id: oauth_id
-
+            vikunja_secret: oauth_secret
 matrix-synapse:
     authentik:
         env:
@@ -160,16 +225,24 @@ matrix-synapse:
             - SECRET_KEYCLOAK_CLIENT_SECRET_VERSION
         shared_secrets:
             matrix_secret: keycloak_client_secret
+traefik:
+    matrix-synapse:
+        uncomment:
+            - compose.matrix.yml
+            - MATRIX_FEDERATION_ENABLED
 rallly:
     authentik:
         env:
             OIDC_NAME: "Authentik"
-            OIDC_DISCOVERY_URL: "https://authentik.example.com/application/o/Rallly/.well-known/openid-configuration"
+            OIDC_DISCOVERY_URL: "https://authentik.example.com/application/o/rallly/.well-known/openid-configuration"
+            OIDC_ISSUER_URL: "https://authentik.example.com/application/o/rallly/"
             OIDC_CLIENT_ID: rallly
         uncomment: 
             - compose.oidc.yml
             - SECRET_OIDC_CLIENT_SECRET_VERSION
             - OIDC_ENABLED
+        shared_secrets:
+            rallly_secret: oidc_client_secret
 wekan:
     authentik:
         env: 
@@ -191,3 +264,34 @@ wekan:
             - OIDC_REDIRECTION_ENABLED
         shared_secrets:
             wekan_secret: oauth2_secret
+hedgedoc:
+    authentik:
+        env:
+            CMD_OAUTH2_USER_PROFILE_URL: https://authentik.example.com/application/o/userinfo/
+            CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR: preferred_username
+            CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR: name
+            CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR: email
+            CMD_OAUTH2_TOKEN_URL: https://authentik.example.com/application/o/token/
+            CMD_OAUTH2_AUTHORIZATION_URL: https://authentik.example.com/application/o/authorize/
+            # TODO: set CLIENT_ID as secret
+            CMD_OAUTH2_CLIENT_ID: hedgedoc
+            CMD_OAUTH2_PROVIDERNAME: Authentik
+        uncomment: 
+            - compose.oauth.yml
+            - SECRET_OAUTH_KEY_VERSION
+        shared_secrets:
+            hedgedoc_secret: oauth_key
+mila:
+    authentik:
+        env:
+            OIDC_CLIENT_ID: mila
+            OIDC_BASE_URL: https://authentik.example.com/application/o/mila
+            OIDC_REDIRECT_URI: https://mila.example.com/auth/user/oidc/callback
+            OIDC_ADMIN_GROUP_NAME: mv_admin
+            OIDC_GROUPS_CLAIM: groups
+            OIDC_ONLY: "true"
+        uncomment:
+            - compose.oidc.yml
+            - SECRET_OIDC_CLIENT_SECRET_VERSION
+        shared_secrets:
+            mila_secret: oidc_client_secret

examples/alaka-defaults.yml

@@ -0,0 +1,95 @@
+GLOBALS:
+    bbb_secret: your_super_secret_password
+    turn_secret: your_super_secret_password
+    basic_auth_password: your_super_secret_password
+    loki_url: https://loki.monitoring.example.com/loki/api/v1/push
+    basic_auth_hash: your_super_secret_password
+authentik:
+    env:
+        EXTRA_DOMAINS: ', `example.com`'
+        DEFAULT_LANGUAGE: de
+        APPLICATIONS: '{"Calendar": "https://nextcloud.example.com/apps/calendar/", "BBB": "https://nextcloud.example.com/apps/bbb"}'
+    uncomment:
+        - calendar.svg
+        - bbb.jpg
+    initial-hooks:
+       - worker set_admin_pass
+       - worker apply_blueprints
+       - worker add_applications
+       - local set_icons
+nextcloud:
+    env: 
+        DEFAULT_QUOTA: "100 MB"
+        APPS: "calendar"
+        BBB_URL: "https://talk.example.com/bigbluebutton/"
+    uncomment:
+        - compose.apps.yml
+        - SECRET_BBB_SECRET_VERSION
+    secrets:
+        bbb_secret: "{{bbb_secret}}"
+    initial-hooks:
+        - app install_bbb
+        - app set_default_quota
+        - app install_apps
+        - app run_occ 'app:disable dashboard'
+wordpress:
+    env:
+        LOCALE: 'de_DE'
+        DEFAULT_USER_ROLE: administrator
+    uncomment:
+        - EXTRA_DOMAINS
+    initial-hooks:
+        - app core_install
+matrix-synapse:
+    env: 
+        ENCRYPTED_BY_DEFAULT: off
+        TURN_URIS: '["turns:talk.example.com:5349?transport=tcp"]'
+        RETENTION_MAX_LIFETIME: 2y
+        ALLOWED_LIFETIME_MAX: 2y
+    uncomment:
+        - POST_DEPLOY_CMDS
+        - compose.turn.yml
+        - TURN_ENABLED
+        - TURN_ALLOW_GUESTS
+        - SECRET_TURN_SHARED_SECRET_VERSION
+    secrets:
+        turn_shared_secret: "{{turn_secret}}"
+wekan:
+    uncomment:
+        - PASSWORD_LOGIN_ENABLED
+backup-bot-two:
+    uncomment:
+        - SECRET_AWS_SECRET_ACCESS_KEY_VERSION
+        - compose.s3.yml
+onlyoffice:
+    env:
+        AUTO_ASSEMBLY_ENABLED: "true"     
+outline:
+    env:
+        DEFAULT_LANGUAGE: de_DE
+hedgedoc:
+    env:
+        CMD_ALLOW_ANONYMOUS: true
+        CMD_ALLOW_ANONYMOUS_EDITS: true
+        CMD_ALLOW_FREEURL: true
+        CMD_COOKIE_POLICY: none
+traefik:
+    env:
+        DASHBOARD_ENABLED: false
+        METRICS_ENABLED: 1
+        BASIC_AUTH: 1
+    secrets:
+        usersfile: "{{basic_auth_hash}}"
+    uncomment:
+        - compose.host.yml
+        - compose.metrics.yml
+        - compose.basicauth.yml
+        - SECRET_USERSFILE_VERSION
+monitoring-ng:
+    env:
+        LOKI_PUSH_URL: "{{loki_url}}"
+    uncomment:
+        - compose.promtail.yml
+        - SECRET_BASIC_AUTH_VERSION
+    secrets:
+        basic_auth: "{{basic_auth_password}}"

examples/alaka-smtp.yml

@@ -1,25 +1,17 @@
 GLOBALS:
-    smtp_password: top-secret
+    smtp_password: your_super_secret_password
+    smtp_password_urlencoded: your_super_secret_password
     smtp_user: noreply
     smtp_domain: example.com
     smtp_host: mail.example.com
 authentik:
-    subdomain: example.com
     env:
         AUTHENTIK_EMAIL__HOST: "{{smtp_host}}"
         AUTHENTIK_EMAIL__USERNAME: "{{smtp_user}}@{{smtp_domain}}"
         AUTHENTIK_EMAIL__FROM: "{{smtp_user}}@{{smtp_domain}}"
-        DEFAULT_LANGUAGE: de
-    execute:
-       - worker set_admin_pass
-       - worker apply_blueprints
-       - worker apply_blueprints
-       - worker add_applications # Todo: fix this command
-       - local set_icons
     secrets:
         email_pass: "{{smtp_password}}"
 nextcloud:
-    subdomain: cloud.example.com
     env: 
         SMTP_AUTHTYPE: LOGIN
         SMTP_HOST: "{{smtp_host}}"
@@ -28,35 +20,28 @@ nextcloud:
         SMTP_PORT: 587
         MAIL_FROM_ADDRESS: "{{smtp_user}}"
         MAIL_DOMAIN: "{{smtp_domain}}"
-        APPS: "calendar"
-        BBB_URL: "https://talk.example.com/bigbluebutton/"
     uncomment:
         - compose.smtp.yml
         - SECRET_SMTP_PASSWORD_VERSION
         - compose.apps.yml
-        - SECRET_BBB_SECRET_VERSION
     secrets:
         smtp_password: "{{smtp_password}}"
-    execute:
-        - app install_bbb
-        - app set_default_quota
-        - app install_apps
-        # - app run_occ 'app:disable dashboard' # Todo: fix this command
 wordpress:
     env:
-        LOCALE: 'de_DE'
-        DEFAULT_USER_ROLE: administrator
         SMTP_HOST: "{{smtp_host}}"
         MAIL_FROM: "{{smtp_user}}@{{smtp_domain}}"
+        SMTP_USER: "{{smtp_user}}@{{smtp_domain}}"
+        ADMIN_EMAIL: "{{smtp_user}}@{{smtp_domain}}"
     uncomment:
         - SMTP_PORT
         - SMTP_AUTH
+        - SMTP_OVERRIDE_FROM
         - SMTP_TLS
         - SECRET_SMTP_PASSWORD_VERSION
+        - compose.smtp.yml
+        - compose.mailrelay.yml
     secrets:
         smtp_password: "{{smtp_password}}"
-    execute:
-        - app core_install
 vikunja:
     env:
         SMTP_HOST: "{{smtp_host}}"
@@ -70,30 +55,53 @@ vikunja:
     secrets:
         smtp_password: "{{smtp_password}}"
 matrix-synapse:
-    subdomain: matrix.example.com
     env: 
+        ADMIN_EMAIL: "{{smtp_user}}@{{smtp_domain}}"
         SMTP_APP_NAME: mail
         SMTP_FROM: "{{smtp_user}}@{{smtp_domain}}"
         SMTP_HOST: "{{smtp_host}}"
         SMTP_PORT: 587
         SMTP_USER: "{{smtp_user}}@{{smtp_domain}}"
-        ENCRYPTED_BY_DEFAULT: "off"
     uncomment:
-        - POST_DEPLOY_CMDS
         - compose.smtp.yml
         - SMTP_ENABLED
         - SECRET_SMTP_PASSWORD_VERSION
     secrets:
         smtp_password: "{{smtp_password}}"
-element-web:
-    subdomain: chat.example.com
 wekan:
-    subdomain: board.example.com
     env:
-        # TODO fix format for smtp_password
-        MAIL_URL: "smtp://{{smtp_user}}%40{{smtp_domain}}%3A{{smtp_password}}@{{smtp_host}}:587/"
+        MAIL_URL: "smtp://{{smtp_user}}%40{{smtp_domain}}:{{smtp_password_urlencoded}}@{{smtp_host}}:587"
         MAIL_FROM: "Wekan Notifications <{{smtp_user}}@{{smtp_domain}}>"
+outline:
+    env:
+        SMTP_HOST: "{{smtp_host}}"
+        SMTP_PORT: 465
+        SMTP_USERNAME: "{{smtp_user}}@{{smtp_domain}}"
+        SMTP_FROM_EMAIL: "{{smtp_user}}@{{smtp_domain}}"
     uncomment:
-        - PASSWORD_LOGIN_ENABLED
-backup-bot-two:
-    subdomain: backup.example.com
+        - compose.smtp.yml
+        - SMTP_ENABLED
+        - SMTP_SECURE
+        - SECRET_SMTP_PASSWORD_VERSION
+    secrets:
+        smtp_password: "{{smtp_password}}"
+rallly:
+    env:
+        SUPPORT_EMAIL: "{{smtp_user}}@{{smtp_domain}}"
+        SMTP_HOST: "{{smtp_host}}"
+        SMTP_USER: "{{smtp_user}}@{{smtp_domain}}"
+    secrets:
+        smtp_pwd: "{{smtp_password}}"
+pretix:
+    env:
+        SMTP_FROM: "{{smtp_user}}@{{smtp_domain}}"
+        SMTP_HOST: "{{smtp_host}}"
+        SMTP_USER: "{{smtp_user}}@{{smtp_domain}}"
+        SMTP_PORT: 587
+        SMTP_TLS: on
+        SMTP_SSL: off
+    secrets: 
+        smtp_password: "{{smtp_password}}"
+traefik:
+    env:
+        LETS_ENCRYPT_EMAIL: "{{smtp_user}}@{{smtp_domain}}"

examples/alaka-subdomains.yml

@@ -0,0 +1,28 @@
+authentik:
+    subdomain: login.example.com
+nextcloud:
+    subdomain: files.example.com
+wordpress:
+    subdomain: blog.example.com
+vikunja:
+    subdomain: todo.example.com
+matrix-synapse:
+    subdomain: matrix.example.com
+element-web:
+    subdomain: chat.example.com
+wekan:
+    subdomain: board.example.com
+backup-bot-two:
+    subdomain: backup.example.com
+onlyoffice:
+    subdomain: office.example.com
+outline:
+    subdomain: outline.example.com
+rallly:
+    subdomain: poll.example.com
+hedgedoc:
+    subdomain: pad.example.com
+pretix:
+    subdomain: tickets.example.com
+monitoring-ng:
+    subdomain: monitoring.example.com

examples/alaka-versions.yml

@@ -0,0 +1,30 @@
+authentik:
+    version: 3.2.4+2023.6.1
+wekan:
+    version: 2.1.0+v7.30
+nextcloud:
+    version: 5.0.3+27.0.1-fpm
+onlyoffice:
+    version: 2.6.2+7.4.0
+collabora:
+    version: 2.7.1+23.05.10.1.1
+wordpress:
+    version: 2.5.2+6.3.0
+vikunja:
+    version: 0.4.0+0.22.1
+matrix-synapse:
+    version: 5.0.2+v1.93.0
+element-web:
+    version: 0.7.0+v1.11.63
+rallly:
+    version: 0.4.1+2.11.1
+hedgedoc:
+    version: 1.0.1+1.9.9
+pretix:
+    version: 1.0.0+2024.1.0
+traefik:
+    version: 2.4.3+v2.10.5
+backup-bot-two:
+    version: chaos
+monitoring-ng:
+    version: 1.1.0+v1.7.0

examples/config-sets.yml

@@ -0,0 +1,29 @@
+# config-sets.yml
+# Place this file at your alakazam root path.
+# Each top-level key is a named config-set containing per-app configurations.
+# Activate a set in any instance .yml or alaka.yml:
+#
+#   CONFIG-SETS:
+#     bbb: true
+#     calendar: true
+#
+# Disable a set inherited from a group alaka.yml by setting it to false:
+#
+#   CONFIG-SETS:
+#     bbb: false
+#
+
+bbb:
+  authentik:
+    env:
+      APPLICATIONS:
+        BBB: https://nextcloud.example.com/apps/bbb
+  nextcloud:
+    initial-hooks:
+      - app install_bbb
+
+calendar:
+  authentik:
+    env:
+      APPLICATIONS:
+        Calendar: https://nextcloud.example.com/apps/calendar/

examples/config.yml

@@ -1,18 +0,0 @@
-domain: example-domain.com
-server: example-server.com
-apps:
-    authentik:
-        env:
-            WELCOME_MESSAGE: "Welcome to CoopCloud"
-    wekan:
-    nextcloud:
-    onlyoffice:
-    wordpress:
-        subdomain: "blog.special-domain.com"
-    vikunja:
-        subdomain: "todo.example.com"
-    matrix-synapse:
-    element-web:
-        env:
-            SERVER_NAME: testmatrix
-            BRAND: testmatrix

examples/example.com.yml

@@ -0,0 +1,25 @@
+GLOBALS: 
+    smtp_password: my_secret_password
+    smtp_password_urlencoded: my_secret_password
+    smtp_user: support
+    smtp_domain: maildomain.com
+    smtp_host: maymailhost.com
+    bbb_secret: my_secret_password
+    turn_secret: my_secret_password
+    basic_auth_password: my_secret_password
+    basic_auth_hash: my_secret_password
+traefik:
+backup-bot-two:
+monitoring-ng:
+authentik:
+nextcloud:
+onlyoffice:
+wordpress:
+vikunja:
+wekan:
+matrix-synapse:
+element-web:
+rallly:
+outline:
+hedgedoc:
+pretix:

requirements.txt

@@ -4,3 +4,7 @@ ruamel.yaml==0.18.3
 Jinja2==2.11.3
 MarkupSafe==1.1.1
 python-dotenv==1.0.0
+icecream==2.1.3
+packaging==24.0 
+GitPython==3.1.43
+uptime_kuma_api==1.2.1