can switch between languages now

docs: wording
docs: link to binaries
2023-02-10 19:10:22 +01:00 · 2023-02-10 14:49:05 +01:00 · 2023-02-10 14:46:01 +01:00 · 2023-02-10 12:48:09 +01:00 · 2023-02-10 08:04:43 +00:00 · 2023-02-10 08:04:14 +00:00
30 changed files with 802 additions and 732 deletions
@@ -1,4 +1,4 @@
-FROM squidfunk/mkdocs-material:8.1.10
+FROM squidfunk/mkdocs-material:9.0.12

 EXPOSE 8000

@@ -1,674 +1,6 @@
-                    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>.
+Copyright (C) 2022 Co-op Cloud
+Permission is granted to copy, distribute and/or modify this document under the
+terms of the GNU Free Documentation License, Version 1.3 or any later version
+published by the Free Software Foundation; with no Invariant Sections, no
+Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
+in the section entitled "GNU Free Documentation License".
@@ -0,0 +1,87 @@
+{#-
+  This file was copied from the Material theme
+  You can find the file in .venv/lib/python3.10/site-packages/material/partials/header.html
+-#}
+{% set class = "md-header" %}
+{% if "navigation.tabs.sticky" in features %}
+  {% set class = class ~ " md-header--lifted" %}
+{% endif %}
+<header class="{{ class }}" data-md-component="header">
+  <nav class="md-header__inner md-grid" aria-label="{{ lang.t('header.title') }}">
+    <a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
+      {% include "partials/logo.html" %}
+    </a>
+    <label class="md-header__button md-icon" for="__drawer">
+      {% include ".icons/material/menu" ~ ".svg" %}
+    </label>
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+            {{ config.site_name }}
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+            {% if page and page.meta and page.meta.title %}
+              {{ page.meta.title }}
+            {% else %}
+              {{ page.title }}
+            {% endif %}
+          </span>
+        </div>
+      </div>
+    </div>
+    {% if not config.theme.palette is mapping %}
+      <form class="md-header__option" data-md-component="palette">
+        {% for option in config.theme.palette %}
+          {% set primary = option.primary | replace(" ", "-") | lower %}
+          {% set accent  = option.accent  | replace(" ", "-") | lower %}
+          <input class="md-option" data-md-color-media="{{ option.media }}" data-md-color-scheme="{{ option.scheme }}" data-md-color-primary="{{ primary }}" data-md-color-accent="{{ accent }}" {% if option.toggle %} aria-label="{{ option.toggle.name }}" {% else %} aria-hidden="true" {% endif %} type="radio" name="__palette" id="__palette_{{ loop.index }}">
+          {% if option.toggle %}
+            <label class="md-header__button md-icon" title="{{ option.toggle.name }}" for="__palette_{{ loop.index0 or loop.length }}" hidden>
+              {% include ".icons/" ~ option.toggle.icon ~ ".svg" %}
+            </label>
+          {% endif %}
+        {% endfor %}
+      </form>
+    {% endif %}
+    {% if config.extra.alternate %}
+      <div class="md-header__option">
+        <div class="md-select">
+          {% set icon = config.theme.icon.alternate or "material/translate" %}
+          <button class="md-header__button md-icon" aria-label="{{ lang.t('select.language.title') }}">
+            {% include ".icons/" ~ icon ~ ".svg" %}
+          </button>
+          <div class="md-select__inner">
+            <ul class="md-select__list">
+              {% for alt in config.extra.alternate %}
+                <li class="md-select__item">
+                  <a href="{{ alt.link | url }}" hreflang="{{ alt.lang }}" class="md-select__link">
+                    {{ alt.name }}
+                  </a>
+                </li>
+                {% endfor %}
+            </ul>
+          </div>
+        </div>
+      </div>
+    {% endif %}
+    {% if config.repo_url %}
+      <div class="md-header__source">
+        {% include "partials/source.html" %}
+      </div>
+    {% endif %}
+    {% if "search" in config["plugins"] %}
+      <label class="md-header__button md-icon" for="__search">
+        {% include ".icons/material/magnify.svg" %}
+      </label>
+      {% include "partials/search.html" %}
+    {% endif %}
+  </nav>
+  {% if "navigation.tabs.sticky" in features %}
+    {% if "navigation.tabs" in features %}
+      {% include "partials/tabs.html" %}
+    {% endif %}
+  {% endif %}
+</header>
@@ -0,0 +1,52 @@
+---
+title: Cheat sheet
+---
+
+# Abra cheat sheet
+
+!!! info
+    not all flags are listed here.
+
+!!! warning
+    Definitely set up autocomplete or you'll be sad
+
+    `abra autocomplete bash/zsh/fizsh`
+
+### create and deploy a new app:
+- `abra app new $RECIPE`
+flags: `-s/--server`, `-D/--domain`, `-S/--secrets`, `-p/--pass`
+- `abra app config $APPNAME`
+- `abra app secret generate $APPNAME -a`
+flags: `-p/--pass`, `-a/--all`
+- `abra app deploy $APPNAME`
+flags: `-f/--force`, `-C/--chaos`
+
+### undeploy and remove an app
+- back up any data you don't want to lose
+- `abra app undeploy $APPNAME`
+- `abra app rm --volumes $APPNAME`
+flags: `-f/--force`, `-V/--volumes`
+
+### add/remove server
+- `abra server add $SERVER $USERNAME $SSH_PORT`
+flags: `-p/--provision`, `-l/--local`
+- `abra server remove $SERVER`
+flags: `-s/--server`
+
+### upgrade abra
+- `abra upgrade`
+flags: `--rc`
+
+### upgrade a recipe
+- `abra recipe upgrade $RECIPE`
+flags: `-x,y,z/--major,minor,patch`
+- `abra recipe sync $RECIPE`
+flags: `-x,y,z`
+- `abra recipe release $RECIPE [$VERSION]`
+flags: `-p/--publish`, `-r/--dry-run`, `-x,y,z`
+
+### make a change to a recipe
+- edit the files in `~/.abra/recipe/$RECIPENAME`
+- deploy the changed version to your test instance
+- determine how serious your change is (semver.org for reference)
+- `abra recipe release $RECIPE [$VERSION]`
@@ -16,21 +16,31 @@ Install [Go >= 1.16](https://golang.org/doc/install) and then:
 - `make install` will install it to `$GOPATH/bin`
 - `go get <package>` and `go mod tidy` to add a new dependency

-Our [Drone CI configuration](.drone.yml) runs a number of sanity on each pushed commit. See the [Makefile](./Makefile) for more handy targets.
+Our [Drone CI configuration](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/.drone.yml) runs a number of sanity on each pushed commit. See the [Makefile](./Makefile) for more handy targets.

 Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log.

+### Cross-compiling
+
+If there's no official release for the architecture you use, you can cross-compile `abra` very easily. Clone the source code from [here](https://git.coopcloud.tech/coop-cloud/abra) and then:
+
+- enter the `abra` directory
+- run `git tag -l` to see the list of tags, choose the latest one
+- run `git checkout <tag>`, where `<tag>` is the latest version
+- run `GOOS=<os> GOARCH=<arch> [GOARM=<arm>] make build`. You only have to use `GOARM` if you're building for ARM, this specifies the ARM version (5,6,7 etc). See [this](https://go.dev/doc/install/source#environment) for a list of all supported OS'es and architectures.
+
+
 ## Release management

-We use [goreleaser](https://goreleaser.com) to help us automate releases. We use [semver](https://semver.org) for versioning all releases of the tool. While we are still in the public alpha release phase, we will maintain a `0.y.z-alpha` format. Change logs are generated from our commit logs. We are still working this out and aim to refine our release praxis as we go.
+We use [goreleaser](https://goreleaser.com) to help us automate releases. We use [semver](https://semver.org) for versioning all releases of the tool. While we are still in the public beta release phase, we will maintain a `0.y.z-beta` format. Change logs are generated from our commit logs. We are still working this out and aim to refine our release praxis as we go.

-For developers, while using this `-alpha` format, the `y` part is the "major" version part. So, if you make breaking changes, you increment that and _not_ the `x` part. So, if you're on `0.1.0-alpha`, then you'd go to `0.1.1-alpha` for a backwards compatible change and `0.2.0-alpha` for a backwards incompatible change.
+For developers, while using this `-beta` format, the `y` part is the "major" version part. So, if you make breaking changes, you increment that and _not_ the `x` part. So, if you're on `0.1.0-beta`, then you'd go to `0.1.1-beta` for a backwards compatible change and `0.2.0-beta` for a backwards incompatible change.

 ### Making a new release

 - Change `ABRA_VERSION` to match the new tag in [`scripts`](./scripts/installer/installer) (use [semver](https://semver.org))
- Commit that change (e.g. `git commit -m 'chore: publish next tag x.y.z-alpha'`)
- Make a new tag (e.g. `git tag -a x.y.z-alpha`)
+- Commit that change (e.g. `git commit -m 'chore: publish next tag x.y.z-beta'`)
+- Make a new tag (e.g. `git tag -a x.y.z-beta`)
 - Push the new tag (e.g. `git push && git push --tags`)
 - Wait until the build finishes on [build.coopcloud.tech](https://build.coopcloud.tech/coop-cloud/abra)
 - Deploy the new installer script (e.g. `cd ./scripts/installer && make`)
@@ -45,3 +55,7 @@ We maintain a fork of [godotenv](https://github.com/Autonomic-Cooperative/godote
 ### `docker/client`

 A number of modules in [pkg/upstream](./pkg/upstream) are copy/pasta'd from the upstream [docker/docker/client](https://pkg.go.dev/github.com/docker/docker/client). We had to do this because upstream are not exposing their API as public.
+
+### `github.com/schultz-is/passgen`
+
+Due to [`coop-cloud/organising#358`](https://git.coopcloud.tech/coop-cloud/organising/issues/358).
@@ -2,7 +2,9 @@
 title: Abra
 ---

-`abra` is our flagship client & command-line tool which has been developed specifically in the context of the Co-op Cloud project for the purpose of making day-to-day operations for [operators](/operators/) and [maintainers](/maintainers/) as convenient as possible. It is libre software, written in [Go](https://go.dev/) and maintained and extended by the community :heart:
+<a href="https://github.com/egonelbre/gophers"><img align="right" width="250" src="https://github.com/egonelbre/gophers/raw/master/.thumb/sketch/adventure/poking-fire.png"/></a>
+
+`abra` is the flagship client & command-line for Co-op Cloud. It has been developed specifically for the purpose of making the day-to-day operations of operators and maintainers pleasant & convenient. It is libre software, written in Go and maintained and extended by the community :heart:

 Once you've got `abra` installed, you can start your own Co-op Cloud deployment. `abra` allows you to create, deploy and maintain libre software apps. It supports working with existing servers or can create new servers (supported providers: [Servers.coop](https://servers.coop/) & [Hetzner](https://hetzner.com)). It can also help you manage your DNS configuration (supported providers: [Gandi](https://gandi.net)).

@@ -17,3 +17,17 @@ curl https://install.abra.coopcloud.tech | bash -s -- --rc
 ## Installer script source

 You can view that [here](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/scripts/installer/installer).
+
+## Using Docker
+
+```
+docker run \
+	-v $HOME/.abra:/.abra \
+	git.coopcloud.tech/coop-cloud/abra app ls
+```
+
+!!! note
+	If you're using symlinks, e.g. for [sharing
+	`~/.abra`](/operators/handbook/#sharing-abra), add more `-v` options for each
+	directory you're symlinking to, e.g. `-v
+	$HOME/Projects/CoopCloud/apps:/home/user/Projects/CoopCloud/apps`
@@ -67,3 +67,39 @@ docker context create <domain> --docker "host=ssh://<user>@<domain>:<port>"
 ## Command-line flag handling is weird?

 Unfortunately, there is a limitation in our underlying command-line library implementation for `abra` ([ref](https://github.com/urfave/cli/issues/1113)) (and more fundamentally in the design of flags in the Go programming language itself ([ref](https://utcc.utoronto.ca/~cks/space/blog/programming/GoFlagUIImportance))). We're aiming to work with upstream to resolve the flag handling but this it is not yet clear when this will be resolved.
+
+Currently, the following example of flexible flag usage is supported:
+
+```
+abra app new gitea -S  # generate secrets, after args
+abra app new -S gitea  # generate secrets, before args
+```
+
+But something like the following does not work as expected:
+
+```
+abra app new -S gitea -p
+```
+
+Where the position of flags is mixed before & after args. `-p` is ignored :cry:
+
+We're still waiting for upstream patch which resovles this.
+
+## Why can't `abra` support multiline in `.env` files?
+
+We're sorry, it's an issue with an upstream dependency. See [`#291`](https://git.coopcloud.tech/coop-cloud/organising/issues/291) for more.
+
+## I need some feature from the old deprecated bash abra?
+
+There is an archive of the [old code here](https://git.coopcloud.tech/coop-cloud/abra-bash).
+
+You can install it alongside the [supported version of Abra](https://git.coopcloud.tech/coop-cloud/abra) by using these commands:
+
+```bash
+git clone https://git.coopcloud.tech/coop-cloud/abra-bash ~/.abra/bash-src
+ln -s ~/.abra/bash-src/abra ~/.local/bin/babra
+```
+
+## I am seeing very weird `lookup <domain> on <ip>: write udp <ip>: write: operation not permitted` errors
+
+You should turn off your VPN. `abra` has trouble dealing with it right now. We welcome change sets to make it work though!
@@ -18,11 +18,67 @@ abra upgrade --rc

 ## Migration guides

+### `0.6.x-beta` -> `0.7.x-beta`
+
+> **ALERTA, ALERTA**: this is currently only available via the release
+> candidate channel, using `abra upgrade --rc`. There has been a lot of churn
+> and we're being cautious about releasing this one. Please help us test! We're
+> currently on `0.7.0-rc2-beta`.
+
+- `kadabra`, the app auto-updater is available for general alpha testing! See [these docs](https://docs.coopcloud.tech/operators/tutorial/#automatic-upgrades) for how to get started. Binaries can be found [here](https://git.coopcloud.tech/coop-cloud/abra/releases/tag/0.7.0-rc2-beta).
+
+- **ALERTA, ALERTA**, security related issue: all `$domain.env` env vars are now exposed to the deployment via the `app` service container. Each `FOO=BAR` is exported within the context of the container. If you have any privately committed secrets in your `.env` files, please migrate them to the `secrets: ...` configuration in the recipe. This change was made to facilitate tooling which can support auto-upgrading of apps in a deployment.
+
+- `abra` can no longer install Docker, initialise swarm mode and the proxy network. It will check if a Docker install exists and is in swarm mode or not and error out accordingly. We leave the provisioning to tools that are designed for that and reduce the command-line surface that we have to maintain going forward.
+
+- `abra server add <host> <args>` 👉 `abra server add <host>`. We have finally removed the custom SSH handling code and now solely rely on invoke `/usr/bin/ssh` directly and reading from the `~/.ssh/config`. The `<host>` argument should correspond to a `Host <host>` entry in your `~/.ssh/config` or in an `Include <file>` statement (hosts are retrieved via `ssh -G <host>`). This means "how does `abra` interact with SSH is 1) do you have an `~/.ssh/config` entry for `<host>` 2) can you `ssh <host>` successfully? 3) there is no 3. It's an easier mental model and also the way `abra-bash` works, hence, less weird obscure errors. `<host>` being public a domain name is still required.
+
+- `abra` no longer tries to do the TOFU host key verification prompt. We follow the praxis of the Docker CLI and just give up when host keys are not validated. We leave it to folks to SSH in and verify themselves.
+
+- On the way to [`kadabra`](https://git.coopcloud.tech/coop-cloud/abra/pulls/268), several changes regarding labelling deployments have been merged in this release. This will allow tooling to understand a deployment without having the context of a `~/.abra/...` configuration. This will pave the way for server-side tooling, like `kadabra` which can help operators with different kinds of maintenance tasks.
+
+- Welcome `abra recipe fetch`, which helps retrieve a recipe repository to your local work-station.
+
+- Also say hello to `abra app services <domain>`, which lists the in-deployment service names and corresponding image, e.g. `foo_example_com`.
+
+- Digests have been removed from the catalogue generation.
+
+- Backup files generated by `abra` have a much more human-friendly format.
+
+- Linting for domains is disabled when no `DOMAIN=...` is discovered in the `$odmain.env` file.
+
+### `0.5.x-beta` -> `0.6.x-beta`
+
+- Using `{{ .Domain }}` in recipe `.envrc.sample` files went away because it
+  was portable enough. We revert to replacing e.g `gitea.example.com` with the
+  domain. See
+  [`8fad34e`](https://git.coopcloud.tech/coop-cloud/abra/commit/8fad34e) for
+  more.
+
+- If your `abra.sh` scripts depend on `/bin/sh` and `/bin/bash` is available in
+  the container then `/bin/bash` will be used from now on. `/bin/sh` is only
+  now used if `/bin/bash` is not available. See
+  [`7f745ff`](https://git.coopcloud.tech/coop-cloud/abra/commit/7f745ff) for
+  more.
+
+### `v0.4.x` -> `v0.5.x`
+
+- The only breaking change was making `abra` understand that the JSON dump for the recipes listing lives on [recipes.coopcloud.tech/recipes.json](https://recipes.coopcloud.tech) instead of [recipes.coopcloud.tech](https://recipes.coopcloud.tech).
+
 ### `v0.3.x` -> `v0.4.x`

 Make sure to back up your `~/.abra/servers` configurations first for safety.

- `mv ~/.abra/apps ~/.abra/recipes`
- `find ~/.abra/servers/ -type f -exec sed -i "s/^TYPE=/RECIPE=/g" {} \;`
+- Please run `mv ~/.abra/apps ~/.abra/recipes`.
+
 - "app name" as a concept went away, `abra` now uses the domain name of an app as the identifier. However, we don't expect to see breaking behaviour if you have `.env` files like `~/.abra/servers/foo.com/mycoolapp.env` and you still want to run `abra app ps mycoolapp`. `abra` still reads the filename to figure out the identifier. When running `abra app new <recipe>`, `abra` will now take the domain name as the name of the `.env` file.
+
 - `abra` has a new SSH implementation which enforces SSH host key checking. You may run into connection issues as a result of this code churn, please see [this entry](/abra/trouble/#ssh-connection-issues) for help navigating a fix.
+
+- CLI flag/args handling has been made more flexible. We're working within the constraints of an upstream library issue but have hopefully made it easier to mange passing flags to commands with `abra`. See [this troubleshooting entry](/abra/trouble/#command-line-flag-handling-is-weird) for the full review.
+
+- A number of short style flags have been re-mapped and/or added. This is again related to an issue with the upstream CLI library which sometimes understands short style flags as long style flags. E.g. `--ch` instead of `-ch` for `--chaos`. As a concrete example, `--ch` is now `-C` on `abra app deploy`.
+
+- `abra app backup` & `abra app restore` are ready for alpha-testing! See [this entry](https://docs.coopcloud.tech/maintainers/handbook/#how-do-i-configure-backuprestore) and [that entry](https://docs.coopcloud.tech/operators/handbook/#how-do-i-backuprestore-my-app) for more.
+
+- `abra server add --traefik` went away, it was too unreliable & hard to maintain.
@@ -0,0 +1,5 @@
+---
+title: Decisions
+---
+
+Placeholder for all the wonderful decisions we will make together.
@@ -0,0 +1,5 @@
+---
+title: Democracy
+---
+
+Placeholder for all the wonderful things we will do together.
@@ -6,7 +6,7 @@ title: Get Involved

 > :trumpet: **You don't have to be a programmer to contribute to this project!** :trumpet:

-Firstly, come say hello in our [chat room](/intro/contact/) if you'd like to help out or re interested to learn how :wave:
+Firstly, come say hello in our [chat room](/intro/contact/) if you'd like to help out or are interested to learn how :wave:

 We are happy to have designers, critical thinkers, artists, hackers, documenters, etc. involved in this project! There is a lot of work to do, if you find this project interesting, we want to have you working with us.

@@ -40,7 +40,7 @@ A [Docker](glossary#docker) related concept: a virtual network created on the se

 ## Recipe

-A recipe is what we call the configuration files that are used to deploy an [app](/glossary#app). When you run `abra app deploy <domain>`, `abra` is reading a recipe configuration, such as [the gitea recipe](https://git.coopcloud.tech/coop-cloud/gitea), in order to know how to deploy a new Gitea instance. When we speak of a "digital configuraiton commons", we're primarily referring to the [growing collection of recipes](https://git.coopcloud.tech/coop-cloud).
+A recipe is what we call the configuration files that are used to deploy an [app](/glossary#app). When you run `abra app deploy <domain>`, `abra` is reading a recipe configuration, such as [the gitea recipe](https://git.coopcloud.tech/coop-cloud/gitea), in order to know how to deploy a new Gitea instance. When we speak of a "digital configuration commons", we're primarily referring to the [growing collection of recipes](https://git.coopcloud.tech/coop-cloud).

 ## Secret

@@ -16,9 +16,9 @@ We'd be happy to hear feedback about our documentation, if it was helpful, what

 !!! danger "Here be dragons"

-    This project is still [alpha quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) :bomb: Please take that into consideration if you are thinking about using this system in production. We're working hard to make Co-op Cloud stable. In the meantime, this is a good time to help us out with initial testing, feedback, ideas or [join in with development](/get-involved/).
+    This project is still [beta quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) :bomb: Please take that into consideration if you are thinking about using this system in production. We're working hard to make Co-op Cloud stable. In the meantime, this is a good time to help us out with initial testing, feedback, ideas or [join in with development](/get-involved/).

- [Operators guide](/operators/): You run a Co-op Cloud deployment or want to do so :computer:
+- [Operators guide](/operators/): You run a Co-op Cloud based deployment or want to do so :computer:

 - [Maintainers guide](/maintainers/): You maintain recipes and ensure things run smoothly for operators :tools:

@@ -0,0 +1,33 @@
+---
+title: Wstęp
+---
+
+## Who is this for?
+
+Witaj w dokumentacji Co-op Cloud!
+
+Ta dokumentacja jest skierowana do odbiorców "technicznych": spółdzielni technologicznych, kolektywów i osób indywidualnych zainteresowanych Co-op Cloud, lub takich, które mają już deploymenty Co-op Cloud.
+
+A more general public may still find these pages useful but if you're just looking for a quick overview of the project from a less technical perspective, you can take a look at [coopcloud.tech](https://coopcloud.tech).
+
+We'd be happy to hear feedback about our documentation, if it was helpful, what was missing, what was confusing, etc., please [get in touch](/intro/contact)!
+
+## Quick start
+
+!!! danger "Here be dragons"
+
+    This project is still [beta quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) :bomb: Please take that into consideration if you are thinking about using this system in production. We're working hard to make Co-op Cloud stable. In the meantime, this is a good time to help us out with initial testing, feedback, ideas or [join in with development](/get-involved/).
+
+- [Operators guide](/operators/): You run a Co-op Cloud based deployment or want to do so :computer:
+
+- [Maintainers guide](/maintainers/): You maintain recipes and ensure things run smoothly for operators :tools:
+
+- [Organisers guide](/organisers): You run meetings, write guidelines & shape our democratic process :fist:
+
+- [Recipes](/recipes/): You want to know what recipes are packaged so you can deploy them as apps :nerd:
+
+- [Abra](/abra): You want to install the command-line client and hack the planet :unicorn:
+
+- [Get involved](/get-involved): You'd like to help out with the project, we've love to see you stick around :heart:
+
+- [Glossary](/glossary/): You'd like clarification about project terminology :book:
@@ -2,8 +2,8 @@
 title: Bike map
 ---

- The project is currently in an [alpha quality](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) release state.
+- The project is currently in a [beta quality](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) release state.

- We are working towards a [beta release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta). Our public Beta goals are listed in the following pad: [Beta Bike Map](https://pad.autonomic.zone/s/C3uuqfSCk).
+- We are working towards a stable `1.0.0` release.

 - What we're currently working on is listed on this issue tracker: [`coop-cloud/organising`](https://git.autonomic.zone/coop-cloud/organising/issues).
@@ -13,7 +13,7 @@ title: Get in touch
 Here is a link to the [Matrix space](https://matrix.to/#/!xSMwGbdVehScXcIFwS:autonomic.zone?via=autonomic.zone&via=matrix.org&via=1312.media) to see all channels.

 - [`#coopcloud:autonomic.zone`](https://matrix.to/#/!JSVYWCRXSVMrAzgeKB:autonomic.zone?via=autonomic.zone) General chat and announcements (low traffic)
- [`#coopcloud-tech:autonomic.zone`](https://matrix.to/#/!IFazIpLtxiScqbHqoa:autonomic.zone?via=autonomic.zone) Technical discussions (some techno babble)
+- [`#coopcloud-tech:autonomic.zone`](https://matrix.to/#/!DfXPgKLoYCvjHithgS:autonomic.zone?via=autonomic.zone) Technical discussions (some techno babble)
 - [`#coopcloud-dev:autonomic.zone`](https://matrix.to/#/!IFazIpLtxiScqbHqoa:autonomic.zone?via=autonomic.zone) Intense developer chat (a lot of techno babble)

 ### XMPP
@@ -9,4 +9,5 @@ Special thanks to:
 - [Doop Coop](mailto:cluck@doop.coop), for making a transparent version of the Co-op Cloud logo, and helping with OSX alpha testing.
 - [Social.coop](https://social.coop), for warmly welcoming us onto [`social.coop/@coopcloud`](https://social.coop/@coopcloud).
 - [Servers.coop](https://servers.coop), for hosting our digital infrastructure (website, builds, git hosting, etc.).
- Every single last one of you heroic & patient alpha/beta testers, you are all comrades of the highest order of kropotkin :heart:
+- Every single last one of you heroic & patient beta testers, you are all comrades of the highest order of kropotkin :heart:
+- [`egonelbre/gophers`](https://github.com/egonelbre/gophers) for the rad gopher logos
@@ -36,9 +36,9 @@ Please read our [initial project announcement post](https://autonomic.zone/blog/

 Also see our [strategy page](/strategy/).

-## How do I package an app?
+## How do I make a recipe for (package) an app?

-See [the packager guide documentation](/packager-guide/#package-your-first-application) for more.
+See ["Package your first recipe"](/maintainers/tutorial/#package-your-first-recipe) for more.

 ## What about `$alternative`?

@@ -178,7 +178,7 @@ We definitely recommend using best-in-class security auditing tools like [docker

 It's up to how you want to arrange your system. For example, Co-op Cloud also allows you to compartmentalise different apps onto different servers. You could stack a bunch of apps on one big server or you could deploy one app per server.

-These are organisational concerns that Co-op Cloud can't solve for you which any software system will require. See this [additional question](/faq/#what-is-important-to-consider-when-running-containers-in-production) for further information.
+These are organisational concerns that Co-op Cloud can't solve for you which any software system will require. See this [additional question](/intro/faq/#what-is-important-to-consider-when-running-containers-in-production) for further information.

 ## What is important to consider when running containers in production?

@@ -210,7 +210,7 @@ We are happy to see the compose specification emerging as a new open standard be

 ## Why Docker Swarm?

-While many have noted that "swarm is dead" it is in fact [not dead](https://www.mirantis.com/blog/mirantis-will-continue-to-support-and-develop-docker-swarm/). As detailed in the [architecture overview page](/overview/#container-orchestrator), swarm offers an appropriate feature set which allows us to support zero-down time upgrades, seamless app rollbacks, automatic deploy failure handling, scaling, hybrid cloud setups and maintain a decentralised design.
+While many have noted that "swarm is dead" it is in fact [not dead](https://www.mirantis.com/blog/mirantis-will-continue-to-support-and-develop-docker-swarm/). As detailed in the [architecture overview](/operators/tutorial/#container-orchestrator), swarm offers an appropriate feature set which allows us to support zero-down time upgrades, seamless app rollbacks, automatic deploy failure handling, scaling, hybrid cloud setups and maintain a decentralised design.

 While the industry is bordering on a [k8s](https://kubernetes.io/) obsession and the need to [scale down](https://microk8s.io/) a tool that was fundamentally built for massive scale, we are going with swarm because it is the tool most suitable for [small technology](https://small-tech.org/).

@@ -249,3 +249,5 @@ Yes! Horizontal scaling is one of the ways Co-op Cloud can really shine. `abra`
 ## Why only x86 support?

 We would love to do ARM support and hope to get there! We've been testing this and [ran into some issues](https://git.autonomic.zone/coop-cloud/organising/issues/25). The TLDR; is that a lot of upstream libre app developer communities are not publishing container builds that support ARM. If they are, there are typically subtle differences in the conventions used to build the image as they are mostly done by community members and not directly taken on by the upstream project themselves. Since one of the core goals is to coordinate and reuse upstream packaging work, we see that ARM support requires a lot of organising and community engagement. Perhaps projects themselves will not want to take on this burden? It is not the role of the Co-op Cloud to set up an entire ARM publishing work flow at this moment in time. We see the benefits of supporting ARM and if you've got ideas / thoughts / approaches for how to make progress here, [please get in touch](/intro/contact/).
+
+Update: [Can I run Co-op Cloud on ARM?](/operators/handbook/#can-i-run-co-op-cloud-on-arm)
@@ -6,6 +6,8 @@ title: Managed hosting

    If you're a co-operative or a tech collective who wants to appear on this list, please [get in touch](/intro/contact/)! We want to expand the number of service providers using the Co-op Cloud so that project is more widely available to end-users and organisations who can influence the direction and co-fund the development.

-The Co-op Cloud is still [alpha quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) :bomb: but you can still work with a tech co-op or collective to host some part or all of your online digital services with it. Organisations who want to support the project can get in touch with Co-op Cloud service providers via the following list for a quote on what they're looking for and how much it will cost. Service providers can then factor in some percentage of the cost to co-fund the development of this project.
+The Co-op Cloud is still [beta quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) :bomb: but you can still work with a tech co-op or collective to host some part or all of your online digital services with it. Organisations who want to support the project can get in touch with Co-op Cloud service providers via the following list for a quote on what they're looking for and how much it will cost. Service providers can then factor in some percentage of the cost to co-fund the development of this project.

 - [Autonomic Co-op](https://autonomic.zone) (contact: [`helo@autonomic.zone`](mailto:helo@autonomic.zone))
+- [Local-IT](https://local-it.org/) (contact [`info@local-it.org`](mailto:info@local-it.org))
+- [Solisoft](https://solisoft.top) (contact [`contact@solisoft.top`](mailto:contact@solisoft.top))
@@ -6,6 +6,10 @@ title: Packaging handbook

 You can run `abra recipe new <recipe>` to generate a new `~/.abra/recipes/<recipe>` repository. The generated repository is a copy of [`coop-cloud/example`](https://git.coopcloud.tech/coop-cloud/example).

+## Hacking on an existing recipe
+
+If you want to make changes to an existing recipe then you can simply edit the files in `~/.abra/recipes/<recipe-name>` and run pass `--chaos` to the `deploy` command when deploying those changes. `abra` will not deploy unstaged changes to avoid instability but you can tell it to do so with `--chaos`. This means ou can simple hack away on the existing recipe files on your local file system and then when something is working, submit a change request to the recipe upstream.
+
 ## How is a recipe structured?

 ### `compose.yml`
@@ -220,11 +224,11 @@ file_env "DB_PASSWORD"
 Sometimes the containers don't even have Bash installed on them. You had better just use `/bin/sh` or, in your entrypoint script, install Bash :upside_down: The entrypoint secrets hack listed above doesn't work in this case (as it requires Bash), so instead you can just do `export FOO=$(cat /run/secrets/<secret-name>)`.


-## Reference services in configs?
+## How do I reference services in configs?

 When referencing an `app` service in a config file, you should prefix with the `STACK_NAME` to avoid namespace conflicts (because all these containers sit on the traefik overlay network). You might want to do something like this `{{ env "STACK_NAME" }}_app` (using  the often obscure dark magic of the Golang templating language). You can find examples of this approach used in the [Peertube recipe](https://git.coopcloud.tech/coop-cloud/peertube/src/commit/d1b297c5a6a23a06bf97bb954104ddfd7f736568/nginx.conf.tmpl#L9).

-## How are recipes are versioned?
+## How are recipes versioned?

 We'll use an example to work through this. Let's use [Gitea](https://hub.docker.com/r/gitea/gitea).

@@ -360,7 +364,7 @@ mkdir -p releases

 And then create a text file which corresponds to the version release, e.g. `1.1.0+5.9.0` and write some notes. `abra` will show these when another operator runs `abra app deploy` / `abra app upgrade`.

-## Generate the recipe catalogue
+## How do I generate the recipe catalogue

 To generate an entire new copy of the catalogue:

@@ -389,7 +393,7 @@ You can pass `--publish` to have `abra` automatically publish those changes.

    In order to have `abra` publish changes for you automatically, you'll have to have write permissons to the git.coopcloud.tech repository and your account must have a working SSH key configuration. `abra` will use the SSH based URL connection details for Git by automagically creating an `origin-ssh` remote in the repository and pushing to it.

-## Enable healthchecks
+## How do I enable healthchecks

 A healthcheck is an important and often overlooked part of the recipe configuration. It is part of the configuration that the runtime uses to figure out if a container is really up-and-running. You can tweak what command to run, how often and how many times to try until you assume the container is not up.

@@ -406,7 +410,7 @@ If you're just starting off with packaging a recipe, you can use `healthcheck: d

 `abra app errors -w <domain>` will show what errors are being reported from a failing healtcheck setup.

-## Tuning deploy configs
+## How do I tune deploy configs?

 A bit like healtchecks, there is no universal setup. A good default seems to be the following configuration:

@@ -427,13 +431,13 @@ Setting a restart policy is also good so that the runtime doesn't try to restart

 Best to [read](https://docs.docker.com/engine/reference/builder/#healthcheck) [the docs](https://docs.docker.com/compose/compose-file/compose-file-v3/#healthcheck) on this one.

-## Tuning resource limits
+## How do I tune resource limits?

 If you don't place resource limits on your app it will assume it can use the entire capacity of the server it is on. This can cause issues such as OOM eerors for your entire swarm.

 See the [Docker documentation](https://docs.docker.com/config/containers/resource_constraints/) to get into this topic and check the other recipes to see what other maintainers are doing.

-## Enable A+ SSL ratings
+## How do I enable A+ SSL ratings?

 If you want to get the highest rating on SSL certs, you can use the following traefik labels which use a tweaked Traefik configuration.

@@ -443,3 +447,95 @@ If you want to get the highest rating on SSL certs, you can use the following tr
 ```

 See [this PR](https://git.coopcloud.tech/coop-cloud/traefik/pulls/8/files) for the technical details
+
+## How do I tweak secret generation length?
+
+It is possible to tell `abra` which length it should generate secrets with from your recipe config.
+
+You do this by adding a inline comment to the secret definition in the `.env.sample` / `.env` file.
+
+Here are examples from the gitea recipe:
+
+```
+SECRET_INTERNAL_TOKEN_VERSION=v1 # length=105
+SECRET_JWT_SECRET_VERSION=v1 # length=43
+SECRET_SECRET_KEY_VERSION=v1 # length=64
+```
+
+When using this length specifier, `abra` will not use the "easy to remember
+word" style generator but instead a string of characters to match the exact
+length. This can be useful if you have to generate "key" style values instead
+of passwords which admins have to type out in database shells.
+
+## How are recipes added to the catalogue?
+
+> This is so far a manual process which requires someone who's been added to the
+> `coop-cloud` "Organisation" on https://git.coopcloud.tech. This is a temporary
+> situation, we want to open out this process & also introduce some automation
+> to support making thie process more convenient. Please nag us to move things
+> along.
+
+- Publish your new recipe on the [git.coopcloud.tech](https://git.coopcloud.tech/coop-cloud) "Organisation"
+- Run `abra catalogue generate <recipe> -p`
+- Run `cd ~/.abra/catalogue && make`
+
+These minimal steps will publish a new recipe with no versions. You can also do
+the [recipe release publishing dance](https://docs.coopcloud.tech/maintainers/handbook/#how-do-i-release-a-new-recipe-version)
+which will then extend the `versions: [...]` section of the published JSON in the catalogue.
+
+Recipes that are not included in the catalogue can still be deployed. It is not
+required to add your recipes to the catalogue, but this will improve the
+visibility for other co-op hosters & end-users.
+
+For now, it is best to [get in touch](https://docs.coopcloud.tech/intro/contact/) if you want to add your recipe to the catalogue.
+
+In the future, we'd like to support [multiple catalogues](https://git.coopcloud.tech/coop-cloud/organising/issues/139).
+
+## How do I configure backup/restore?
+
+From the perspective of the recipe maintainer, backup/restore is just more
+`deploy: ...` labels. Tools can read these labels and then perform the
+backup/restore logic.
+
+### Tools
+
+Two of the current "blessed" options are
+[`backup-bot-two`](https://git.coopcloud.tech/coop-cloud/backup-bot-two) &
+[`abra`](https://git.coopcloud.tech/coop-cloud/abra).
+
+#### `backup-bot-two`
+
+Please see the [`README.md`](https://git.coopcloud.tech/coop-cloud/backup-bot-two#backupbot-ii) for the full docs.
+
+#### `abra`
+
+`abra` will read labels and store backups in `~/.abra/backups/...`.
+
+### Backup
+
+For backup, here are the labels & some examples:
+
+- `backupbot.backup=true`: turn on backup logic
+- `backupbot.backup.pre-hook=mysqldump -u root -pghost ghost --tab /var/lib/foo`: command to run before backing up
+- `backupbot.backup.post-hook=rm -rf /var/lib/mysql-files/*`: command to run after backing up
+- `backupbot.backup.path=/var/lib/foo,/var/lib/bar`: paths to back up
+
+You place these on your recipe configuration and then tools can run backups.
+
+### Restore
+
+Restore, in this context means, "moving a compressed archive back to the
+container backup paths". So, if you set
+`backupbot.backup.path=/var/lib/foo,/var/lib/bar` and you have a backed up
+archive, tooling will unzip files in the archive back to those paths.
+
+In the case of restoring database tables, you can use the `pre-hook` &
+`post-hook` commands to run the insertion logic.
+
+## Can I override a service within a recipe?
+
+You can use [this `docker-compose` trick](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files) to do this.
+
+If you have a recipe that is using a `mysql` service and you'd like to use `postgresql` instead, you can create a `compose.psql.yml`!
+
+An example of this is the [`selfoss`](https://git.coopcloud.tech/coop-cloud/selfoss) recipe. The default is `sqlite` but there is a `postgresql` compose configuration there too.
@@ -8,7 +8,9 @@ title: New maintainers tutorial

 Packaging a recipe is basically knowing a bag of about 20 tricks. Once you learn them, there is nothing more to learn. It can seem daunting at first but it's simple and easy to do once you know the tricks.

-The nice thing about packaging is that only one person has to do it and then we all benefit. We've seen that over time, the core of the configuration doesn't really change. New options and versions might come but the config remains quite stable. This is good since it meand that your packaging work stays relevant and useful for other maintainers & operators as time goes on.
+The nice thing about packaging is that only one person has to do it and then we all benefit. We've seen that over time, the core of the configuration doesn't really change. New options and versions might come but the config remains quite stable. This is good since it means that your packaging work stays relevant and useful for other maintainers & operators as time goes on.
+
+Depending on your familiarity with recipes, it might be worth reading [how a recipe is structured](/maintainers/handbook/#how-is-a-recipe-structured) and making clear you understand [what a recipe is](/glossary/#recipe) before continuing.

 ### Making a plan

@@ -19,7 +21,7 @@ The idea scenario is when the upstream project provides both the packaged image
 - **Inspired**: Upstream image, someone else's compose file
 - **On fire**: Upstream image, upstream compose file

-### Writing the `compose.yml`
+### Writing / adapting the `compose.yml`

 Let's take a practical example, [Matomo web analytics](https://matomo.org/). We'll be making a Docker "swarm-mode" `compose.yml` file.

@@ -64,8 +66,8 @@ abra app new matomo --secrets \
 --server swarm.example.com
 ```

-Depending on whether you defined any extra environment variables, we didn't so
-far, in this example, you might want to run `abra app config swarm.example.com`
+Depending on whether you defined any extra environment variables -- we didn't so
+far, in this example -- you might want to run `abra app config swarm.example.com`
 to check the configuration.

 Otherwise, or once you've done that, go ahead and deploy the app:
@@ -78,4 +80,4 @@ Then, open the `DOMAIN` you configured (you might need to wait a while for Traef

 ### Finishing up

-You've probably got more questions, check out the [maintainers handbook](/maintainers/handbook)!
+You've probably got more questions, check out the [packaging handbook](/maintainers/handbook)!
@@ -82,11 +82,23 @@ Then, tell your collaborators (e.g. in the repository's `README.md`), to run `ma

    We don't currently recommend this, because it might set inaccurate expectations about the security model – remember that, by default, **any user who can deploy apps to a Docker Swarm can manage _any_ app in that swarm**.

+### Migrating a server into a repository
+
+Even if you've got your existing server configs in version control, by default, `abra server add` will define the server locally. To move it -- taking the example of `newserver.example.com`:
+
+```
+mv ~/.abra/servers/newserver.example.com ~/coop-cloud-apps/
+cd ~/coop-cloud-apps
+git add newserver.example.com
+git commit
+make link
+```
+
 ## Running abra server side

 If you're on an environment where it's hard to run Docker, or command-line programs in general, you might want to install `abra` on a server instead of your local work station.

-To install `abra` on a different server than you'll be hosting your apps, just follow [getting started guide](/operators/tutorial#deploy-your-first-app) as normal except for one difference. Instead of providing your SSH connection details when you run `abra server add ...`, just pass `--local`.
+To install `abra` on the same server where you'll be hosting your apps, just follow [getting started guide](/operators/tutorial#deploy-your-first-app) as normal except for one difference. Instead of providing your SSH connection details when you run `abra server add ...`, just pass `--local`.

 ```
 abra server add --local
@@ -104,7 +116,7 @@ Co-op Cloud uses [Docker Secrets](https://docs.docker.com/engine/swarm/secrets/)

 `abra` includes several commands to make it easier to manage secrets:

- `abra app secret generate <domain>`: to auto-generate a app secrets
+- `abra app secret generate <domain>`: to auto-generate app secrets
 - `abra app secret insert <domain>`: to insert a single secret
 - `abra app secret rm <domain>`: to remove secrets

@@ -217,6 +229,29 @@ Otherwise, you have downloaded a corrupted file.

 If you want to teach `abra` how to support your favourite server hosting provider, we'd glady accept patches.

+## How do I bootstrap a server for running Co-op Cloud apps?
+
+The requirements are:
+
+1. Docker installed
+1. User in Docker user group
+1. Swarm mode initialised
+1. Proxy network created
+
+```
+# docker install convenience script
+wget -O- https://get.docker.com | bash
+
+# add user to docker group
+usermod -aG docker $USER
+
+# setup swarm
+docker swarm init
+docker network create -d overlay proxy
+```
+
+`abra` will do this for you when you run `abra server add --provision`.
+
 ## Managing DNS entries

 `abra record ...` can help you manage your DNS entries if you have an account with a supported 3rd party provider. We currently support [Gandi](https://gandi.net). The process of managing DNS with `abra` usually goes like this:
@@ -228,3 +263,127 @@ If you want to teach `abra` how to support your favourite server hosting provide
 `abra` supports creating, listing and removing DNS entries if the 3rd party integration supports it.

 If you want to teach `abra` how to support your favourite server hosting provider, we'd glady accept patches.
+
+## How do I persist container logs after they go away?
+
+This is a big topic but in general, if you're looking for something quick & easy, you can use the [journald logging driver](https://docs.docker.com/config/containers/logging/journald/). This will hook the container logs into systemd which can handle persistent log collection & managing log file size.
+
+You need to add the following to your `/etc/docker/daemon.json` file on the server:
+
+```json
+{
+    "log-driver": "journald",
+    "log-opts": {
+      "labels":"com.docker.swarm.service.name"
+    }
+}
+```
+
+And for log size management, edit `/etc/systemd/journald.conf`:
+
+```
+[Journal]
+Storage=persistent
+SystemMaxUse=5G
+MaxFileSec=1month
+```
+
+Tne restart `docker` & `journald`:
+
+```
+systemctl restart docker
+systemctl restart systemd-journald
+```
+
+Now when you use `docker service logs` or `abra app logs`, it will read from the systemd journald logger seamlessly! Some useful `journalctl` commands are as follows, if you're doing some more fine grained logs investigation:
+
+- `journalctl -f`
+- `journalctl CONTAINER_NAME=my_git_com_app.1.jxn9r85el63pdz42ykjnmh792 -f`
+- `journalctl COM_DOCKER_SWARM_SERVICE_NAME=my_git_com_app --since="2020-09-18 13:00:00" --until="2020-09-18 13:01:00"`
+- `journalctl CONTAINER_ID=$(docker ps -qf name=my_git_com_app) -f`
+
+Also, for more system wide analysis stuff:
+
+- `journalctl --disk-usage`
+- `du -sh /var/log/journal/*`
+- `man journalctl` / `man systemd-journald` / `man journald.conf`
+
+## How do I specify a custom user/port for SSH connections with `abra`?
+
+`abra` uses plain 'ol SSH under the hood and aims to make use of your existing SSH configurations in `~/.ssh/config` and interfaces with your running `ssh-agent` for password protected secret key files.
+
+The `server add` command listed above assumes that that you make SSH connections on port 22 using your current username. If that is not he case, pass the new values as positional arguments. See `abra server add -h` for more on this.
+
+```bash
+abra server add <domain> <user> <port> -p
+```
+
+Running `server add` with `-d/--debug` should help you debug what is going on under the hood. It's best to take a moment to read [this troubleshooting entry](/abra/trouble/#ssh-connection-issues) if you're running into SSH connection issues with `abra`.
+
+## How do I attach to a running container?
+
+If you need to run a command within a running container you can use `abra app run <domain> <service> <command>`. For example, you could run `abra app run cloud.lumbung.space app bash` to open a new bash terminal session inside your remote container.
+
+## How do I attach on a non-running container?
+
+If you need to run a command on a container that won't start (eg. the container is stuck in a restart loop) you can temporarily disable its default entrypoint by setting it in `compose.yml` to something like ['tail', '-f', '/dev/null'], then redeploy the stack (with `--force --chaos` so you don't need to commit), then [get into the now running container](#how-do-i-attach-to-a-running-container), do your business, and when done revert the compose.yml change and redeploy again. 
+
+## Can I run Co-op Cloud on ARM?
+
+`@Mayel`:
+
+> FYI I've been running on ARM for a while with no troubles (as long as images
+> used support it of course, `abra` doesn't work yet!) 😀 ... in cases where I
+> couldn't find a multiarch image I simply have eg. image: ${DB_DOCKER_IMAGE}
+> in the docker-compose and set that to a compatible image in the env config
+> ... there was really nothing to it, apart from making sure to use multiarch
+> or arm images
+
+See [`#312`](https://git.coopcloud.tech/coop-cloud/organising/issues/312) for more.
+
+## How do I backup/restore my app?
+
+If you're app [supports backup/restore](/handbook/#how-do-i-configure-backuprestore) then you have two options: [`backup-bot-two`](https://git.coopcloud.tech/coop-cloud/backup-bot-two) & [`abra`](https://git.coopcloud.tech/coop-cloud/abra).
+
+With `abra`, you can simply run `abra app backup ...` & `abra app restore ...`.
+Pass `-h` for more information on the specific flags & arguments.
+
+## How do I take a manual database backup?
+
+MySQL / MariaDB:
+
+```
+abra app run foo.bar.com db mysqldump -u root <database> | gzip > ~/.abra/backups/foo.bar.com_db_`date +%F`.sql.gz
+```
+
+Postgres:
+
+```
+abra app run foo.bar.com db pg_dump -u root <database> | gzip > ~/.abra/backups/foo.bar.com_db_`date +%F`.sql.gz
+```
+
+If you get errors about database access:
+- Make sure you've specified the right database user (`root` above) and db name
+- If you have a database password set, you might need to load it from a secret,
+    something like this:
+
+```
+abra app run foo.bar.com db bash -c 'mysqldump -u root -p"$(cat /run/secrets/db_oot_password)" <database>' | gzip > ~/.abra/backups/foo.bar.com_db_`date +%F`.sql.gz
+```
+
+## Can I deploy a recipe without `abra`?
+
+Yes! It's a design goal to keep the recipes not dependent on `abra` or any
+single tool that we develop. This means the configurationc commons can still be
+useful beyond this project. You can deploy a recipe with standard commands like
+so:
+
+```
+set -a
+source example.com.env
+cd ~/.abra/recipes/myrecipe
+docker stack deploy -c compose.yml example_com
+```
+
+`abra` makes all of this more cenvenient but other tooling could follow this
+approach.
@@ -75,7 +75,7 @@ Finally, we need a tool to read the recipe package format and actually deploy th

 `abra` aims at providing a simple command-line interface for managing your own Co-op Cloud. You can bootstrap machines with the required tools, create new apps and deploy them. `abra` is written in [Go](https://go.dev/) and uses a lot of the libraries that the `docker` and `docker-compose` CLIs use but does not rely on those interfaces directly.

-`abra` is our flagship command-line client but it does not need to be the only client. `abra` was designed in such a way that is complements a workflow which can still be done completely manually. If Co-op Cloud goes away tomorrow, our configuration commons would still be useful and usable.
+`abra` is our flagship command-line client but it does not need to be the only client. `abra` was designed in such a way that it complements a workflow which can still be done completely manually. If Co-op Cloud goes away tomorrow, our configuration commons would still be useful and usable.

 [abra]: /abra/

@@ -94,14 +94,28 @@ The tutorial tries to help you make choices about which server and which DNS set

 ### Server setup

-Co-op Cloud has itself near zero system requirements. You only need to worry about the system resource usage of your apps and the overhead of running containers with the docker runtime (often negligible. If you want to know more, see [this FAQ entry](/faq/#isnt-running-everything-in-containers-inefficient)).
+Co-op Cloud has itself near zero system requirements. You only need to worry about the system resource usage of your apps and the overhead of running containers with the docker runtime (often negligible. If you want to know more, see [this FAQ entry](/intro/faq/#isnt-running-everything-in-containers-inefficient)).

-We will deploy a new Nextcloud instance in this guide, so you will only need 1GB of RAM according to [their documentation](https://docs.nextcloud.com/server/latest/admin_manual/installation/system_requirements.html). You may also be interested in this [FAQ entry](/faq/#arent-containers-horrible-from-a-security-perspective) if you are curious about security in the context of containers.
+We will deploy a new Nextcloud instance in this guide, so you will only need 1GB of RAM according to [their documentation](https://docs.nextcloud.com/server/latest/admin_manual/installation/system_requirements.html). You may also be interested in this [FAQ entry](/intro/faq/#arent-containers-horrible-from-a-security-perspective) if you are curious about security in the context of containers.

 Most Co-op Cloud deployments have been run on Debian machines so far. Some experiments have been done on single board computers & servers with low resource capacities.

 You need to keep port `:80` and `:443` free on your server for web proxying to your apps. Typically, you don't need to keep any other ports free as the core web proxy ([Traefik](https://traefik.io)) keeps all app ports internal to its network. Sometimes however, you need to expose an app port when you need to use a transport which would perform better or more reliably without proxying.

+`abra` has support for both creating servers (`abra server new`) & provisioning them (passing `--provision` to `abra server add`) but those are more advanced automation options which are covered in the [handbook](/operators/handbook). For this tutorial, we'll focus on the basics. Assuming you've managed to create a testing VPS with some `$hosting_provider`, you'll need to install Docker, add your user to the Docker group & setup swarm mode:
+
+```
+# docker install convenience script
+wget -O- https://get.docker.com | bash
+
+# add user to docker group
+sudo usermod -aG docker $USER
+
+# setup swarm
+docker swarm init
+docker network create -d overlay proxy
+```
+
 !!! question "Do you support multiple web proxies?"

    We do not know if it is feasible and convenient to set things up on an existing server with another web proxy which uses ports `:80` & `:443`. We'd happily receive reports and documentation on how to do this if you manage to set it up!
@@ -154,17 +168,7 @@ Now you can connect `abra` with your server. You need to have a working SSH conf
 abra server add <server-domain> -p
 ```

-!!! warning "Beware of SSH dragons"
-
-    `abra` uses plain 'ol SSH under the hood and aims to make use of your existing SSH configurations in `~/.ssh/config` and interfaces with your running `ssh-agent` for password protected secret key files.
-
-    The `server add` command listed above assumes that that you make SSH connections on port 22 using your current username. If that is not he case, pass the new values as positional arguments. See `abra server add -h` for more on this.
-
-        abra server add <domain> <user> <port> -p
-
-    Running `server add` with `-d/--debug` should help you debug what is going on under the hood. It's best to take a moment to read [this troubleshooting entry](/abra/trouble/#ssh-connection-issues) if you're running into SSH connection issues with `abra`.
-
-The `-p` or `--provision` flag means that `abra` will install Docker and initialise the [new single-host swarm](https://docs.docker.com/engine/swarm/key-concepts/) on your server.
+The `-p` or `--provision` flag means that `abra` will install Docker and initialise the [new single-host swarm](https://docs.docker.com/engine/swarm/key-concepts/) on your server. If you've already followed the steps in [the server setup](/operators/tutorial/#server-setup) step, then `abra` should not need to do any work.

 It is important to note that `<domain>` here is a publicy accessible domain name which points to your server IP address. `abra` does make sure this is the case and this is done to avoid issues with HTTPS certificate rate limiting.

@@ -176,6 +180,16 @@ You will now have a new `~/.abra/` folder on your local file system which stores
 abra server ls
 ```

+!!! warning "Beware of SSH dragons"
+
+    `abra` uses plain 'ol SSH under the hood and aims to make use of your existing SSH configurations in `~/.ssh/config` and interfaces with your running `ssh-agent` for password protected secret key files.
+
+    The `server add` command listed above assumes that that you make SSH connections on port 22 using your current username. If that is not he case, pass the new values as positional arguments. See `abra server add -h` for more on this.
+
+        abra server add <domain> <user> <port> -p
+
+    Running `server add` with `-d/--debug` should help you debug what is going on under the hood. It's best to take a moment to read [this troubleshooting entry](/abra/trouble/#ssh-connection-issues) if you're running into SSH connection issues with `abra`.
+
 !!! question "How do I share my configs in `~/.abra`?"

    It's possible and quite easy, see [this handbook entry](/operators/handbook/#understanding-app-and-server-configuration) for more.
@@ -197,7 +211,7 @@ Choose your newly registered server and specify a domain name.
 You will want to take a look at your generated configuration and tweak the `LETS_ENCRYPT_EMAIL` value. You can do that by running `abra app config`:

 ```bash
-abra app config traefik
+abra app config <traefik-domain>
 ```

 Every app you deploy will have one of these `.env` files, which contains variables which will be injected into app configurations when deployed. Variables starting with `#` are optional, others are required.
@@ -238,6 +252,46 @@ abra app errors -w <nextcloud-domain> # error catcher

 Your new `traefik` instance will detect that a new app is coming up and generate SSL certificates for it. You can see what `traefik` is up to using the same commands above but replacing `<netcloud-domain>` with the `<traefik-domain>` you chose earlier (`abra app ls` will remind you what domains you chose :grinning:).

+### Upgrade Nextcloud
+
+To upgrade an app manually to the newest available version run:
+
+```bash
+abra app upgrade <nextcloud-domain>
+```
+
+### Automatic Upgrades
+
+`kadabra` the auto-updater is still under development, use it with care and don't use it in production environments.
+To setup the auto-updater copy the `kadabra` binary to the server and configure a cronjob for regular app upgrades.
+The following script will configure ssmtp for email notifications and setup a cronjob.
+This cronjob checks daily for new app versions, notifies if any kind of update is available and upgrades all apps to the latest patch/minor version.
+
+
+```bash
+apt install ssmtp
+
+cat > /etc/ssmtp/ssmtp.conf << EOF
+mailhub=$MAIL_SERVER:587
+hostname=$MAIL_DOMAIN
+AuthUser=$USER
+AuthPass=$PASSWORD
+FromLineOverride=yes
+UseSTARTTLS=yes
+EOF
+
+cat > /etc/cron.d/abra_updater << EOF
+MAILTO=admin@example.com
+MAILFROM=noreply@example.com
+
+0  6 * * *       root    ~/kadabra notify --major
+30 4 * * *       root    ~/kadabra upgrade --all
+EOF
+
+
+```
+
+
 ## Finishing up

 Hopefully you got something running! Well done! The [operators handbook](/operators/handbook) would probably be the next place to go check out if you're looking for more help. Especially on topics of ongoing maintenance.
@@ -4,7 +4,7 @@ title: Organising handbook

 ## Where do I find "the community"?

-The main place is the [Matrix community chat channels](/intro/contact/#matrix). You'll find a number of folks who are actively interested in the project and/or using `abra` and some of our recipes. Furthermore, Matrix has an excellent network of folks and in practice we've e-met a lot of groups who are interested in Co-op Cloud.
+The main place is the [Matrix community chat channels](/intro/contact/#matrix). You'll find a number of folks who are actively interested in the project and/or using `abra` and some of our recipes. Furthermore, Matrix has an excellent network of Cool People :tm: and in practice we've e-met a lot of groups who are interested in Co-op Cloud.

 ## Onboarding new project members

@@ -12,7 +12,7 @@ We still haven't worked this out. We're working on it.

 ## Gathering new case studies

-We try to gather as many "case studies" as possible, stories & concrete examples of Co-op Cloud being used For God :tm: See [coopcloud.tech](https://coopcloud.tech) for our existing examples. These studies help people identify what the purpose of the project is for.
+We try to gather as many "case studies" as possible, stories & concrete examples of Co-op Cloud being used For Good :tm: See [coopcloud.tech](https://coopcloud.tech) for our existing examples. These studies help people identify what the purpose of the project is for.

 ## Monthly updates

@@ -15,6 +15,65 @@ It aims to be a helpful place to understand the status of apps, who is taking ca

 The recipe catalogue is available on [recipes.coopcloud.tech](https://recipes.coopcloud.tech/).

+## Status / features / scoring
+
+Each recipe README has a "metadata" section, to help communicate the overall status of the recipe, and which features are supported. Here's an example, from [the Wordpress recipe](https://git.coopcloud.tech/coop-cloud/wordpress/):
+
+```
+<!-- metadata -->
+
+* **Category**: Apps
+* **Status**: 3, stable
+* **Image**: [`wordpress`](https://hub.docker.com/_/wordpress), 4, upstream
+* **Healthcheck**: Yes
+* **Backups**: Yes
+* **Email**: 3
+* **Tests**: 2
+* **SSO**: No
+
+<!-- endmetadata -->
+```
+
+Currently, recipe maintainers need to update the scores in this section manually. The specific meanings of the scores are:
+
+### Status (overall score)
+
+- 5: everything in 4 + Single-Sign-On
+- 4: upstream image, backups, email, healthcheck, integration testing
+- 3: upstream image, missing 1-2 items from 4
+- 2: missing 3-4 items from 4 or no upstream image
+- 1: alpha
+
+### Image
+
+- 4: official upstream image
+- 3: semi-official / actively-maintained image
+- 2: 3rd-party image
+- 1: our own custom image
+
+### Email
+
+- 3: automatic (using environment variables)
+- 2: mostly automatic
+- 1: manual
+- 0: none
+- N/A: app doesn't send email
+
+### CI
+
+- 3: as 2, plus healthcheck
+- 2: auto secrets + networks
+- 1: basic deployment using `stack-ssh-deploy`, manual secrets + networks
+- 0: none
+
+### Single-Sign-On
+
+- 3: automatic (using environment variables)
+- 2: mostly automatic
+- 1: manual
+- 0: none
+- N/A: app doesn't support SSO
+
 ## Wishlist

 If you'd like to see a new recipe packaged, make a request on the [recipes-wishlist](https://git.coopcloud.tech/coop-cloud/recipes-wishlist) repository issue tracker.
@@ -3,3 +3,38 @@
  --md-primary-fg-color--light: #202674;
  --md-primary-fg-color--dark: #ee4a33;
 }
+
+/* Navbar styling tweaks */
+
+.md-search__form {
+  background-color: rgba(0, 0, 255, 0.20);
+}
+
+.md-tabs {
+  background-color: #6A9CFF;
+}
+
+.md-tabs__item {
+  font-weight: 600;
+}
+
+/* Footer styling tweaks */
+
+.md-footer {
+  background-color: #485FC7;
+}
+
+.md-footer-meta {
+  background-color: rgba(0, 0, 0, 0.45);
+}
+
+/* Mobile sidebar styling tweaks */
+
+.md-nav__source {
+  background-color: #A7C5FF !important;
+}
+
+.md-nav--primary .md-nav__title {
+  background-color: #6A9CFF !important;
+  color: var(--md-primary-bg-color) !important;
+}
@@ -17,6 +17,7 @@ theme:
    accent: purple
  logo: img/favicon.ico
  favicon: img/favicon.ico
+  custom_dir: custom_theme/

 copyright: Copyleft 🄯 2022 Co-op Cloud

@@ -65,14 +66,32 @@ nav:
      - "Upgrade": abra/upgrade.md
      - "Hack": abra/hack.md
      - "Troubleshoot": abra/trouble.md
+      - "Cheat Sheet": abra/cheat-sheet.md
  - "Get Involved":
      - get-involved/index.md
+  - "Democracy":
+      - democracy/index.md
+      - "Decisions": democracy/decisions.md
  - "Glossary":
    - glossary/index.md

 plugins:
  - search
  - awesome-pages
+  - translations:
+      default_language: en
+      languages:
+        en: english
+        pl: polski
+
+extra:
+  alternate:
+    - name: English
+      link: /en/
+      lang: en
+    - name: Polish
+      link: /pl/
+      lang: pl

 repo_name: coop-cloud/docs.coopcloud.tech
 repo_url: https://git.coopcloud.tech/coop-cloud/docs.coopcloud.tech
@@ -1,3 +1,7 @@
 {
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json"
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "packageRules": [{
+    "matchUpdateTypes": ["minor", "patch"],
+    "automerge": true
+  }]
 }
@@ -1,4 +1,5 @@
-mkdocs-awesome-pages-plugin==2.6.1
-mkdocs-material-extensions==1.0.3
-mkdocs-material==8.1.10
-mkdocs==1.2.3
+mkdocs-awesome-pages-plugin==2.8.0
+mkdocs-material-extensions==1.1.1
+mkdocs-material==9.0.12
+mkdocs==1.4.2
+mkdocs-translations>=0.1.1
Author	SHA1	Message	Date
knoflook	e7126b93a0	can switch between languages now	2023-02-10 19:10:22 +01:00
decentral1se	4165d0493f	docs: wording	2023-02-10 14:49:05 +01:00
decentral1se	a5b6046b47	docs: link to binaries	2023-02-10 14:46:01 +01:00
decentral1se	d13ab90e99	docs: new rc2	2023-02-10 12:48:09 +01:00
renovate-bot	a00d148834	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.12	2023-02-10 08:04:43 +00:00
renovate-bot	0f4d71874b	chore(deps): update dependency mkdocs-material to v9.0.12	2023-02-10 08:04:14 +00:00
decentral1se	9bf47ac4a9	Merge branch 'new-abra-release'	2023-02-09 10:00:07 +01:00
decentral1se	5f95476725	docs: new release notes	2023-02-09 09:58:45 +01:00
decentral1se	0c211b3da9	docs: show how to use recipes without abra Closes coop-cloud/organising#400	2023-02-08 23:30:21 +01:00
moritz	212701adf2	docs: auto-updater	2023-02-08 21:21:48 +01:00
renovate-bot	62aea15ba1	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.11	2023-02-06 08:08:25 +00:00
renovate-bot	8912d94a83	chore(deps): update dependency mkdocs-material to v9.0.11	2023-02-06 08:07:34 +00:00
renovate-bot	3ede3b294b	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.10	2023-02-03 08:09:30 +00:00
renovate-bot	16a94ff6ee	chore(deps): update dependency mkdocs-material to v9.0.10	2023-02-03 08:07:57 +00:00
decentral1se	8b94dca7d6	docs: typo	2023-01-31 15:31:53 +01:00
renovate-bot	af3c82a13a	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.9	2023-01-31 08:04:15 +00:00
renovate-bot	1b31a89a86	chore(deps): update dependency mkdocs-material to v9.0.9	2023-01-31 08:03:51 +00:00
renovate-bot	c5692915b7	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.8	2023-01-30 08:04:38 +00:00
renovate-bot	ca8585b67e	chore(deps): update dependency mkdocs-material to v9.0.8	2023-01-30 08:04:05 +00:00
decentral1se	80235d177d	docs: wording	2023-01-22 10:09:18 +01:00
renovate-bot	f996f46fb2	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.6	2023-01-20 08:12:48 +00:00
renovate-bot	4c44d9b708	chore(deps): update dependency mkdocs-material to v9.0.6	2023-01-20 08:12:22 +00:00
decentral1se	af854f31e9	ci: automerge [ci skip]	2023-01-18 17:29:26 +01:00
3wordchant	41f46a9d45	Add preliminary docs for recipe metadata scores Closes #113	2023-01-17 16:00:05 -08:00
renovate-bot	b2f2ad2788	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.5	2023-01-16 18:01:59 +00:00
renovate-bot	9ec4116397	chore(deps): update dependency mkdocs-material to v9.0.5	2023-01-16 08:02:26 +00:00
3wordchant	1ba826c2d0	Add Docker install instructions to abra	2023-01-15 18:15:57 -08:00
renovate-bot	53162fd127	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.3	2023-01-09 22:33:29 +00:00
renovate-bot	588476a9e1	chore(deps): update dependency mkdocs-material to v9.0.3	2023-01-09 08:01:55 +00:00
3wordchant	5cddc8587b	Maintainers: tweak titles, formatting	2023-01-08 19:55:36 -08:00
3wordchant	9ea777de1b	Mgrating a server into a repository Closes coop-cloud/organising#323	2023-01-08 19:39:08 -08:00
3wordchant	f0fcef3d18	Minor tweaks to maintainers tutorial	2023-01-08 17:13:41 -08:00
mayel	765987d423	Update 'docs/operators/handbook.md'	2023-01-06 19:12:50 +00:00
renovate-bot	1fc89b1e08	chore(deps): update dependency mkdocs-material to v9.0.2	2023-01-05 16:43:19 +00:00
renovate-bot	f982361714	chore(deps): update squidfunk/mkdocs-material docker tag to v9.0.2	2023-01-05 08:03:18 +00:00
renovate-bot	7be06f179e	chore(deps): update dependency mkdocs-material to v9	2023-01-04 08:35:36 +00:00
renovate-bot	2beecbe62f	chore(deps): update squidfunk/mkdocs-material docker tag to v9	2023-01-04 08:02:39 +00:00
decentral1se	b6d92dc1b8	docs: migration guide	2022-12-13 16:34:16 +01:00
decentral1se	adc06f27ae	docs: new fork	2022-12-13 16:34:11 +01:00
renovate-bot	aabd16daec	chore(deps): update dependency mkdocs-material to v8.5.11	2022-12-01 14:51:44 +00:00
renovate-bot	f21effaa64	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.11	2022-12-01 08:02:20 +00:00
3wordchant	e630ebc035	Add manual DB backup instructions	2022-11-30 08:31:28 -08:00
3wordchant	18d1d6a108	Fix typo	2022-11-30 08:23:39 -08:00
renovate-bot	ad31f2ad88	chore(deps): update dependency mkdocs-material-extensions to v1.1.1	2022-11-22 08:01:02 +00:00
renovate-bot	b81c7daba9	chore(deps): update dependency mkdocs-material to v8.5.10	2022-11-14 16:05:29 +00:00
renovate-bot	93bf10f6b5	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.10	2022-11-14 08:01:06 +00:00
renovate-bot	8c69ca64eb	chore(deps): update dependency mkdocs-material to v8.5.9	2022-11-09 09:45:16 +00:00
renovate-bot	f1ad8ce2a7	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.9	2022-11-09 08:01:27 +00:00
renovate-bot	c1caedd4e5	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.8	2022-11-04 13:52:25 +00:00
renovate-bot	19bc39f0af	chore(deps): update dependency mkdocs-material to v8.5.8	2022-11-04 08:01:10 +00:00
renovate-bot	7c7a646853	chore(deps): update dependency mkdocs to v1.4.2	2022-11-02 08:00:59 +00:00
decentral1se	d537190719	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x'	2022-10-24 10:47:58 +02:00
decentral1se	bfcb81a8ce	Merge remote-tracking branch 'origin/renovate/main-mkdocs-material-extensions-1.x'	2022-10-24 10:47:52 +02:00
renovate-bot	8849397d80	chore(deps): update dependency mkdocs-material-extensions to v1.1	2022-10-24 07:01:20 +00:00
renovate-bot	59411e6116	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.7	2022-10-24 07:01:16 +00:00
renovate-bot	c13b471269	chore(deps): update dependency mkdocs-material to v8.5.7	2022-10-24 07:01:11 +00:00
decentral1se	7c0c240ad8	Merge remote-tracking branch 'origin/renovate/main-mkdocs-material-8.x'	2022-10-22 14:15:54 +02:00
renovate-bot	4459348a31	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.6	2022-10-22 12:14:43 +00:00
renovate-bot	a6bce41e0b	chore(deps): update dependency mkdocs to v1.4.1	2022-10-17 07:01:35 +00:00
renovate-bot	684f3f2b11	chore(deps): update dependency mkdocs-material to v8.5.6	2022-10-03 07:04:01 +00:00
renovate-bot	34a69e3a3b	chore(deps): update dependency mkdocs to v1.4.0	2022-09-28 07:01:45 +00:00
renovate-bot	e3b140ef8e	chore(deps): update dependency mkdocs-material to v8.5.3	2022-09-23 05:39:08 +00:00
renovate-bot	394ec2ed1c	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.3	2022-09-21 07:04:01 +00:00
renovate-bot	65ded1af34	chore(deps): update squidfunk/mkdocs-material docker tag to v8.5.2	2022-09-20 08:39:46 +00:00
renovate-bot	2951473633	chore(deps): update dependency mkdocs-material to v8.5.2	2022-09-19 07:01:41 +00:00
philippr	8790f95c53	fix: operators: tutorial traefik	2022-08-21 18:16:23 +02:00
renovate-bot	01ce8ef7d0	chore(deps): update dependency mkdocs-material to v8.4.0	2022-08-15 08:20:18 +00:00
renovate-bot	7af645da8d	chore(deps): update squidfunk/mkdocs-material docker tag to v8.4.0	2022-08-15 07:01:35 +00:00
Chris Thompson	b7ab0cb229	Correct some FAQ URLs	2022-08-12 23:15:13 -04:00
renovate-bot	bd246115de	chore(deps): update dependency mkdocs-awesome-pages-plugin to v2.8.0	2022-07-26 07:01:28 +00:00
renovate-bot	99bb9ed169	chore(deps): update dependency mkdocs to v1.3.1	2022-07-20 07:01:39 +00:00
decentral1se	0b4b84d892	add missing title	2022-07-18 16:12:31 +02:00
renovate-bot	f525f45fbe	chore(deps): update dependency mkdocs-material to v8.3.9	2022-07-14 09:51:09 +00:00
renovate-bot	07f2509e11	chore(deps): update squidfunk/mkdocs-material docker tag to v8.3.9	2022-07-05 07:01:55 +00:00
decentral1se	c8bbe8e1ab	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x'	2022-06-15 08:44:07 +01:00
renovate-bot	fd4d0cda42	chore(deps): update squidfunk/mkdocs-material docker tag to v8.3.5	2022-06-15 07:01:55 +00:00
renovate-bot	00320472be	chore(deps): update dependency mkdocs-material to v8.3.5	2022-06-15 07:01:42 +00:00
knoflook	47fb92a475	usermod needs to be ran as root	2022-06-10 18:12:27 +02:00
knoflook	02b2c417c6	Update 'docs/index.md' a bit pedantic but ok	2022-06-10 15:20:22 +00:00
decentral1se	c2d0833f71	use standard var, thanks @sicarii!	2022-06-07 11:40:15 +02:00
renovate-bot	5bf82c9793	chore(deps): update dependency mkdocs-material to v8.3.2	2022-06-06 14:18:15 +00:00
renovate-bot	1de2213807	chore(deps): update squidfunk/mkdocs-material docker tag to v8.3.2	2022-06-06 07:01:51 +00:00
decentral1se	549b3dfd83	Merge branch 'main' of ssh://git.coopcloud.tech:2222/coop-cloud/docs.coopcloud.tech into main	2022-06-04 15:06:27 +02:00
decentral1se	5357c9a77e	more managed hosting groups	2022-06-04 15:05:31 +02:00
decentral1se	a32b8897cc	alpha -> beta	2022-06-03 10:47:44 +00:00
renovate-bot	161c56430b	chore(deps): update squidfunk/mkdocs-material docker tag to v8.3.0	2022-06-03 07:27:29 +00:00
renovate-bot	9e6031da1c	chore(deps): update dependency mkdocs-material to v8.3.0	2022-06-03 07:01:33 +00:00
decentral1se	7ffe4f2f91	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x' into main	2022-05-30 09:03:39 +02:00
renovate-bot	009657896d	chore(deps): update squidfunk/mkdocs-material docker tag to v8.2.16	2022-05-30 07:01:47 +00:00
renovate-bot	36445fb3e1	chore(deps): update dependency mkdocs-material to v8.2.16	2022-05-30 07:01:37 +00:00
decentral1se	fc6b26398d	fix link	2022-05-18 14:33:21 +02:00
decentral1se	769a247645	vpn note	2022-05-17 14:00:05 +02:00
decentral1se	207c4efc4a	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x' into main	2022-05-16 16:23:31 +02:00
renovate-bot	a6ac799478	chore(deps): update squidfunk/mkdocs-material docker tag to v8.2.15	2022-05-16 07:01:55 +00:00
renovate-bot	f8ca5910b6	chore(deps): update dependency mkdocs-material to v8.2.15	2022-05-16 07:01:45 +00:00
decentral1se	62221f675e	Merge remote-tracking branch 'origin/renovate/main-mkdocs-material-8.x' into main	2022-05-09 14:03:07 +02:00
decentral1se	1529506d82	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x' into main	2022-05-09 14:02:54 +02:00
decentral1se	8376721289	typo	2022-05-09 12:40:33 +02:00
renovate-bot	657eb11960	chore(deps): update squidfunk/mkdocs-material docker tag to v8.2.14	2022-05-09 07:01:38 +00:00
renovate-bot	15c25ee958	chore(deps): update dependency mkdocs-material to v8.2.14	2022-05-09 07:01:34 +00:00
decentral1se	8438dc3250	new abra release guide, nothing major	2022-05-03 17:21:07 +02:00
decentral1se	10b5b6b0c1	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x' into main	2022-05-03 17:19:27 +02:00
renovate-bot	a90612a8bd	chore(deps): update squidfunk/mkdocs-material docker tag to v8.2.13	2022-05-02 07:01:38 +00:00
renovate-bot	5ce461356c	chore(deps): update dependency mkdocs-material to v8.2.13	2022-05-02 07:01:32 +00:00
renovate-bot	c033d222f6	chore(deps): update squidfunk/mkdocs-material docker tag to v8.2.11	2022-04-30 18:29:35 +02:00
renovate-bot	930909f165	chore(deps): update dependency mkdocs-material to v8.2.11	2022-04-30 18:29:35 +02:00
decentral1se	59e64a2f05	fix typo	2022-04-22 09:54:13 +02:00
decentral1se	d54fcdc9ca	recipe service overriding docs	2022-04-21 11:39:58 +02:00
knoflook	965243fd12	Merge branch 'main' of ssh://git.coopcloud.tech:2222/coop-cloud/docs.coopcloud.tech	2022-04-19 16:00:38 +02:00
knoflook	63b56940db	add cross-compiling docs	2022-04-19 16:00:28 +02:00
decentral1se	2411e2ef68	typo	2022-04-19 14:49:20 +02:00
decentral1se	809261ad25	more release notes	2022-04-19 14:46:45 +02:00
decentral1se	0d47001c9d	backup & restore docs	2022-04-19 13:41:21 +02:00
decentral1se	4ade5ac092	annnd how to get it done "for now"	2022-04-19 09:53:44 +02:00
decentral1se	011f31e1cc	show how to publish recipes	2022-04-19 09:53:03 +02:00
renovate-bot	c7fa8c7194	chore(deps): update squidfunk/mkdocs-material docker tag to v8.2.9	2022-04-18 08:42:09 +00:00
renovate-bot	ce8e8d0b78	chore(deps): update dependency mkdocs-material to v8.2.9	2022-04-18 08:41:44 +00:00
akshay	94fd2c388d	Fix URL to #coopcloud-tech:autonomic.zone	2022-04-17 22:17:32 +00:00
decentral1se	91dd6bee3b	fix it up, abra ain't there	2022-04-18 00:07:03 +02:00
decentral1se	3661dc45ca	add update	2022-04-17 23:59:32 +02:00
decentral1se	1fc302a44f	typo	2022-04-17 23:55:07 +02:00
decentral1se	26561b758b	ARM is doable	2022-04-17 23:52:41 +02:00
3wordchant	261a51707e	Fix typo Thanks @dantefromhell	2022-04-11 03:03:16 +02:00
3wordchant	7dbad92254	Fix link to architecture explanation Thanks @dantefromhell	2022-04-11 03:02:48 +02:00
3wordchant	311d29f711	Fix broken link Thanks @dantefromhell	2022-04-11 02:59:03 +02:00
decentral1se	e1d3a9edea	democracy placeholders	2022-04-06 11:22:51 +02:00
decentral1se	19e422047d	chore: GFDL this sucka [ci skip]	2022-04-05 12:24:02 +02:00
decentral1se	f522355927	shout out for the logos	2022-04-02 02:06:53 +02:00
decentral1se	2752abd5ee	nice logo & wording	2022-04-01 23:17:28 +02:00
knoflook	79ad16756e	add abra cheat sheet	2022-03-31 16:00:20 +02:00
kawaiipunk	d2d9b23784	Added handbook entry for running commands within a remote container	2022-03-30 16:41:54 +01:00
decentral1se	b5067bf7e9	more ssh user/port help	2022-03-30 11:46:45 +02:00
decentral1se	a5daab5ea2	Merge remote-tracking branch 'origin/renovate/main-mkdocs-material-8.x' into main	2022-03-28 12:41:14 +02:00
renovate-bot	9538f19837	Update squidfunk/mkdocs-material Docker tag to v8.2.8	2022-03-28 10:40:23 +00:00
renovate-bot	0a24424d32	Update dependency mkdocs to v1.3.0	2022-03-28 07:03:54 +00:00
renovate-bot	73c0d5b553	Update dependency mkdocs-material to v8.2.8	2022-03-28 07:03:42 +00:00
femmefaytale	46b7dcf941	nav bar list undo colours	2022-03-18 12:32:40 +00:00
femmefaytale	1b67b52784	change mobile navbar colours	2022-03-18 12:32:40 +00:00
femmefaytale	d6b80bf061	enable theme cutsom directory and re-arrange search & repo blocks	2022-03-18 12:32:40 +00:00
femmefaytale	4369e1eb66	change colours in extra.css	2022-03-18 12:32:40 +00:00
decentral1se	8f56c0f4a6	some refs to notes	2022-03-15 12:40:50 +01:00
decentral1se	4aa9baba9a	fix typo	2022-03-15 12:37:51 +01:00
decentral1se	73caa3b62e	add note about hacking	2022-03-15 10:57:22 +01:00
decentral1se	566656bec1	wording	2022-03-13 23:35:19 +01:00
decentral1se	0602fd1b32	wording	2022-03-13 23:30:46 +01:00
decentral1se	bbc450064b	dear dog typo	2022-03-13 23:30:40 +01:00
decentral1se	ddabeb53ef	update 0.4.x upgrade notes	2022-03-13 23:29:27 +01:00
decentral1se	21e5c9d0f2	explain further the CLI weirdness & shorten title	2022-03-12 16:46:43 +01:00
decentral1se	f8e63b2ab2	better wording	2022-03-11 12:28:32 +01:00
decentral1se	2270d69867	add clarification on provision	2022-03-11 09:56:33 +01:00
decentral1se	5706c8c3f5	fix link	2022-03-11 09:51:07 +01:00
decentral1se	de0ff5fa82	point to bootstrapping steps earlier on	2022-03-11 09:50:20 +01:00
decentral1se	9d494be5b5	explain further how to bootstrap	2022-03-11 09:47:38 +01:00
kawaiipunk	a4ba3133f8	Added some reference to abra bash in the troublshooting FAQ	2022-03-10 13:26:32 +00:00
decentral1se	6fca1eab47	missing word Follow up to coop-cloud/docs.coopcloud.tech#50	2022-03-10 09:17:01 +01:00
mayel	ff7e0740d9	fix wording	2022-03-10 01:17:11 +00:00
decentral1se	8503e55afc	wording	2022-03-09 12:36:40 +01:00
decentral1se	165dc5b9cb	document length hack	2022-03-09 12:34:06 +01:00
decentral1se	5312f4a81b	fix: document multiline limitation Closes coop-cloud/organising#291.	2022-03-08 15:13:28 +01:00
decentral1se	a03221872b	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x' into main	2022-03-08 15:12:16 +01:00
renovate-bot	887cfa36e3	Update squidfunk/mkdocs-material Docker tag to v8.2.5	2022-03-07 08:01:26 +00:00
renovate-bot	f32676c474	Update dependency mkdocs-material to v8.2.5	2022-03-07 08:01:17 +00:00
decentral1se	09a11853b9	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x' into main	2022-03-03 11:19:07 +01:00
renovate-bot	0256b514c9	Update squidfunk/mkdocs-material Docker tag to v8.2.4	2022-03-03 08:02:23 +00:00
renovate-bot	b43ec967a9	Update dependency mkdocs-material to v8.2.4	2022-03-03 08:02:13 +00:00
renovate-bot	7c56906273	Update dependency mkdocs-material to v8.2.1	2022-02-18 10:15:09 +00:00
renovate-bot	1040971177	Update squidfunk/mkdocs-material Docker tag to v8.2.1	2022-02-18 08:01:33 +00:00
decentral1se	ce860b9681	Merge remote-tracking branch 'origin/renovate/main-mkdocs-material-8.x' into main	2022-02-14 11:19:30 +01:00
decentral1se	5d526ee724	Merge remote-tracking branch 'origin/renovate/main-squidfunk-mkdocs-material-8.x' into main	2022-02-14 11:19:20 +01:00
renovate-bot	d096357f2c	Update dependency mkdocs-awesome-pages-plugin to v2.7.0	2022-02-14 08:01:27 +00:00
renovate-bot	a6c07289bb	Update squidfunk/mkdocs-material Docker tag to v8.1.11	2022-02-11 08:01:36 +00:00
renovate-bot	a7eb166556	Update dependency mkdocs-material to v8.1.11	2022-02-11 08:01:28 +00:00