commit f97fd12556cd28f6dfbdd92c9509cf0818e7acc1 Author: John Coffey Date: Tue Sep 22 17:56:20 2026 -0700 Survey the machine, and say what an install would do to it The first two pieces of the installer, and deliberately the two that change nothing: what this machine is, and what would happen to it. The survey is the floor under every later choice -- a component can only offer a container shape if Docker answers for this user, or a host shape on a systemd machine with what that shape needs. It reports what it could not establish as unknown rather than guessing: an unprivileged probe of port 25 means "I may not bind this", not "something is listening", and reporting the first as the second is a lie an operator would act on. The plan is one list, and it will have three readers: --dry-run prints it, the interface will show it before anything happens, and apply will walk it. What you are shown is what runs. Tested on a fresh Debian 13 in qemu, which has neither Docker nor Node and so exercises every unavailable shape: 23 checks, including that nothing was created by any of it. The lab that machine runs in is in e2e/vm. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..beb0037 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/inbuxa +/dist/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..880e2e4 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# inbuxa-installer + +One program that installs the **inbuxa** suite on the machine you run it on: +the mail server, the administration console and the webmail, each as a +container or on the host, in any mixture. + + inbuxa survey what this machine is, as the installer sees it + inbuxa install --dry-run … what would happen, before any of it does + inbuxa install … do it + +It only ever installs here. A second machine runs it too, and `inbuxa join` +points that machine at a server already running elsewhere. + +## What works today + +This is early. What is built: + +- **`survey`** -- the machine's facts: distribution, init, whether Docker is + usable *by this user*, Node's version, which of the suite's ports are free + and what holds the ones that are not, memory, disk, and whether an install + is already recorded here. It changes nothing. +- **`install --dry-run`** -- the whole plan: every file, unit, container, + port, DNS record and credential, and a refusal with a reason when the + machine cannot carry out what was asked. + +Not built yet: applying the plan, the terminal interface, `join`, `status`, +`upgrade`, `uninstall`. The design is in the inbuxa specification (§6.1 and +the installer draft); the phases are there too. + +## Building and testing + + go build ./cmd/inbuxa + +The installer writes units, creates users and takes ports 25 and 443, so it +is tested on a throwaway virtual machine rather than on anybody's desk: + + e2e/vm/up.sh a Debian 13 machine, in qemu, as you + e2e/vm/run.sh e2e/cases/survey.sh rewind it, then run a case inside + e2e/vm/down.sh remove it + +Each case starts from a copy of the machine taken when it was new, so a run +is free to break it and a failure is the installer's rather than the last +run's leftovers. `e2e/vm/up.sh` needs qemu, KVM and xorriso; nothing needs +root on your machine. + +## License + +AGPL-3.0-or-later. Some of this began as [ihasmail-oneshot], which is ours +and under the same license. + +[ihasmail-oneshot]: https://git.coffeylabs.org/inbuxa/ihasmail-oneshot diff --git a/cmd/inbuxa/main.go b/cmd/inbuxa/main.go new file mode 100644 index 0000000..1440500 --- /dev/null +++ b/cmd/inbuxa/main.go @@ -0,0 +1,218 @@ +// SPDX-FileCopyrightText: 2026 Coffey Labs +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Command inbuxa installs the inbuxa suite on the machine it is run on. +// +// Run with no arguments it opens the interface; run with flags it does the +// same work without asking. The flags are not a second implementation: the +// interface fills them in with the machine's own facts in front of you. +package main + +import ( + "context" + "flag" + "fmt" + "os" + "strings" + + "git.coffeylabs.org/inbuxa/inbuxa-installer/internal/host" + "git.coffeylabs.org/inbuxa/inbuxa-installer/internal/plan" +) + +// version is stamped by the release build; a build from a working tree says +// so rather than claiming a release it is not. +var version = "dev" + +const usage = `inbuxa -- install the inbuxa suite on this machine + + inbuxa install [flags] install or converge (no flags: the interface) + inbuxa survey what this machine is, as the installer sees it + inbuxa version this program's version + +install flags: + --domain NAME the mail domain (required unless --local) + --mail-host NAME default: mail.DOMAIN + --console-host NAME default: admin.DOMAIN + --webmail-host NAME default: webmail.DOMAIN + --email ADDRESS ACME contact; default: postmaster@DOMAIN + --server SHAPE skip | container | host (default: container) + --console SHAPE skip | container | host (default: container) + --webmail SHAPE skip | container | host (default: container) + --proxy WHICH caddy | snippets | none (default: caddy) + --dir PATH where the installation lives; default: /var/lib/inbuxa + --local loopback evaluation: no public ports, no certificates + --dry-run print the plan and stop + --yes do not ask for confirmation +` + +func main() { + if len(os.Args) < 2 { + // The interface is the no-argument case. Until it lands, say so + // plainly rather than pretending: a half-built screen is worse than + // a sentence telling you which flags to use. + fmt.Fprint(os.Stderr, "the interface is not built yet -- run `inbuxa install --help` for the flags\n") + os.Exit(2) + } + switch os.Args[1] { + case "install": + os.Exit(install(os.Args[2:])) + case "survey": + os.Exit(survey()) + case "version": + fmt.Println(version) + case "-h", "--help", "help": + fmt.Print(usage) + default: + fmt.Fprintf(os.Stderr, "unknown command %q\n\n%s", os.Args[1], usage) + os.Exit(2) + } +} + +func survey() int { + f := host.Survey(context.Background()) + fmt.Print(render(f)) + return 0 +} + +func install(args []string) int { + fs := flag.NewFlagSet("install", flag.ContinueOnError) + fs.Usage = func() { fmt.Print(usage) } + var ( + o plan.Options + server = fs.String("server", "container", "") + console = fs.String("console", "container", "") + webmail = fs.String("webmail", "container", "") + dryRun = fs.Bool("dry-run", false, "") + yes = fs.Bool("yes", false, "") + ) + fs.StringVar(&o.Domain, "domain", "", "") + fs.StringVar(&o.MailHost, "mail-host", "", "") + fs.StringVar(&o.ConsoleHost, "console-host", "", "") + fs.StringVar(&o.WebmailHost, "webmail-host", "", "") + fs.StringVar(&o.ACMEEmail, "email", "", "") + fs.StringVar(&o.Proxy, "proxy", "", "") + fs.StringVar(&o.Dir, "dir", "", "") + fs.BoolVar(&o.Local, "local", false, "") + if err := fs.Parse(args); err != nil { + return 2 + } + for _, c := range []struct { + comp plan.Component + val string + }{{plan.Server, *server}, {plan.Console, *console}, {plan.Webmail, *webmail}} { + s, err := shape(c.val) + if err != nil { + fmt.Fprintf(os.Stderr, "--%s: %v\n", c.comp, err) + return 2 + } + o.Choices = append(o.Choices, plan.Choice{Component: c.comp, Shape: s}) + } + + f := host.Survey(context.Background()) + p, err := plan.Build(f, o) + if err != nil { + fmt.Fprintln(os.Stderr, "cannot install as asked: "+err.Error()) + fmt.Fprint(os.Stderr, "\n"+render(f)) + return 1 + } + fmt.Print(p.String()) + if *dryRun { + return 0 + } + if !*yes { + fmt.Fprintln(os.Stderr, "\nnothing has happened yet: applying is not built in this build (pass --dry-run to silence this)") + return 1 + } + fmt.Fprintln(os.Stderr, "\napply is not built yet") + return 1 +} + +func shape(s string) (plan.Shape, error) { + switch strings.ToLower(s) { + case "skip", "no", "none": + return plan.Skip, nil + case "container", "docker": + return plan.Container, nil + case "host", "bare", "baremetal", "bare-metal": + return plan.Host, nil + } + return "", fmt.Errorf("%q is not a shape: skip, container or host", s) +} + +// render is the first screen, as text: what this machine is, and what that +// allows. Every line is something a later choice depends on. +func render(f host.Facts) string { + var b strings.Builder + b.WriteString("This machine\n") + os_ := f.OS.Pretty + if os_ == "" { + os_ = "an unrecognized Linux" + } + fmt.Fprintf(&b, " %-22s %s\n", "system", os_) + fmt.Fprintf(&b, " %-22s %s\n", "init", yes(f.Systemd, "systemd", "not systemd -- host installs are unavailable")) + fmt.Fprintf(&b, " %-22s %s\n", "running as", yes(f.Root, "root", "an ordinary user -- installing will fail")) + if f.MemoryMB > 0 { + fmt.Fprintf(&b, " %-22s %d MB\n", "memory", f.MemoryMB) + } + if f.DiskFreeGB > 0 { + fmt.Fprintf(&b, " %-22s %d GB free\n", "disk", f.DiskFreeGB) + } + + docker := "not installed" + switch { + case f.Docker.Usable: + docker = "usable, server " + f.Docker.Version + ", compose " + f.Docker.Compose + case f.Docker.Present: + docker = "installed but not usable: " + f.Docker.Why + } + fmt.Fprintf(&b, " %-22s %s\n", "docker", docker) + + node := "not installed" + switch { + case f.Node.Present && f.Node.Major >= 22: + node = f.Node.Version + case f.Node.Present: + node = f.Node.Version + " (too old for a host install of the webmail)" + } + fmt.Fprintf(&b, " %-22s %s\n", "node", node) + if f.Existing != "" { + fmt.Fprintf(&b, " %-22s %s\n", "existing install", f.Existing) + } + + b.WriteString("\nPorts\n") + for _, p := range f.Ports { + state := "free" + switch { + case p.Free: + case p.Unknown: + state = "cannot tell without root" + default: + state = "held" + if p.Holder != "" { + state += " by " + p.Holder + } + } + fmt.Fprintf(&b, " %-6d %-42s %s\n", p.Number, p.For, state) + } + + b.WriteString("\nWhat this machine allows\n") + for _, c := range []plan.Component{plan.Server, plan.Console, plan.Webmail} { + var shapes []string + for _, s := range []plan.Shape{plan.Container, plan.Host} { + if a := plan.Available(f, c, s); a.OK { + shapes = append(shapes, string(s)) + } else { + shapes = append(shapes, fmt.Sprintf("%s (no: %s)", s, a.Why)) + } + } + fmt.Fprintf(&b, " %-10s %s\n", c, strings.Join(shapes, " ")) + } + return b.String() +} + +func yes(b bool, t, f string) string { + if b { + return t + } + return f +} diff --git a/e2e/cases/survey.sh b/e2e/cases/survey.sh new file mode 100644 index 0000000..00db41b --- /dev/null +++ b/e2e/cases/survey.sh @@ -0,0 +1,66 @@ +#!/bin/bash +# SPDX-FileCopyrightText: 2026 Coffey Labs +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# The first case: on a machine with nothing installed on it, does the +# installer describe that machine correctly, and does it refuse the shapes +# that machine cannot do -- with a reason someone could act on? +# +# A fresh Debian cloud image has no docker and no node, which is exactly the +# interesting case: every container shape and the webmail's host shape are +# unavailable, and the server's host shape is not. Getting this wrong in +# either direction is the difference between an installer that reads a +# machine and one that guesses. +# +# Run from the host with: e2e/vm/run.sh e2e/cases/survey.sh +set -uo pipefail + +pass=0; fail=0 +ok() { echo " ok $*"; pass=$((pass+1)); } +bad() { echo " FAIL $*"; fail=$((fail+1)); } +has() { grep -q -- "$2" <<<"$1" && ok "$3" || { bad "$3"; echo "----"; echo "$1" | sed 's/^/ /'; echo "----"; }; } +hasnt() { grep -q -- "$2" <<<"$1" && { bad "$3"; } || ok "$3"; } + +echo "==> survey, on a machine with nothing on it" +S="$(/tmp/inbuxa survey)" +echo "$S" | sed 's/^/ /' + +has "$S" "Debian GNU/Linux 13" "names the distribution" +has "$S" "init systemd" "sees systemd" +has "$S" "running as root" "knows it is root" +has "$S" "docker not installed" "sees no docker" +has "$S" "node not installed" "sees no node" +has "$S" "25 SMTP" "lists the mail ports" +hasnt "$S" "cannot tell without root" "as root, every port is a real answer" +has "$S" "container (no: docker is not installed)" "containers unavailable, with the reason" +has "$S" "server container (no" "the server cannot be a container here" +has "$S" "webmail container (no: docker is not installed) host (no: a host install of the webmail needs Node 22" "the webmail can be neither shape here" + +echo +echo "==> a plan that this machine cannot carry out" +OUT="$(/tmp/inbuxa install --domain example.test 2>&1)"; rc=$? +[ $rc -ne 0 ] && ok "refuses (exit $rc)" || bad "should have refused" +has "$OUT" "cannot install as asked" "says so plainly" +has "$OUT" "docker is not installed" "and why" + +echo +echo "==> a plan it can: the server on the host, front ends elsewhere" +OUT="$(/tmp/inbuxa install --domain example.test --server host --console skip --webmail skip --dry-run 2>&1)"; rc=$? +echo "$OUT" | sed 's/^/ /' +[ $rc -eq 0 ] && ok "accepted (exit 0)" || bad "should have been accepted, exit $rc" +has "$OUT" "/etc/systemd/system/inbuxa-server.service" "names the unit it would write" +has "$OUT" "user: inbuxa" "names the user it would create" +has "$OUT" "Ports it will bind: 25, 465, 993, 995, 4190, 80, 443" "lists every port" +has "$OUT" "MX 10 mail.example.test." "writes the MX the domain needs" +has "$OUT" "_dmarc.example.test." "and DMARC" +hasnt "$OUT" "admin.example.test" "says nothing about front ends it was told to skip" + +echo +echo "==> nothing was installed by any of that" +[ ! -e /etc/systemd/system/inbuxa-server.service ] && ok "no unit written" || bad "a unit appeared" +[ ! -e /var/lib/inbuxa ] && ok "no deployment directory" || bad "a directory appeared" +id inbuxa >/dev/null 2>&1 && bad "a user appeared" || ok "no user created" + +echo +echo "==> $pass passed, $fail failed" +[ "$fail" -eq 0 ] diff --git a/e2e/vm/down.sh b/e2e/vm/down.sh new file mode 100755 index 0000000..81d46f1 --- /dev/null +++ b/e2e/vm/down.sh @@ -0,0 +1,17 @@ +#!/bin/bash +# SPDX-FileCopyrightText: 2026 Coffey Labs +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# Stop the lab machine and remove its disks. The base image stays, so up.sh +# is quick the next time; --all takes that too. +set -euo pipefail +LAB="${LAB:-$HOME/.cache/inbuxa-lab}" +SSH_PORT="${SSH_PORT:-2222}" +DISK="$LAB/lab.qcow2"; CLEAN="$LAB/lab-clean.qcow2"; SEED="$LAB/seed.iso" +LOG="$LAB/console.log"; PIDFILE="$LAB/qemu.pid" +. "$(dirname "$0")/lib.sh" + +vm_stop +rm -f "$DISK" "$CLEAN" "$SEED" "$PIDFILE" "$LAB/monitor.sock" +[ "${1:-}" = "--all" ] && rm -rf "$LAB" +echo "==> gone" diff --git a/e2e/vm/lib.sh b/e2e/vm/lib.sh new file mode 100644 index 0000000..0d8ea86 --- /dev/null +++ b/e2e/vm/lib.sh @@ -0,0 +1,56 @@ +# SPDX-FileCopyrightText: 2026 Coffey Labs +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# Shared by the four scripts beside it: how the lab machine is started, +# stopped and talked to. Sourced, never run. +# +# One machine at a time, identified by its pid file. qemu is given a monitor +# on a unix socket so a stop is a clean powerdown rather than pulling the +# plug on a filesystem we are about to copy. +# +# Keep the default VGA device. `-vga none` looks right for a headless machine +# and is not: this image's GRUB hands over to a kernel that never prints, and +# the machine resets in a loop at "Booting Debian GNU/Linux" forever. -display +# none is what makes it headless; the adapter has to be there. + +vm_running() { + [ -f "$PIDFILE" ] && kill -0 "$(cat "$PIDFILE")" 2>/dev/null +} + +vm_start() { + qemu-system-x86_64 \ + -enable-kvm -cpu host -m "$MEM" -smp "$VCPUS" \ + -drive "file=$DISK,if=virtio,format=qcow2" \ + -drive "file=$SEED,if=virtio,format=raw,readonly=on" \ + -netdev "user,id=n0,hostfwd=tcp:127.0.0.1:$SSH_PORT-:22" \ + -device virtio-net-pci,netdev=n0 \ + -display none -serial "file:$LOG" \ + -monitor "unix:$LAB/monitor.sock,server,nowait" \ + -pidfile "$PIDFILE" \ + -daemonize +} + +vm_stop() { + vm_running || return 0 + printf 'system_powerdown\n' | timeout 5 socat - "unix-connect:$LAB/monitor.sock" >/dev/null 2>&1 \ + || printf 'system_powerdown\n' | timeout 5 nc -U "$LAB/monitor.sock" >/dev/null 2>&1 \ + || true + for _ in $(seq 1 30); do + vm_running || return 0 + sleep 1 + done + # It had its chance. + kill "$(cat "$PIDFILE")" 2>/dev/null || true + sleep 1 +} + +vm_ssh() { + ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null \ + -o ConnectTimeout=3 -o BatchMode=yes -o LogLevel=ERROR \ + -p "$SSH_PORT" lab@127.0.0.1 "$@" +} + +vm_scp() { + scp -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null \ + -o LogLevel=ERROR -P "$SSH_PORT" "$@" +} diff --git a/e2e/vm/reset.sh b/e2e/vm/reset.sh new file mode 100755 index 0000000..4f20c49 --- /dev/null +++ b/e2e/vm/reset.sh @@ -0,0 +1,23 @@ +#!/bin/bash +# SPDX-FileCopyrightText: 2026 Coffey Labs +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# Rewind the lab machine to the copy up.sh kept. A few seconds, and the +# machine is as fresh as a new VPS -- which is what makes a test run free to +# create users, write units and take ports. +set -euo pipefail +LAB="${LAB:-$HOME/.cache/inbuxa-lab}" +MEM="${MEM:-4096}"; VCPUS="${VCPUS:-2}"; SSH_PORT="${SSH_PORT:-2222}" +DISK="$LAB/lab.qcow2"; CLEAN="$LAB/lab-clean.qcow2"; SEED="$LAB/seed.iso" +LOG="$LAB/console.log"; PIDFILE="$LAB/qemu.pid" +. "$(dirname "$0")/lib.sh" + +[ -f "$CLEAN" ] || { echo "no clean copy -- run e2e/vm/up.sh first" >&2; exit 1; } + +vm_stop +cp --reflink=auto "$CLEAN" "$DISK" +: > "$LOG" +vm_start +for _ in $(seq 1 90); do vm_ssh true 2>/dev/null && break; sleep 2; done +vm_ssh true 2>/dev/null || { echo "no ssh after the rewind; see $LOG" >&2; exit 1; } +echo "==> clean: ssh lab@127.0.0.1 -p $SSH_PORT" diff --git a/e2e/vm/run.sh b/e2e/vm/run.sh new file mode 100755 index 0000000..664c122 --- /dev/null +++ b/e2e/vm/run.sh @@ -0,0 +1,34 @@ +#!/bin/bash +# SPDX-FileCopyrightText: 2026 Coffey Labs +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# Build the installer, copy it into the lab machine, and run a case there. +# +# e2e/vm/run.sh e2e/cases/containers.sh rewind, then run that case +# KEEP=1 e2e/vm/run.sh e2e/cases/hosts.sh run it on the machine as it is +# +# The rewind is the point: every case starts on an identical machine, so a +# failure is the installer's and not the last run's leftovers. +set -euo pipefail +CASE="${1:?usage: run.sh e2e/cases/.sh}" +ROOT="$(cd "$(dirname "$0")/../.." && pwd)" +LAB="${LAB:-$HOME/.cache/inbuxa-lab}" +MEM="${MEM:-4096}"; VCPUS="${VCPUS:-2}"; SSH_PORT="${SSH_PORT:-2222}" +DISK="$LAB/lab.qcow2"; CLEAN="$LAB/lab-clean.qcow2"; SEED="$LAB/seed.iso" +LOG="$LAB/console.log"; PIDFILE="$LAB/qemu.pid" +. "$(dirname "$0")/lib.sh" + +[ -f "$ROOT/$CASE" ] || { echo "no such case: $CASE" >&2; exit 1; } +[ "${KEEP:-}" = 1 ] || "$(dirname "$0")/reset.sh" +vm_running || { echo "the lab is not up -- run e2e/vm/up.sh" >&2; exit 1; } + +echo "==> building the installer" +(cd "$ROOT" && GOOS=linux GOARCH=amd64 go build -o "$LAB/inbuxa" ./cmd/inbuxa) + +echo "==> copying it in" +vm_scp "$LAB/inbuxa" lab@127.0.0.1:/tmp/inbuxa >/dev/null +vm_scp "$ROOT/$CASE" lab@127.0.0.1:/tmp/case.sh >/dev/null +vm_ssh 'chmod +x /tmp/inbuxa /tmp/case.sh' + +echo "==> running $(basename "$CASE")" +vm_ssh 'sudo -E bash /tmp/case.sh' diff --git a/e2e/vm/up.sh b/e2e/vm/up.sh new file mode 100755 index 0000000..38a3756 --- /dev/null +++ b/e2e/vm/up.sh @@ -0,0 +1,127 @@ +#!/bin/bash +# SPDX-FileCopyrightText: 2026 Coffey Labs +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# Build the throwaway machine the installer is tested on. +# +# The installer writes units, creates users, takes 25 and 443 and can install +# a web server. None of that belongs on a workstation, and none of it can be +# proved in a container either -- systemd, users and ports are the thing under +# test. So: a Debian cloud image in qemu, seeded with cloud-init, with a copy +# of the disk kept the moment it is up. Every run starts from that copy, so a +# run can break the machine as thoroughly as it likes. +# +# e2e/vm/up.sh build it and keep a clean copy (idempotent) +# e2e/vm/reset.sh back to the clean copy, a few seconds +# e2e/vm/run.sh build the installer, copy it in, run a case inside +# e2e/vm/down.sh stop it and remove its disks +# +# Plain qemu, run as you, rather than libvirt: no root, no storage pool, no +# permissions to argue with, and the logs are readable. Networking is qemu's +# user-mode NAT with ssh forwarded to 127.0.0.1:2222, which gives the guest +# the internet it needs to pull images without putting it on the LAN. +# +# Needs: qemu-system-x86_64, /dev/kvm, xorriso, ssh, curl. +set -euo pipefail + +LAB="${LAB:-$HOME/.cache/inbuxa-lab}" +MEM="${MEM:-4096}" +VCPUS="${VCPUS:-2}" +DISK_GB="${DISK_GB:-20}" +SSH_PORT="${SSH_PORT:-2222}" +BASE_URL="https://cloud.debian.org/images/cloud/trixie/latest/debian-13-genericcloud-amd64.qcow2" +BASE="$LAB/debian-13-base.qcow2" +DISK="$LAB/lab.qcow2" +CLEAN="$LAB/lab-clean.qcow2" +SEED="$LAB/seed.iso" +LOG="$LAB/console.log" +PIDFILE="$LAB/qemu.pid" +KEY="${KEY:-$HOME/.ssh/id_ed25519.pub}" + +say() { echo "==> $*"; } +. "$(dirname "$0")/lib.sh" + +[ -r "$KEY" ] || { echo "no public key at $KEY (set KEY=)" >&2; exit 1; } +[ -w /dev/kvm ] || { echo "no writable /dev/kvm -- is this user in the kvm group?" >&2; exit 1; } + +if vm_running; then + say "already up on 127.0.0.1:$SSH_PORT -- reset.sh rewinds it, down.sh removes it" + exit 0 +fi + +mkdir -p "$LAB" +if [ ! -f "$BASE" ]; then + say "fetching the base image (once)" + curl -fL --progress-bar -o "$BASE.part" "$BASE_URL" + mv "$BASE.part" "$BASE" +fi + +# cloud-init: one unprivileged user with our key and passwordless sudo, and +# almost nothing else. The installer is what is under test, so the machine +# should be as plain as a new VPS -- if the installer needs a package, the +# installer should say so rather than the lab quietly providing it. +WORK="$(mktemp -d)" +trap 'rm -rf "$WORK"' EXIT + +cat > "$WORK/meta-data" < "$WORK/user-data" </dev/null; then break; fi + sleep 2 +done +vm_ssh true 2>/dev/null || { echo "no ssh after three minutes; see $LOG" >&2; exit 1; } + +say "waiting for cloud-init to finish" +vm_ssh 'sudo cloud-init status --wait >/dev/null 2>&1 || true' + +say "keeping a clean copy of the disk" +vm_stop +cp --reflink=auto "$DISK" "$CLEAN" +vm_start +for _ in $(seq 1 90); do + if vm_ssh true 2>/dev/null; then break; fi + sleep 2 +done + +say "up: ssh lab@127.0.0.1 -p $SSH_PORT (console log: $LOG)" +vm_ssh 'echo " guest:" $(. /etc/os-release && echo $PRETTY_NAME) "| kernel" $(uname -r) "| disk" $(df -h / | awk "NR==2{print \$2}")' diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..f4acd44 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module git.coffeylabs.org/inbuxa/inbuxa-installer + +go 1.26.8 diff --git a/internal/host/host.go b/internal/host/host.go new file mode 100644 index 0000000..590e37c --- /dev/null +++ b/internal/host/host.go @@ -0,0 +1,375 @@ +// SPDX-FileCopyrightText: 2026 Coffey Labs +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Package host looks at the machine the installer is running on and reports +// what it found. Nothing here changes anything. +// +// This is the first screen of the interface and the floor under every choice +// after it: a component can only offer "container" if there is a usable +// Docker, or "host" if this is a systemd machine with the pieces that shape +// needs. The survey is taken once, so the plan and the interface are arguing +// from the same facts. +package host + +import ( + "bufio" + "context" + "errors" + "fmt" + "net" + "os" + "os/exec" + "os/user" + "path/filepath" + "regexp" + "strconv" + "strings" + "syscall" + "time" +) + +// Facts is everything the installer knows about this machine before it asks +// anybody anything. +type Facts struct { + OS OSInfo + Root bool // running as uid 0 + Systemd bool // systemd is pid 1 + Docker Docker // + Node Node // + Ports []Port // the ports the suite wants, and who holds them + DiskFreeGB int // on the filesystem that would hold the install + MemoryMB int + Existing string // path of a previous install's state file, or "" +} + +// OSInfo is the distribution, as os-release describes it. +type OSInfo struct { + ID string // "debian", "ubuntu", "fedora"… + VersionID string // "13", "24.04" + Pretty string + Family string // "debian", "rhel", "arch", "suse", "" when unknown +} + +// Docker is whether containers are a real option for this user. +type Docker struct { + Present bool + Usable bool // the daemon answers *as this user*, which is the part that matters + Version string // + Compose string // "v2" when `docker compose` works, "" otherwise + Why string // why it is unusable, in a sentence fit to show someone +} + +// Node is what a host install of the webmail would run on. +type Node struct { + Present bool + Version string // "22.14.0" + Major int + Why string +} + +// Port is one of the ports the suite would like, and what holds it now. +type Port struct { + Number int + For string // what wants it + Free bool + Unknown bool // could not be tested: binding it needs privileges we lack + Holder string // best guess at the process, when we can see one +} + +// wanted is every port the suite can ask for, with what asks. The survey +// reports all of them regardless of the shape chosen, because the interface +// needs to gray out a choice before the operator makes it. +var wanted = []struct { + n int + for_ string +}{ + {25, "SMTP, mail from other servers"}, + {80, "HTTP, for certificates and the redirect"}, + {443, "HTTPS, the front ends and JMAP"}, + {465, "submissions, mail apps sending"}, + {993, "IMAPS, mail apps reading"}, + {995, "POP3S, mail apps collecting"}, + {4190, "ManageSieve, filters from mail apps"}, + {8080, "the webmail, behind the proxy"}, + {8081, "the server's plain HTTP, behind the proxy"}, +} + +// Survey takes the whole survey. It never fails: a fact it cannot establish +// is reported as absent with a reason, because "we could not tell" is itself +// something the operator should see. +func Survey(ctx context.Context) Facts { + f := Facts{ + OS: readOSRelease("/etc/os-release"), + Systemd: isSystemd(), + Docker: surveyDocker(ctx), + Node: surveyNode(ctx), + MemoryMB: memoryMB(), + } + if u, err := user.Current(); err == nil { + f.Root = u.Uid == "0" + } + for _, w := range wanted { + f.Ports = append(f.Ports, surveyPort(w.n, w.for_)) + } + f.DiskFreeGB = diskFreeGB("/var/lib") + for _, p := range []string{"/etc/inbuxa/install.json"} { + if _, err := os.Stat(p); err == nil { + f.Existing = p + } + } + return f +} + +func readOSRelease(path string) OSInfo { + var o OSInfo + file, err := os.Open(path) + if err != nil { + return o + } + defer file.Close() + fields := map[string]string{} + s := bufio.NewScanner(file) + for s.Scan() { + line := strings.TrimSpace(s.Text()) + k, v, ok := strings.Cut(line, "=") + if !ok { + continue + } + fields[k] = strings.Trim(v, `"'`) + } + o.ID = fields["ID"] + o.VersionID = fields["VERSION_ID"] + o.Pretty = fields["PRETTY_NAME"] + like := fields["ID_LIKE"] + " " + o.ID + switch { + case strings.Contains(like, "debian"), strings.Contains(like, "ubuntu"): + o.Family = "debian" + case strings.Contains(like, "rhel"), strings.Contains(like, "fedora"), strings.Contains(like, "centos"): + o.Family = "rhel" + case strings.Contains(like, "arch"): + o.Family = "arch" + case strings.Contains(like, "suse"): + o.Family = "suse" + } + return o +} + +func isSystemd() bool { + // /run/systemd/system exists exactly when systemd is running the machine, + // which is what systemd's own documentation says to test. + st, err := os.Stat("/run/systemd/system") + return err == nil && st.IsDir() +} + +func surveyDocker(ctx context.Context) Docker { + var d Docker + bin, err := exec.LookPath("docker") + if err != nil { + d.Why = "docker is not installed" + return d + } + d.Present = true + + ctx, cancel := context.WithTimeout(ctx, 10*time.Second) + defer cancel() + + // `docker version` talks to the daemon, unlike `docker --version`, so it + // answers the question that matters: can *this user* run containers? + out, err := exec.CommandContext(ctx, bin, "version", "--format", "{{.Server.Version}}").CombinedOutput() + if err != nil { + d.Why = firstLine(string(out)) + if d.Why == "" { + d.Why = "the docker daemon did not answer" + } + return d + } + d.Usable = true + d.Version = strings.TrimSpace(string(out)) + + if err := exec.CommandContext(ctx, bin, "compose", "version").Run(); err == nil { + d.Compose = "v2" + } else { + d.Usable = false + d.Why = "docker compose (v2) is not available" + } + return d +} + +var nodeVersion = regexp.MustCompile(`^v(\d+)\.(\d+)\.(\d+)`) + +func surveyNode(ctx context.Context) Node { + var n Node + bin, err := exec.LookPath("node") + if err != nil { + n.Why = "node is not installed" + return n + } + n.Present = true + ctx, cancel := context.WithTimeout(ctx, 5*time.Second) + defer cancel() + out, err := exec.CommandContext(ctx, bin, "--version").Output() + if err != nil { + n.Why = "node is installed but would not run" + return n + } + m := nodeVersion.FindStringSubmatch(strings.TrimSpace(string(out))) + if m == nil { + n.Why = "node's version could not be read" + return n + } + n.Version = strings.TrimPrefix(strings.TrimSpace(string(out)), "v") + n.Major, _ = strconv.Atoi(m[1]) + return n +} + +// surveyPort reports whether a port is free, and who has it when it is not. +// Binding is the only honest test -- something listening on 0.0.0.0 and +// something listening on one address are different answers, and /proc tells +// us the second only after the first has failed. +func surveyPort(n int, for_ string) Port { + p := Port{Number: n, For: for_} + l, err := net.Listen("tcp", fmt.Sprintf(":%d", n)) + if err == nil { + l.Close() + p.Free = true + return p + } + // "I am not allowed to bind this" is not "something is listening here". + // Reporting the first as the second told an unprivileged run that every + // port below 1024 was taken, which is a lie an operator would act on. + if errors.Is(err, syscall.EACCES) || errors.Is(err, syscall.EPERM) { + p.Unknown = true + if h := holderOf(n); h != "" { + p.Holder = h + p.Unknown = false + } + return p + } + p.Holder = holderOf(n) + return p +} + +// holderOf is a best effort at naming the process on a port, for the sake of +// a message like "443 is held by nginx" instead of "443 is busy". It reads +// /proc, which means it only sees the whole truth as root; a guess is better +// than nothing and the caller treats it as one. +func holderOf(port int) string { + inodes := map[string]bool{} + for _, tab := range []string{"/proc/net/tcp", "/proc/net/tcp6"} { + file, err := os.Open(tab) + if err != nil { + continue + } + s := bufio.NewScanner(file) + s.Scan() // header + for s.Scan() { + fields := strings.Fields(s.Text()) + if len(fields) < 10 { + continue + } + _, portHex, ok := strings.Cut(fields[1], ":") + if !ok { + continue + } + n, err := strconv.ParseInt(portHex, 16, 32) + if err != nil || int(n) != port { + continue + } + if fields[3] != "0A" { // 0A = LISTEN + continue + } + inodes[fields[9]] = true + } + file.Close() + } + if len(inodes) == 0 { + return "" + } + procs, err := filepath.Glob("/proc/[0-9]*/fd/*") + if err != nil { + return "" + } + for _, fd := range procs { + link, err := os.Readlink(fd) + if err != nil || !strings.HasPrefix(link, "socket:[") { + continue + } + inode := strings.TrimSuffix(strings.TrimPrefix(link, "socket:["), "]") + if !inodes[inode] { + continue + } + pid := strings.Split(fd, "/")[2] + if comm, err := os.ReadFile("/proc/" + pid + "/comm"); err == nil { + return strings.TrimSpace(string(comm)) + " (pid " + pid + ")" + } + } + return "" +} + +func memoryMB() int { + file, err := os.Open("/proc/meminfo") + if err != nil { + return 0 + } + defer file.Close() + s := bufio.NewScanner(file) + for s.Scan() { + if !strings.HasPrefix(s.Text(), "MemTotal:") { + continue + } + fields := strings.Fields(s.Text()) + if len(fields) < 2 { + return 0 + } + kb, _ := strconv.Atoi(fields[1]) + return kb / 1024 + } + return 0 +} + +func diskFreeGB(path string) int { + out, err := exec.Command("df", "-BG", "--output=avail", path).Output() + if err != nil { + return 0 + } + lines := strings.Split(strings.TrimSpace(string(out)), "\n") + if len(lines) < 2 { + return 0 + } + n, _ := strconv.Atoi(strings.TrimSuffix(strings.TrimSpace(lines[1]), "G")) + return n +} + +func firstLine(s string) string { + s = strings.TrimSpace(s) + if i := strings.IndexByte(s, '\n'); i >= 0 { + s = s[:i] + } + return s +} + +// PortsHeld returns the wanted ports that are not free, for the shapes that +// need them. An empty result is what lets an install proceed unasked. +func (f Facts) PortsHeld(numbers ...int) []Port { + want := map[int]bool{} + for _, n := range numbers { + want[n] = true + } + var held []Port + for _, p := range f.Ports { + if want[p.Number] && !p.Free && !p.Unknown { + held = append(held, p) + } + } + return held +} + +// Port returns one surveyed port by number. +func (f Facts) Port(n int) (Port, bool) { + for _, p := range f.Ports { + if p.Number == n { + return p, true + } + } + return Port{}, false +} diff --git a/internal/plan/plan.go b/internal/plan/plan.go new file mode 100644 index 0000000..5a2f754 --- /dev/null +++ b/internal/plan/plan.go @@ -0,0 +1,413 @@ +// SPDX-FileCopyrightText: 2026 Coffey Labs +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Package plan turns what the operator chose, and what the machine is, into +// the list of things that would happen -- before any of them do. +// +// Everything the installer does goes through a plan. The interface shows it +// on its fifth screen, `--dry-run` prints it and stops, and apply walks it. +// One list, three readers: what you are shown is what runs. +package plan + +import ( + "fmt" + "strings" + + "git.coffeylabs.org/inbuxa/inbuxa-installer/internal/host" +) + +// Component is one of the three programs. +type Component string + +const ( + Server Component = "server" + Console Component = "console" + Webmail Component = "webmail" +) + +// Shape is how a component is installed here. +type Shape string + +const ( + Skip Shape = "skip" + Container Shape = "container" + Host Shape = "host" +) + +// Names as they are shown to a person. The programs have names; the +// components have jobs. +var names = map[Component]string{ + Server: "inbuxa-server (the mail server)", + Console: "inbuxa Admin (the console)", + Webmail: "inbuxa webmail", +} + +// Choice is one row of the matrix. +type Choice struct { + Component Component + Shape Shape +} + +// Options is everything the six screens collect. +type Options struct { + Domain string + MailHost string + ConsoleHost string + WebmailHost string + ACMEEmail string + Local bool // loopback evaluation: no public ports, no certificates + Dir string + Proxy string // "caddy", "snippets", "none" + Choices []Choice +} + +// Shape returns what was chosen for a component. +func (o Options) Shape(c Component) Shape { + for _, ch := range o.Choices { + if ch.Component == c { + return ch.Shape + } + } + return Skip +} + +// Defaults fills in the names that follow from the domain, leaving anything +// the operator set alone. +func (o *Options) Defaults() { + if o.Domain == "" { + return + } + if o.MailHost == "" { + o.MailHost = "mail." + o.Domain + } + if o.ConsoleHost == "" { + o.ConsoleHost = "admin." + o.Domain + } + if o.WebmailHost == "" { + o.WebmailHost = "webmail." + o.Domain + } + if o.ACMEEmail == "" { + o.ACMEEmail = "postmaster@" + o.Domain + } + if o.Dir == "" { + o.Dir = "/var/lib/inbuxa" + } + if o.Proxy == "" { + o.Proxy = "caddy" + } +} + +// Availability says whether a shape can be chosen for a component on this +// machine, and why not when it cannot. The interface dims what it cannot +// offer and shows the reason beside it; a flag that asks for it anyway gets +// the same sentence as an error. +type Availability struct { + OK bool + Why string +} + +// Available answers for one cell of the matrix. +func Available(f host.Facts, c Component, s Shape) Availability { + switch s { + case Skip: + return Availability{OK: true} + case Container: + if !f.Docker.Present { + return Availability{Why: "docker is not installed"} + } + if !f.Docker.Usable { + return Availability{Why: f.Docker.Why} + } + return Availability{OK: true} + case Host: + if !f.Systemd { + return Availability{Why: "a host install needs systemd, which is not running this machine"} + } + switch c { + case Server: + return Availability{OK: true} + case Console: + return Availability{OK: true} + case Webmail: + if !f.Node.Present { + return Availability{Why: "a host install of the webmail needs Node 22 or newer; none is installed"} + } + if f.Node.Major < 22 { + return Availability{Why: fmt.Sprintf("a host install of the webmail needs Node 22 or newer; found %s", f.Node.Version)} + } + return Availability{OK: true} + } + } + return Availability{Why: "unknown shape"} +} + +// Step is one thing the installer will do, in the order it will do it. +type Step struct { + Title string // shown as a line in the plan and ticked off during apply + Detail []string // the files, units, containers and ports it touches +} + +// Plan is the whole of it. +type Plan struct { + Options Options + Steps []Step + Ports []int // what will be bound, once, across every component + DNS []string // records the domain needs for this shape + Warnings []string // things that are not refusals but should be read +} + +// Build works out what would happen. It does not touch the machine: every +// fact it needs is in the survey it was given. +func Build(f host.Facts, o Options) (Plan, error) { + o.Defaults() + p := Plan{Options: o} + + if o.Domain == "" && !o.Local { + return p, fmt.Errorf("a domain is needed (or --local for a loopback evaluation)") + } + chosen := 0 + for _, c := range []Component{Server, Console, Webmail} { + s := o.Shape(c) + if s == Skip { + continue + } + chosen++ + if a := Available(f, c, s); !a.OK { + return p, fmt.Errorf("%s as a %s install: %s", names[c], s, a.Why) + } + } + if chosen == 0 { + return p, fmt.Errorf("nothing chosen: pick at least one component") + } + + if !f.Root { + p.Warnings = append(p.Warnings, "not running as root: installing units, users and files under /etc will fail") + } + if f.MemoryMB > 0 && f.MemoryMB < 2048 { + p.Warnings = append(p.Warnings, fmt.Sprintf("%d MB of memory: a mail server with a full text index wants 2 GB or more", f.MemoryMB)) + } + if f.DiskFreeGB > 0 && f.DiskFreeGB < 10 { + p.Warnings = append(p.Warnings, fmt.Sprintf("%d GB free: mail, indexes and images need room to grow", f.DiskFreeGB)) + } + if f.Existing != "" { + p.Warnings = append(p.Warnings, "an install is already recorded in "+f.Existing+": this run will converge it, not duplicate it") + } + + p.Steps = append(p.Steps, Step{ + Title: "Write the deployment directory", + Detail: []string{o.Dir + "/ (configuration, state and the credentials file)"}, + }) + + if s := o.Shape(Server); s != Skip { + p.Ports = append(p.Ports, 25, 465, 993, 995, 4190) + switch s { + case Container: + p.Steps = append(p.Steps, Step{ + Title: "Start the mail server as a container", + Detail: []string{ + "image: registry.coffeylabs.org/inbuxa/inbuxa-server (pinned by digest)", + "volumes: inbuxa-data, inbuxa-etc", + "ports: 25, 465, 993, 995, 4190, and 8081 on loopback for the proxy", + }, + }) + case Host: + p.Steps = append(p.Steps, Step{ + Title: "Install the mail server on this machine", + Detail: []string{ + "binary: /usr/local/bin/inbuxa-server, from the release on git.coffeylabs.org", + "user: inbuxa (system, no login), data in " + o.Dir + "/server", + "unit: /etc/systemd/system/inbuxa-server.service", + }, + }) + } + p.Steps = append(p.Steps, Step{ + Title: "First boot", + Detail: []string{ + "bootstrap over JMAP, then set the front-end URLs, which registers both first-party OAuth clients", + "turn on ACME, trust the proxy, create the first account", + "write " + o.Dir + "/credentials and " + o.Dir + "/dns.zone", + }, + }) + } + + if s := o.Shape(Console); s != Skip { + switch s { + case Container: + p.Steps = append(p.Steps, Step{ + Title: "Start the console as a container", + Detail: []string{ + "image: registry.coffeylabs.org/inbuxa/inbuxa-admin (pinned by digest)", + "port: 8082 on loopback, behind the proxy", + }, + }) + case Host: + p.Steps = append(p.Steps, Step{ + Title: "Install the console on this machine", + Detail: []string{ + "files: " + o.Dir + "/console (static, served by the proxy)", + "no service: it is a page, not a program", + }, + }) + } + } + + if s := o.Shape(Webmail); s != Skip { + switch s { + case Container: + p.Steps = append(p.Steps, Step{ + Title: "Start the webmail as a container", + Detail: []string{ + "image: registry.coffeylabs.org/inbuxa/ihasmail-inbuxa (pinned by digest)", + "port: 8080 on loopback, behind the proxy", + "secret: the OAuth client secret from first boot, written once", + }, + }) + case Host: + p.Steps = append(p.Steps, Step{ + Title: "Install the webmail on this machine", + Detail: []string{ + "files: " + o.Dir + "/webmail, from the release tarball", + "user: inbuxa-webmail (system, no login)", + "unit: /etc/systemd/system/inbuxa-webmail.service, listening on 127.0.0.1:8080", + }, + }) + } + } + + if !o.Local { + switch o.Proxy { + case "caddy": + p.Ports = append(p.Ports, 80, 443) + p.Steps = append(p.Steps, Step{ + Title: "Put a proxy in front, with certificates", + Detail: []string{ + "caddy, managed by the installer", + "names: " + strings.Join(o.hostnames(), ", "), + "ports: 80 and 443", + }, + }) + case "snippets": + p.Steps = append(p.Steps, Step{ + Title: "Write proxy configuration for the web server already here", + Detail: []string{ + o.Dir + "/proxy/nginx-inbuxa.conf and " + o.Dir + "/proxy/Caddyfile.fragment", + "nothing is loaded or restarted: that stays yours", + }, + }) + } + } + + p.Steps = append(p.Steps, Step{ + Title: "Check it works", + Detail: []string{ + "the server answers JMAP and reports its version", + "each front end answers, and points at the server it was configured with", + "the ports that should be open are, and the ones that should not are not", + }, + }) + + p.DNS = o.dnsRecords() + + for _, held := range f.PortsHeld(p.Ports...) { + who := held.Holder + if who == "" { + who = "something this user cannot see" + } + p.Warnings = append(p.Warnings, fmt.Sprintf("port %d (%s) is held by %s", held.Number, held.For, who)) + } + return p, nil +} + +func (o Options) hostnames() []string { + var names []string + if o.Shape(Server) != Skip { + names = append(names, o.MailHost) + } + if o.Shape(Console) != Skip { + names = append(names, o.ConsoleHost) + } + if o.Shape(Webmail) != Skip { + names = append(names, o.WebmailHost) + } + return names +} + +func (o Options) dnsRecords() []string { + if o.Local || o.Domain == "" { + return nil + } + var r []string + if o.Shape(Server) != Skip { + r = append(r, + fmt.Sprintf("%-28s MX 10 %s.", o.Domain+".", o.MailHost), + fmt.Sprintf("%-28s A this machine", o.MailHost+"."), + fmt.Sprintf("%-28s TXT \"v=spf1 mx -all\"", o.Domain+"."), + fmt.Sprintf("%-28s TXT the DKIM key first boot generates", "*._domainkey."+o.Domain+"."), + fmt.Sprintf("%-28s TXT \"v=DMARC1; p=reject; rua=mailto:postmaster@%s\"", "_dmarc."+o.Domain+".", o.Domain), + ) + } + if o.Shape(Console) != Skip { + r = append(r, fmt.Sprintf("%-28s A this machine", o.ConsoleHost+".")) + } + if o.Shape(Webmail) != Skip { + r = append(r, fmt.Sprintf("%-28s A this machine", o.WebmailHost+".")) + } + r = append(r, "(first boot writes the exact records, including the keys, to dns.zone)") + return r +} + +// String renders the plan the way the fifth screen and --dry-run show it. +func (p Plan) String() string { + var b strings.Builder + o := p.Options + fmt.Fprintf(&b, "Plan for %s\n\n", describe(o)) + for i, s := range p.Steps { + fmt.Fprintf(&b, "%2d. %s\n", i+1, s.Title) + for _, d := range s.Detail { + fmt.Fprintf(&b, " %s\n", d) + } + } + if len(p.Ports) > 0 { + fmt.Fprintf(&b, "\nPorts it will bind: %s\n", joinInts(p.Ports)) + } + if len(p.DNS) > 0 { + b.WriteString("\nThe domain will need:\n") + for _, r := range p.DNS { + fmt.Fprintf(&b, " %s\n", r) + } + } + if len(p.Warnings) > 0 { + b.WriteString("\nWorth reading first:\n") + for _, w := range p.Warnings { + fmt.Fprintf(&b, " - %s\n", w) + } + } + return b.String() +} + +func describe(o Options) string { + var parts []string + for _, c := range []Component{Server, Console, Webmail} { + if s := o.Shape(c); s != Skip { + parts = append(parts, fmt.Sprintf("%s as a %s install", names[c], s)) + } + } + where := o.Domain + if o.Local { + where = "a loopback evaluation" + } + return strings.Join(parts, ", ") + " -- " + where +} + +func joinInts(n []int) string { + seen := map[int]bool{} + var out []string + for _, i := range n { + if seen[i] { + continue + } + seen[i] = true + out = append(out, fmt.Sprint(i)) + } + return strings.Join(out, ", ") +}