diff --git a/LICENSE b/LICENSE index 7db7c42..be3f7b2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,661 @@ -MIT License + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 -Copyright (c) 2026 Flamy studio + 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. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + Preamble -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + 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 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -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 index 36a28cb..686fdc5 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Architecture Firewall Runtime - License + License

--- @@ -783,4 +783,12 @@ HY2XS рассчитан на операторов, которым нужен в ## Лицензия -Проект распространяется по лицензии MIT. Текст лицензии находится в [`LICENSE`](LICENSE). +HY2XS распространяется на условиях **GNU Affero General Public License v3.0 only** (`AGPL-3.0-only`). + +Полный текст лицензии находится в [`LICENSE`](LICENSE). + +Сторонние библиотеки и зависимости сохраняют собственные лицензии. + +--- + +

Разработано во Flamy Studio.

diff --git a/apps/frontend/package.json b/apps/frontend/package.json index 2892809..1015474 100644 --- a/apps/frontend/package.json +++ b/apps/frontend/package.json @@ -2,6 +2,7 @@ "name": "hy2xs-admin", "version": "0.0.0", "private": true, + "license": "AGPL-3.0-only", "description": "HY2XS admin", "author": "HY2XS", "packageManager": "pnpm@9.15.9", diff --git a/docs/01-architecture-baseline.md b/docs/01-architecture-baseline.md index c89c262..19f20a8 100644 --- a/docs/01-architecture-baseline.md +++ b/docs/01-architecture-baseline.md @@ -11,7 +11,7 @@ Функции: - хранение исходников проекта -- хранение и сопровождение **нашего форка HY2XS admin** +- хранение и сопровождение исходного кода **HY2XS admin** - хранение исходников оркестратора на **Bun + TypeScript** - компиляция install-артефакта оркестратора - подготовка install package @@ -46,7 +46,7 @@ Target layer **не содержит сборщика** и **не выполня - лимит по умолчанию: 50/50 Mbps на клиента ### UI слой -- **наш форк H UI / HY2XS admin** +- **HY2XS admin** — штатный компонент проекта - поставляется внутри проекта - устанавливается локально из итогового пакета - не скачивается с upstream на сервере @@ -66,7 +66,7 @@ Target layer **не содержит сборщика** и **не выполня ### 1. Ядро, UI и оркестратор ведут себя по-разному - Hysteria2: берём свежую upstream-версию при установке -- HY2XS admin: держим **свой fork** и поставляем его сами +- HY2XS admin: разрабатываем **внутри проекта** и поставляем его сами - Оркестратор: пишем на **Bun + TypeScript**, но собираем **локально**, а не на target ### 2. Builder и target не смешиваются diff --git a/docs/02-build-layer-and-package.md b/docs/02-build-layer-and-package.md index e5a9fa2..ec72bd1 100644 --- a/docs/02-build-layer-and-package.md +++ b/docs/02-build-layer-and-package.md @@ -36,7 +36,7 @@ Builder не является частью target install flow: на target serv - шаблоны конфигов - systemd unit templates - docs -- **наш fork HY2XS admin** +- исходный код **HY2XS admin** - шаблоны для `post-install.env` - package metadata @@ -79,7 +79,7 @@ project/ │ ├── templates/ │ └── systemd/ ├── ui/ -│ └── hy2xs-admin-fork/ +│ └── hy2xs-admin/ ├── docs/ └── dist/ ``` diff --git a/docs/03-server-hysteria2.md b/docs/03-server-hysteria2.md index 9ffacbc..a3c9012 100644 --- a/docs/03-server-hysteria2.md +++ b/docs/03-server-hysteria2.md @@ -7,7 +7,7 @@ ## Роль Hysteria2 Hysteria2 — основной транспортный компонент сервера. -Он не форкается и не поставляется как часть UI-форка. +Он не вендорится и не собирается как часть HY2XS. ## Source policy diff --git a/docs/04-admin-panel-h-ui-fork.md b/docs/04-admin-panel-h-ui-fork.md deleted file mode 100644 index b4b3327..0000000 --- a/docs/04-admin-panel-h-ui-fork.md +++ /dev/null @@ -1,114 +0,0 @@ -# Admin panel: bundled H UI fork - -## Цель документа - -Зафиксировать новую модель работы с UI: панель больше не рассматривается как внешний upstream-зависимый слой для target install, а становится **нашим вендорным компонентом**, поставляемым вместе с проектом. - -## Почему меняем подход - -Причина архитектурная: - -- Hysteria2 ядро считаем достаточно стабильным upstream-компонентом -- UI считаем более слабым по поддержке и менее надёжным как внешний operational dependency -- поэтому UI забираем к себе: **fork + vendor + ship with package** - -## Что это означает практически - -### Было -- Hysteria — upstream -- H UI — отдельный upstream -- оркестратор ставит оба компонента как внешние зависимости - -### Стало -- Hysteria — upstream -- H UI — **наш fork внутри проекта** -- итоговый package уже содержит UI -- на target server не надо скачивать H UI из чужого репозитория - -## Правильная модель - -- локальный builder хранит и собирает наш fork H UI -- install package везёт UI на сервер -- target-side orchestrator только раскладывает UI и создаёт unit -- H UI продолжает работать как надстройка над Hysteria YAML/API-слоем - -## Что считать нормальным - -Факт, что H UI — это надстройка над YAML-конфигом Hysteria, считается нормальным. -Это не аргумент против использования UI. -Важно только, чтобы источник истины по runtime-состоянию был понятен и не было двух конкурирующих конфигурационных миров без правил синхронизации. - -## Scope панели - -Панель нужна для: -- operator-facing управления -- просмотра статуса -- работы с пользователями / трафиком / сущностями доступа -- удобной админской рутины - -Панель не должна: -- определять install lifecycle сервера -- превращать систему в сложный control plane -- диктовать scope оркестратора - -## Правила поставки - -Bundled H UI должна: -- поставляться внутри итогового пакета -- иметь свой install dir -- иметь свой data dir -- иметь rootless systemd unit (`hy2xs-admin`) -- запускаться отдельным systemd unit -- не требовать target-side build - -## Правила ответственности - -### Source of truth -- runtime transport layer: Hysteria -- операторский UI layer: forked H UI -- install lifecycle: наш orchestrator -- deploy facts: `post-install.env` - -## Production lifecycle Hysteria2 - -В production package HY2XS admin не скачивает и не обновляет бинарь Hysteria2 самостоятельно. - -Правильная модель: -- Hysteria2 устанавливается install-оркестратором с official upstream -- Hysteria2 запускается отдельным `hysteria-server.service` -- HY2XS admin работает как operator UI и HTTP auth/traffic layer -- HY2XS admin не запускается от root -- смена версии Hysteria2 через UI отключена в baseline -- список upstream releases не является частью operator UI baseline -- port hopping не является частью production path - -### Что нельзя делать -- скачивать H UI с upstream прямо на target как baseline -- собирать UI на сервере -- склеивать unit Hysteria и unit H UI в один сервис -- раздувать оркестратор из-за особенностей UI -- использовать HY2XS admin как updater бинаря Hysteria2 -- использовать `JWT_SECRET` как `trafficStats.secret` для Hysteria API - -## Что фиксировать в `post-install.env` - -Минимум: -- `HUI_ENABLED` -- `HUI_FORK_REF` -- `HUI_BUILD_ID` -- `HUI_BIND_HOST` -- `HUI_PORT` -- `HUI_INSTALL_DIR` -- `HUI_DATA_DIR` - -## Инварианты - -Схема считается корректной, если: - -1. UI приезжает на target уже в составе пакета -2. target не скачивает UI с внешнего upstream -3. UI работает отдельным сервисом -4. UI не меняет install-only scope оркестратора -5. Hysteria остаётся внешним vanilla upstream-компонентом -6. UI не выступает updater-менеджером Hysteria2 -7. `trafficStats.secret` не связан с `JWT_SECRET` diff --git a/docs/04-admin-panel.md b/docs/04-admin-panel.md new file mode 100644 index 0000000..a8c3443 --- /dev/null +++ b/docs/04-admin-panel.md @@ -0,0 +1,109 @@ +# Admin panel: HY2XS admin + +## Цель документа + +Зафиксировать модель работы с admin-панелью: HY2XS admin является **штатным компонентом HY2XS**, а не внешней зависимостью, которую target server где-то добывает во время установки. + +## Место компонента в системе + +Проект состоит из компонентов двух разных типов: + +- **Hysteria2** — external runtime dependency. Ванильный upstream-бинарник, который оркестратор забирает из официального источника во время установки. +- **HY2XS admin** — native HY2XS component. Исходный код лежит в репозитории, компонент собирается production builder'ом вместе с остальными артефактами HY2XS. + +Это противопоставление и есть основная архитектурная граница. + +## Состав компонента + +- исходный код admin-компонента хранится в [`apps/`](../apps); +- backend реализован на Go; +- frontend реализован на Vue/Vite; +- frontend-ассеты встраиваются в Go-бинарник; +- компонент собирается production builder'ом вместе с остальными артефактами HY2XS; +- готовый бинарник едет в install package как `ui/hy2xs-admin/hy2xs-admin`. + +## Правила поставки + +HY2XS admin: + +- поставляется внутри итогового пакета; +- имеет свой install dir; +- имеет свой data dir; +- запускается отдельным rootless systemd unit (`hy2xs-admin`); +- не требует target-side build. + +Target server **не собирает** admin-компонент из исходного кода и **не скачивает** его из внешнего репозитория. + +## Scope панели + +Панель нужна для: + +- operator-facing управления; +- просмотра статуса; +- работы с пользователями / трафиком / сущностями доступа; +- удобной админской рутины. + +Панель не должна: + +- определять install lifecycle сервера; +- превращать систему в сложный control plane; +- диктовать scope оркестратора. + +HY2XS admin работает как надстройка над Hysteria YAML/API-слоем. Это нормально: важно только, чтобы источник истины по runtime-состоянию был понятен и не было двух конкурирующих конфигурационных миров без правил синхронизации. + +## Правила ответственности + +### Source of truth + +- runtime transport layer: Hysteria2 +- операторский UI layer: HY2XS admin +- install lifecycle: оркестратор HY2XS +- deploy facts: `post-install.env` + +## Production lifecycle Hysteria2 + +В production package HY2XS admin не скачивает и не обновляет бинарь Hysteria2 самостоятельно. + +Правильная модель: + +- Hysteria2 устанавливается install-оркестратором с official upstream; +- Hysteria2 запускается отдельным `hysteria-server.service`; +- HY2XS admin работает как operator UI и HTTP auth/traffic layer; +- HY2XS admin не запускается от root; +- смена версии Hysteria2 через UI отключена в baseline; +- список upstream releases не является частью operator UI baseline; +- port hopping не является частью production path. + +### Что нельзя делать + +- собирать admin-компонент на target server; +- скачивать admin-компонент на target из внешнего репозитория; +- склеивать unit Hysteria2 и unit HY2XS admin в один сервис; +- раздувать оркестратор из-за особенностей панели; +- использовать HY2XS admin как updater бинаря Hysteria2; +- использовать `JWT_SECRET` как `trafficStats.secret` для Hysteria API. + +## Что фиксировать в `post-install.env` + +Минимум: + +- `HY2XS_ADMIN_ENABLED` +- `HY2XS_ADMIN_SOURCE` +- `HY2XS_ADMIN_BUILD_ID` +- `HY2XS_ADMIN_BIND_HOST` +- `HY2XS_ADMIN_PORT` +- `HY2XS_ADMIN_INSTALL_DIR` +- `HY2XS_ADMIN_DATA_DIR` +- `HY2XS_ADMIN_LOG_DIR` + +## Инварианты + +Схема считается корректной, если: + +1. HY2XS admin приезжает на target уже в составе пакета +2. target не скачивает и не собирает admin-компонент +3. HY2XS admin работает отдельным сервисом +4. HY2XS admin не меняет install-only scope оркестратора +5. Hysteria2 остаётся внешним vanilla upstream-компонентом +6. HY2XS admin не выступает updater-менеджером Hysteria2 +7. `trafficStats.secret` не связан с `JWT_SECRET` diff --git a/docs/08-orchestrator-spec.md b/docs/08-orchestrator-spec.md index d111d77..605866d 100644 --- a/docs/08-orchestrator-spec.md +++ b/docs/08-orchestrator-spec.md @@ -35,7 +35,7 @@ - uninstall - repair старых неизвестных состояний - target-side build -- target-side git clone нашего UI-форка +- target-side git clone исходного кода HY2XS admin - Telegram-бот / access delivery ## Предусловия diff --git a/docs/09-post-install-env.md b/docs/09-post-install-env.md index 7043261..d4dae20 100644 --- a/docs/09-post-install-env.md +++ b/docs/09-post-install-env.md @@ -19,7 +19,7 @@ - какой build артефакт использован - какой стек оркестратора применён - какая версия Hysteria реально установилась -- какой fork/build UI разложен на target +- какой build HY2XS admin разложен на target - какие базовые параметры сети и портов заданы Именно для этого создаётся `post-install.env`. @@ -89,14 +89,14 @@ - `HY2_CONFIG_PATH` ### HY2XS admin -- `HUI_ENABLED` -- `HUI_FORK_REF` -- `HUI_BUILD_ID` -- `HUI_BIND_HOST` -- `HUI_PORT` -- `HUI_INSTALL_DIR` -- `HUI_DATA_DIR` -- `HUI_LOG_DIR` +- `HY2XS_ADMIN_ENABLED` +- `HY2XS_ADMIN_SOURCE` +- `HY2XS_ADMIN_BUILD_ID` +- `HY2XS_ADMIN_BIND_HOST` +- `HY2XS_ADMIN_PORT` +- `HY2XS_ADMIN_INSTALL_DIR` +- `HY2XS_ADMIN_DATA_DIR` +- `HY2XS_ADMIN_LOG_DIR` ## Как работать с файлами diff --git a/docs/11-testing-and-acceptance.md b/docs/11-testing-and-acceptance.md index b579af9..f74110a 100644 --- a/docs/11-testing-and-acceptance.md +++ b/docs/11-testing-and-acceptance.md @@ -107,7 +107,7 @@ 1. production builder на Debian 13 amd64 выдаёт переносимый install package 2. target server не выполняет build step 3. Hysteria2 получена из official upstream -4. UI поставлен из bundled fork +4. HY2XS admin поставлен из install package 5. `post-install.env` отражает фактическое deploy-состояние 6. оркестратор зафиксирован как Bun/TypeScript stack и поставляется как готовый install-артефакт 7. оркестратор не требует standalone update / rollback / uninstall subcommands diff --git a/docs/12-operations-and-troubleshooting.md b/docs/12-operations-and-troubleshooting.md index bdb9f15..15bf3d0 100644 --- a/docs/12-operations-and-troubleshooting.md +++ b/docs/12-operations-and-troubleshooting.md @@ -24,8 +24,8 @@ apt-get install -y sudo ca-certificates curl iproute2 tar openssl nftables syste ### 2. UI приезжает из нашего пакета Если проблема в UI, сначала смотреть: -- какой `HUI_FORK_REF` -- какой `HUI_BUILD_ID` +- какой `HY2XS_ADMIN_SOURCE` +- какой `HY2XS_ADMIN_BUILD_ID` - тот ли пакет вообще стоит на сервере ### 3. Hysteria приходит из upstream @@ -108,7 +108,7 @@ curl -sS \ Проверить: - разложился ли bundled UI - корректен ли unit `hy2xs-admin` -- совпадает ли `HUI_INSTALL_DIR` с реальностью +- совпадает ли `HY2XS_ADMIN_INSTALL_DIR` с реальностью - не сломан ли bind host / port ### Admin UI access via SSH tunnel diff --git a/docs/README.md b/docs/README.md index 74156f6..4d86a74 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,7 @@ Этот набор документов фиксирует актуальную baseline-модель HY2XS под следующие ограничения: - серверный транспорт: **ванильная Hysteria2** -- UI: **наш форк H UI / HY2XS admin**, поставляется **вместе с проектом** +- UI: **HY2XS admin**, штатный компонент проекта, поставляется **вместе с пакетом** - target OS: **только чистый Debian 13** - оркестратор: **install-only**, только первичная установка и базовая настройка - стек оркестратора: **Bun + TypeScript** @@ -18,20 +18,20 @@ В этой редакции зафиксированы два слоя: 1. **Builder layer** — работает на отдельном **Debian 13 amd64 build host**. - Он собирает итоговый пакет, подготавливает **наш форк HY2XS admin**, компилирует **Bun/TypeScript оркестратор** в install-артефакт, упаковывает шаблоны, unit-файлы и примеры конфигов. + Он собирает итоговый пакет, собирает **HY2XS admin**, компилирует **Bun/TypeScript оркестратор** в install-артефакт, упаковывает шаблоны, unit-файлы и примеры конфигов. 2. **Runtime / target layer** — работает **на чистом Debian 13**. Здесь нет сборщика. Здесь запускается только итоговый install package / orchestrator, который: - ставит системные зависимости - - разворачивает **наш встроенный UI** + - разворачивает **встроенный HY2XS admin** - забирает **свежую Hysteria2 из официального upstream** - создаёт конфиги, systemd unit-файлы и `post-install.env` - выполняет базовую настройку сервера ## Базовые правила -1. Hysteria2 не форкается и не вендорится в проект. -2. HY2XS admin форкается к себе и поставляется вместе с пакетом. +1. Hysteria2 не вендорится и не собирается как часть HY2XS. +2. HY2XS admin — штатный компонент проекта и поставляется вместе с пакетом. 3. Оркестратор пишется на **Bun + TypeScript**. 4. На target нет `npm` / `pnpm` / `yarn` / `bun install` / transpile step. 5. На target нет standalone логики update / rollback / uninstall. @@ -43,7 +43,7 @@ 1. [01-architecture-baseline.md](01-architecture-baseline.md) 2. [02-build-layer-and-package.md](02-build-layer-and-package.md) 3. [03-server-hysteria2.md](03-server-hysteria2.md) -4. [04-admin-panel-h-ui-fork.md](04-admin-panel-h-ui-fork.md) +4. [04-admin-panel.md](04-admin-panel.md) 5. [05-client-and-access-scope.md](05-client-and-access-scope.md) 6. [06-speed-limits-and-congestion.md](06-speed-limits-and-congestion.md) 7. [07-systemd-and-firewall.md](07-systemd-and-firewall.md) @@ -72,4 +72,4 @@ Правильная baseline-модель теперь такая: -**Локальный builder собирает install package с нашим форком HY2XS admin и Bun/TypeScript оркестратором; серверный install-only orchestrator ставит этот пакет на чистый Debian 13, тянет свежую Hysteria2 из upstream, разворачивает UI, создаёт systemd + nftables + post-install env и подготавливает рабочее серверное окружение.** +**Локальный builder собирает install package с HY2XS admin и Bun/TypeScript оркестратором; серверный install-only orchestrator ставит этот пакет на чистый Debian 13, тянет свежую Hysteria2 из upstream, разворачивает HY2XS admin, создаёт systemd + nftables + post-install env и подготавливает рабочее серверное окружение.** diff --git a/orchestrator/package.json b/orchestrator/package.json index c3b84b9..6e09d92 100644 --- a/orchestrator/package.json +++ b/orchestrator/package.json @@ -2,6 +2,7 @@ "name": "hy2xs-orchestrator", "version": "0.1.0", "private": true, + "license": "AGPL-3.0-only", "type": "module", "packageManager": "bun@1.3.13", "scripts": { diff --git a/package/templates/env/post-install.env.tpl b/package/templates/env/post-install.env.tpl index 364f6e1..a753610 100644 --- a/package/templates/env/post-install.env.tpl +++ b/package/templates/env/post-install.env.tpl @@ -37,11 +37,11 @@ HY2_BANDWIDTH_DOWN={{BANDWIDTH_DOWN}} HY2_IGNORE_CLIENT_BANDWIDTH={{IGNORE_CLIENT_BANDWIDTH}} HY2_CONFIG_PATH=/etc/hysteria/config.yaml -HUI_ENABLED=true -HUI_FORK_REF=packaged -HUI_BUILD_ID={{PACKAGE_BUILD_ID}} -HUI_BIND_HOST={{UI_BIND_HOST}} -HUI_PORT={{UI_PORT}} -HUI_INSTALL_DIR={{INSTALL_DIR}} -HUI_DATA_DIR={{DATA_DIR}} -HUI_LOG_DIR={{LOG_DIR}} +HY2XS_ADMIN_ENABLED=true +HY2XS_ADMIN_SOURCE=packaged +HY2XS_ADMIN_BUILD_ID={{PACKAGE_BUILD_ID}} +HY2XS_ADMIN_BIND_HOST={{UI_BIND_HOST}} +HY2XS_ADMIN_PORT={{UI_PORT}} +HY2XS_ADMIN_INSTALL_DIR={{INSTALL_DIR}} +HY2XS_ADMIN_DATA_DIR={{DATA_DIR}} +HY2XS_ADMIN_LOG_DIR={{LOG_DIR}} diff --git a/tools/build/README.md b/tools/build/README.md index ac7d447..cbfc73d 100644 --- a/tools/build/README.md +++ b/tools/build/README.md @@ -22,7 +22,7 @@ dist/hy2xs-install-.tar.gz - [`tools/build/lib/verify.sh`](lib/verify.sh) — проверка структуры репозитория и итогового архива. - [`tools/build/hysteria-lock.env`](hysteria-lock.env) — pinned версия, URL и SHA256 upstream Hysteria2 binary. - [`orchestrator`](../../orchestrator) — TypeScript/Bun install-only orchestrator. -- [`apps`](../../apps) — HY2XS admin fork: backend на Go и frontend. +- [`apps`](../../apps) — HY2XS admin: Go backend и Vue frontend. - [`package`](../../package) — skeleton будущего install package: `install.sh`, templates, systemd units, default config. - [`dist`](../../dist) — итоговые архивы. Создаётся builder'ом, в git обычно не хранится. - [`.toolchain`](../../.toolchain) — локальный toolchain builder'а. Создаётся автоматически, в git не хранится. diff --git a/tools/build/build.sh b/tools/build/build.sh index c174d5e..9e3ff71 100755 --- a/tools/build/build.sh +++ b/tools/build/build.sh @@ -33,7 +33,7 @@ main() { log_step "Building install-only orchestrator" build_orchestrator - log_step "Bundling HY2XS admin fork" + log_step "Bundling HY2XS admin" bundle_ui log_step "Writing metadata" diff --git a/tools/build/lib/acceptance.sh b/tools/build/lib/acceptance.sh index 972c897..2fcc7fe 100644 --- a/tools/build/lib/acceptance.sh +++ b/tools/build/lib/acceptance.sh @@ -9,6 +9,13 @@ run_fix20_acceptance_subset() { [ -x "$package_dir/install.sh" ] || fail "acceptance: install.sh is missing or not executable" [ -x "$package_dir/orchestrator/hy2xs-orchestrator" ] || fail "acceptance: orchestrator artifact is missing" + log_step "Acceptance: project license is shipped with the package" + [ -f "$package_dir/LICENSE" ] || fail "acceptance: LICENSE is missing from the package" + grep -q 'GNU AFFERO GENERAL PUBLIC LICENSE' "$package_dir/LICENSE" \ + || fail "acceptance: packaged LICENSE must be AGPL-3.0-only" + grep -q '^license=AGPL-3.0-only$' "$package_dir/metadata/package.env" \ + || fail "acceptance: package metadata must declare license=AGPL-3.0-only" + log_step "Acceptance: orchestrator CLI help path" "$package_dir/orchestrator/hy2xs-orchestrator" diagnostics collect --package-dir "$package_dir" >/dev/null 2>&1 || true diff --git a/tools/build/lib/package.sh b/tools/build/lib/package.sh index f4a8690..308f612 100644 --- a/tools/build/lib/package.sh +++ b/tools/build/lib/package.sh @@ -21,6 +21,8 @@ prepare_stage() { rm -rf "$STAGE_DIR/orchestrator" "$STAGE_DIR/ui" "$STAGE_DIR/metadata" mkdir -p "$STAGE_DIR/orchestrator" "$STAGE_DIR/ui/hy2xs-admin" "$STAGE_DIR/metadata" + install -m 0644 LICENSE "$STAGE_DIR/LICENSE" + printf '%s\n' "$version" >"$STAGE_DIR/metadata/package.version" printf '%s\n' "$build_id" >"$STAGE_DIR/metadata/package.build_id" } @@ -102,6 +104,7 @@ write_metadata() { { printf 'name=HY2XS\n' + printf 'license=AGPL-3.0-only\n' printf 'version=%s\n' "$version" printf 'build_id=%s\n' "$build_id" printf 'build_host_os=debian13\n' diff --git a/tools/build/lib/verify.sh b/tools/build/lib/verify.sh index ff91147..4e77b9d 100644 --- a/tools/build/lib/verify.sh +++ b/tools/build/lib/verify.sh @@ -2,6 +2,7 @@ set -euo pipefail require_repo_layout() { + [ -f "LICENSE" ] || fail "missing LICENSE" [ -d "orchestrator/src" ] || fail "missing orchestrator/src" [ -f "orchestrator/package.json" ] || fail "missing orchestrator/package.json" [ -f "orchestrator/bun.lock" ] || fail "missing orchestrator/bun.lock" @@ -44,6 +45,7 @@ verify_archive() { listing="$(tar -tzf "$archive")" printf '%s\n' "$listing" | grep -q '^hy2xs-install/install.sh$' || fail "archive missing install.sh" + printf '%s\n' "$listing" | grep -q '^hy2xs-install/LICENSE$' || fail "archive missing LICENSE" printf '%s\n' "$listing" | grep -q '^hy2xs-install/orchestrator/hy2xs-orchestrator$' || fail "archive missing orchestrator artifact" printf '%s\n' "$listing" | grep -q '^hy2xs-install/ui/hy2xs-admin/hy2xs-admin$' || fail "archive missing bundled UI binary" printf '%s\n' "$listing" | grep -q '^hy2xs-install/systemd/hysteria-server.service$' || fail "archive missing hysteria systemd unit" @@ -53,6 +55,13 @@ verify_archive() { printf '%s\n' "$listing" | grep -q '^hy2xs-install/templates/env/post-install.env.tpl$' || fail "archive missing post-install env template" printf '%s\n' "$listing" | grep -q '^hy2xs-install/metadata/checksums.txt$' || fail "archive missing checksums" + local license_text + license_text="$(tar -xOzf "$archive" hy2xs-install/LICENSE)" + printf '%s\n' "$license_text" | grep -q 'GNU AFFERO GENERAL PUBLIC LICENSE' \ + || fail "packaged LICENSE is not the GNU Affero General Public License" + printf '%s\n' "$license_text" | grep -q 'Version 3, 19 November 2007' \ + || fail "packaged LICENSE is not AGPL version 3" + local env_content env_content="$(tar -xOzf "$archive" hy2xs-install/config/hy2xs.env)" printf '%s\n' "$env_content" | grep -q 'replace-with-your-domain.example' && fail "packaged hy2xs.env contains placeholder domain" @@ -80,6 +89,7 @@ verify_archive() { printf '%s\n' "$meta" | grep -q '^source_git_commit=' || fail "metadata missing source_git_commit" printf '%s\n' "$meta" | grep -q '^dirty_tree=' || fail "metadata missing dirty_tree" printf '%s\n' "$meta" | grep -q '^build_profile=production$' || fail "metadata missing build_profile=production" + printf '%s\n' "$meta" | grep -q '^license=AGPL-3.0-only$' || fail "metadata missing license=AGPL-3.0-only" if declare -F run_fix20_acceptance_subset >/dev/null 2>&1; then run_fix20_acceptance_subset "$tmp/hy2xs-install"