diff --git a/superx-ansible/LICENSE b/superx-ansible/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/superx-ansible/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/superx-ansible/README.md b/superx-ansible/README.md new file mode 100644 index 0000000..40e864d --- /dev/null +++ b/superx-ansible/README.md @@ -0,0 +1,34 @@ +# Ansible Script for Installing superx on Ubuntu 22.04 + +This repo provides an ansible playbook for a convenient way to install + +This playbook needs ansible version >=2.10 to work, it also relies on a few dependencies from ansible community. + +So if you are using ubuntu, make sure you install `ansible` instead of `ansible-core`. + +(It was developed on a control node running Ubuntu 22.04) + +For more information on ansible visit their [official documentation](https://docs.ansible.com/). + +## Usage + + +To run the playbook simply enter the IP of your machine into the inventory file (see comments for examples). + +Then run the following command: +``` +ansible-playbook --ask-become main.yml +``` + +After the Playbook has finished, you need to manually create the database, +client, and user table in the admin interface. + +## SSL + +The default will install superx **without** SSL encryption. + +For SSL encryption to work you **first** need to have the necessary files (e.g. +the certificates) in place before running the playbook. +Now you have to adjust the settings in the vars.yml file. + + diff --git a/superx-ansible/Vagrantfile b/superx-ansible/Vagrantfile new file mode 100644 index 0000000..006c69d --- /dev/null +++ b/superx-ansible/Vagrantfile @@ -0,0 +1,10 @@ +# -*- mode: ruby -*- +# vi: set ft=ruby : + +Vagrant.configure("2") do |config| + config.vm.box = "generic/ubuntu2204" + config.vm.network "forwarded_port", guest: 80, host: 8080 + config.vm.provision "ansible" do |ansible| + ansible.playbook = "main.yml" + end +end diff --git a/superx-ansible/ansible.cfg b/superx-ansible/ansible.cfg new file mode 100644 index 0000000..fcc8010 --- /dev/null +++ b/superx-ansible/ansible.cfg @@ -0,0 +1,4 @@ +[defaults] +inventory = inventory +remote_user = root + diff --git a/superx-ansible/config-files/apache/no-ssl/000-default.conf b/superx-ansible/config-files/apache/no-ssl/000-default.conf new file mode 100644 index 0000000..4b21568 --- /dev/null +++ b/superx-ansible/config-files/apache/no-ssl/000-default.conf @@ -0,0 +1,58 @@ + + # The ServerName directive sets the request scheme, hostname and port that + # the server uses to identify itself. This is used when creating + # redirection URLs. In the context of virtual hosts, the ServerName + # specifies what hostname must appear in the request's Host: header to + # match this virtual host. For the default virtual host (this file) this + # value is not decisive as it is used as a last resort host regardless. + # However, you must set it for any further virtual host explicitly. + #ServerName www.example.com + + ServerAdmin webmaster@localhost + DocumentRoot /var/www/kivitendo-erp + + AddHandler fcgid-script .fpl + FcgidMaxRequestLen 10485760 + FcgidIOTimeout 32000 + AliasMatch ^/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.fpl + Alias [^/] /var/www/kivitendo-erp/ + + + + AllowOverride All + Options ExecCGI Includes FollowSymlinks + Require all granted + + + + Order Deny,Allow + Deny from All + + +{% if use_basic_auth == true %} + + AuthUserFile /etc/apache2/.htpasswd + AuthName "Please authenticate" + AuthType Basic + Require valid-user + + +{% endif %} + # Available loglevels: trace8, ..., trace1, debug, info, notice, warn, + # error, crit, alert, emerg. + # It is also possible to configure the loglevel for particular + # modules, e.g. + #LogLevel info ssl:warn + + ErrorLog ${APACHE_LOG_DIR}/error.log + CustomLog ${APACHE_LOG_DIR}/access.log combined + + # For most configuration files from conf-available/, which are + # enabled or disabled at a global level, it is possible to + # include a line for only one particular virtual host. For example the + # following line enables the CGI configuration for this host only + # after it has been globally disabled with "a2disconf". + #Include conf-available/serve-cgi-bin.conf + + +# vim: syntax=apache ts=4 sw=4 sts=4 sr noet diff --git a/superx-ansible/config-files/apache/ssl/default-ssl.conf b/superx-ansible/config-files/apache/ssl/default-ssl.conf new file mode 100644 index 0000000..24824d4 --- /dev/null +++ b/superx-ansible/config-files/apache/ssl/default-ssl.conf @@ -0,0 +1,72 @@ +# generated 2023-08-21, Mozilla Guideline v5.7, Apache 2.4.41, OpenSSL 1.1.1k, intermediate configuration +# https://ssl-config.mozilla.org/#server=apache&version=2.4.41&config=intermediate&openssl=1.1.1k&guideline=5.7 + +# this configuration requires mod_ssl, mod_socache_shmcb, mod_rewrite, and mod_headers + + RewriteEngine On + RewriteCond %{REQUEST_URI} !^/\.well\-known/acme\-challenge/ + RewriteRule ^(.*)$ https://%{HTTP_HOST}$1 [R=301,L] + + + + SSLEngine on + + # enable HTTP/2, if available + Protocols h2 http/1.1 + + # HTTP Strict Transport Security (mod_headers is required) (63072000 seconds) + Header always set Strict-Transport-Security "max-age=63072000" + + ServerAdmin webmaster@localhost + DocumentRoot /var/www/kivitendo-erp + + AddHandler fcgid-script .fpl + FcgidMaxRequestLen 10485760 + FcgidIOTimeout 32000 + AliasMatch ^/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.fpl + Alias [^/] /var/www/kivitendo-erp/ + + + # disallow access to .git or config for all cases + + Require all denied + + + + SSLRequireSSL + Options ExecCGI Includes FollowSymlinks + AllowOverride All + Require all granted + + +{% if use_basic_auth == true %} + + AuthUserFile /etc/apache2/.htpasswd + AuthName "Please authenticate" + AuthType Basic + Require valid-user + + +{% endif %} + + Order Deny,Allow + Deny from All + + + SSLCertificateFile {{ ssl.CertFile }} + SSLCertificateKeyFile {{ ssl.CertKey }} + SSLCertificateChainFile {{ ssl.ChainFile }} + ErrorLog ${APACHE_LOG_DIR}/error.log + CustomLog ${APACHE_LOG_DIR}/access.log combined + + +# intermediate configuration +SSLProtocol all -SSLv3 -TLSv1 -TLSv1.1 +SSLCipherSuite ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-CHACHA20-POLY1305 +SSLHonorCipherOrder off +SSLSessionTickets off + +SSLUseStapling On +SSLStaplingCache "shmcb:logs/ssl_stapling(32768)" + +# vim: syntax=apache ts=4 sw=4 sts=4 sr noet diff --git a/superx-ansible/config-files/kivitendo.conf b/superx-ansible/config-files/kivitendo.conf new file mode 100644 index 0000000..5a71dce --- /dev/null +++ b/superx-ansible/config-files/kivitendo.conf @@ -0,0 +1,416 @@ +[authentication] +# The cleartext password for access to the administrative part. It +# can only be changed in this file, not via the administrative +# interface. +admin_password = admin123 + +# Which modules to use for authentication. Valid values are 'DB' and +# 'LDAP'. You can use multiple modules separated by spaces. +# +# Multiple LDAP modules with different configurations can be used by +# postfixing 'LDAP' with the name of the configuration section to use: +# 'LDAP:ldap_fallback' would use the data from +# '[authentication/ldap_fallback]'. The name defaults to 'ldap' if it +# isn't given. +# +# Note that the LDAP module doesn't support changing the password. +module = DB + +# The cookie name can be changed if desired. +cookie_name = kivitendo_session_id + +# The number of minutes a session is valid. The default value is eight +# hours. +session_timeout = 480 + +# The number of seconds to penalize failed login attempts. 0 disables +# it. +failed_login_penalty = 5 + +[authentication/database] +# Connection information for the database with the user and group +# inforamtion. This information is always needed, even if LDAP is +# used for authentication, as the user information is stored in this +# database while LDAP is only used for password verification. +# +# If 'module' is set to 'DB' then this database also contains the +# users' passwords. +host = 127.0.0.1 +port = 5432 +db = kivitendo_auth +user = postgres +password = + +[authentication/ldap] +# This section is only relevant if 'module' is set to 'LDAP'. It names +# the LDAP server the passwords are verified against by doing a LDAP +# bind operation. +# +# At least the parameters 'host', 'attribute' and 'base_dn' have to be +# specified. +# +# tls: Activate encryption via TLS +# verify: If 'tls' is used, how to verify the server's certificate. +# Can be one of 'require' or 'none'. +# attribute: Name of the LDAP attribute containing the user's login name +# base_dn: Base DN the LDAP searches start from +# filter: An optional LDAP filter specification. The string '<%login%>' +# is replaced by the user's login name before the search is started. +# bind_dn and bind_password: +# If searching the LDAP tree requires user credentials +# (e.g. ActiveDirectory) then these two parameters specify +# the user name and password to use. +# timeout: Timeout when connecting to the server in seconds. +# +# You can specify a fallback LDAP server to use in case the main one +# isn't reachable by duplicating this whole section as +# "[authentication/ldap_fallback]". +# +host = localhost +port = 389 +tls = 0 +attribute = uid +base_dn = +filter = +bind_dn = +bind_password = +timeout = 10 +verify = require + +[system] +# Set language for login and admin forms. Currently "de" (German) +# and "en" (English, not perfect) are available. +language = de + +# Set stylesheet for login and admin forms. Supported: +# lx-office-erp +# kivitendo - default +# design40 +stylesheet = kivitendo + +# MassPrint Timeout +# must be less than cgi timeout +# +massprint_timeout = 30 + +# Set default_manager for admin forms. Currently "german" +# and "swiss" are available. +default_manager = german + +# The memory limits given here determine the maximum process size +# (vsz, the total amount of memory this process uses including memory +# swapped out or shared with other processes) or resident set size +# (rss, the amount of memory not swapped out/shared with other +# processes). If either limit is reached at the end of the request +# then the kivitendo process will exit. +# +# This only applies for processes under FCGI and the task manager. +# For CGI configurations the process will be terminated after each request +# regardless of this setting. +# +# Note: this will only terminate processes with too high memory consumption. It +# is assumed that an external managing service will start new instances. For +# FCGI this will usually be apache or the wrapper scripts for nginx, for the +# task server this will have to be the system manager. +# +# Numbers can be postfixed with KB, MB, GB. If no number is given or +# the number is 0 then no checking will be performed. +memory_limit_rss = +memory_limit_vsz = + +[paths] +# path to temporary files (must be writeable by the web server) +userspath = users +# spool directory for batch printing +spool = spool +# templates base directory +templates = templates +# Path to the old memberfile (ignored on new installations) +memberfile = users/members +# Path to ELSTER geierlein webserver path inside kivitendo +# (must be inside kivitendo but you can set an ALIAS for apache/oe +# if set the export to geierlein is enabled +# geierlein_path = geierlein + +# +# document path for FileSystem FileManagement: +# (must be reachable read/write but not executable from webserver) +# document_path = /var/local/kivi_documents +# + +[mail_delivery] +# Delivery method can be 'sendmail' or 'smtp'. For 'method = sendmail' the +# parameter 'mail_delivery.sendmail' is used as the executable to call. If +# 'applications.sendmail' still exists (backwards compatibility) then +# 'applications.sendmail' will be used instead of 'mail_delivery.sendmail'. +# If method is empty, mail delivery is disabled. +method = smtp +# Location of sendmail for 'method = sendmail' +sendmail = /usr/sbin/sendmail -t<%if myconfig_email%> -f <%myconfig_email%><%end%> +# Settings for 'method = smtp'. Only set 'port' if your SMTP server +# runs on a non-standard port (25 for 'security=none' or +# 'security=tls', 465 for 'security=ssl'). +host = localhost +#port = 25 +# Security can be 'tls', 'ssl' or 'none'. Unset equals 'none'. This +# determines whether or not encryption is used and which kind. For +# 'tls' the module 'Net::SSLGlue' is required; for 'ssl' +# 'Net::SMTP::SSL' is required and 'none' only uses 'Net::SMTP'. +security = none +# Authentication is only used if 'login' is set. You should only use +# that with 'tls' or 'ssl' encryption. +login = +password = + +[applications] +# Location of OpenOffice.org/LibreOffice writer +openofficeorg_writer = lowriter +# Location of the html2ps binary +html2ps = html2ps +# Location of the Ghostscript binary +ghostscript = gs +# Location of the program to create PDFs from TeX documents +latex = latexmk --pdflatex +# Location of the Python interpreter to use when converting from +# OpenDocument to PDF. Some distributions compile UNO support only +# into binaries located in different locations than the main Python +# binary. +python_uno = python3 + +[environment] +# Add the following paths to the PATH environment variable. +path = /usr/local/bin:/usr/X11R6/bin:/usr/X11/bin +# Add the following paths to the PERL5LIB environment variable. +# "/sw/lib/perl5" is for Mac OS X with Fink's Perl. +lib = /sw/lib/perl5 +# Add the following paths to the PYTHONPATH environment variable for +# locating Python modules. Python is used when converting OpenDocument +# files into PDF files. +python_uno_path = + +[print_templates] +# If you have LaTeX installed set to 1 +latex = 1 +# Minimal support for Excel print templates +excel = 0 +# Enable or disable support for OpenDocument print templates +opendocument = 1 +# Chose whether or not OpenOffice/LibreOffice should remain running after a +# conversion. If yes then the conversion of subsequent documents will +# be a bit faster. You need to have Python and the Python UNO bindings +# (part of OpenOffice/LibreOffice) installed. +openofficeorg_daemon = 0 +openofficeorg_daemon_port = 2002 + +[task_server] +# Set to 1 for debug messages in /tmp/kivitendo-debug.log +debug = 0 +# Chose a system user the daemon should run under when started as root. +run_as = +# Task servers can run on multiple machines. Each needs its own unique +# ID. If unset, it defaults to the host name. All but one task server +# must have 'only_run_tasks_for_this_node' set to 1. +node_id = +only_run_tasks_for_this_node = 0 + +[task_server/notify_on_failure] +# If you want email notifications for failed jobs then set this to a +# kivitendo user (login) name. The subject can be changed as well. +send_email_to = +# The "From:" header for said email. +email_from = kivitendo Daemon +# The subject for said email. +email_subject = kivitendo Task-Server: Hintergrundjob fehlgeschlagen +# The template file used for the email's body. +email_template = templates/webpages/task_server/failure_notification_email.txt + +[periodic_invoices] +# The user name or email address a report about the posted and printed +# invoices is sent to. +send_email_to = +# The "From:" header for said email. +email_from = kivitendo Daemon +# The subject for said email. +email_subject = Benachrichtigung: automatisch erstellte Rechnungen +# The template file used for the email's body. +email_template = templates/webpages/oe/periodic_invoices_email.txt +# Whether to always send the mail (0), or only if there were errors +# (1). +send_for_errors_only = 0 + +[self_test] + +# modules to be tested +# Add without SL::BackgroundJob::SelfTest:: prefix +# Separate with space. +modules = Transactions + +# you probably don't want to be spammed with "everything ok" every day. enable +# this when you add new tests to make sure they run correctly for a few days +send_email_on_success = 0 + +# will log into the standard logfile +log_to_file = 0 + +# user login (!) to send the email to. +send_email_to = +# will be used to send your report mail +email_from = +# The subject line for your report mail +email_subject = kivitendo self test report +# template. currently txt and html templates are recognized and correctly mime send. +email_template = templates/mail/self_test/status_mail.txt + +[follow_up_reminder] +# Email notifications for due follow ups. +# The "From:" header for said email. +email_from = kivitendo Daemon +# The subject for said email. +email_subject = kivitendo: fällige Wiedervorlagen +# The template file used for the email's body. +# If empty fu/follow_up_reminder_mail.html will be used. +email_template = + +[console] +# Automatic login will only work if both "client" and "login" are +# given. "client" can be a client's database ID or its name. "login" +# is simply a user's login name. +client = +login = + +# autorun lines will be executed after autologin. +# be warned that loading huge libraries will noticably lengthen startup time. +#autorun = require "bin/mozilla/common.pl"; +# = use English qw(-no_match_vars); +# = use List::Util qw(min max); +# = sub take { my $max = shift; my $r = ref($_[0]) eq 'ARRAY' ? $_[0] : \@_; return @{$r}[0..List::Util::min($max, scalar(@{$r})) - 1]; } + +# location of history file for permanent history +history_file = users/console_history + +# location of a separate log file for the console. everything normally written +# to the kivitendo log will be put here if triggered from the console +log_file = /tmp/kivitendo_console_debug.log + +[testing] + +# Several tests need a database they can alter data in freely. This +# database will be dropped & created before any other test is run. The +# following parameters must be given: +[testing/database] +host = 127.0.0.1 +port = 5432 +db = +user = postgres +password = +template = template1 +superuser_user = postgres +superuser_password = + +[devel] +# Several settings related to the development of kivitendo. + +# "client" is used by several scripts (e.g. rose_auto_create_model.pl) +# when they need access to the database. It can be either a client's +# database ID or its name. +client = + +[debug] +# Use DBIx::Log4perl for logging DBI calls. The string LXDEBUGFILE +# will be replaced by the file name configured for $::lxdebug. +dbix_log4perl = 0 +dbix_log4perl_config = log4perl.logger = FATAL, LOGFILE + = log4perl.appender.LOGFILE=Log::Log4perl::Appender::File + = log4perl.appender.LOGFILE.filename=LXDEBUGFILE + = log4perl.appender.LOGFILE.mode=append + = log4perl.appender.LOGFILE.Threshold = ERROR + = log4perl.appender.LOGFILE.layout=PatternLayout + = log4perl.appender.LOGFILE.layout.ConversionPattern=[%r] %F %L %c - %m%n + = log4perl.logger.DBIx.Log4perl=DEBUG, A1 + = log4perl.appender.A1=Log::Log4perl::Appender::File + = log4perl.appender.A1.filename=LXDEBUGFILE + = log4perl.appender.A1.mode=append + = log4perl.appender.A1.layout=Log::Log4perl::Layout::PatternLayout + = log4perl.appender.A1.layout.ConversionPattern=%d %p> %F{1}:%L %M - %m%n + +# Activate certain global debug messages. If you want to combine +# several options then list them separated by spaces. +# +# Possible values include: +# NONE - no debug output (default) +# INFO +# DEBUG1 +# DEBUG2 +# QUERY - Dump SQL queries (only in legacy code; see also "dbix_log4perl" above) +# TRACE - Track function calls and returns +# BACKTRACE_ON_ERROR - Print a function call backtrace when $form->error() is called +# REQUEST_TIMER - Log timing of HTTP requests +# REQUEST - Log each request. Careful! Passwords get filtered, but +# there may be confidential information being logged here +# WARN - warnings +# SHOW_CALLER - include the file name & line number from where a call +# to "message" or "dump" was called +# ALL - all possible debug messages +# +# DEVEL - sames as "INFO QUERY TRACE BACKTRACE_ON_ERROR REQUEST_TIMER" +# +# Example: +# global_level = TRACE QUERY +global_level = NONE + +# Activate monitoring of the content of $form. If it is active then +# monitoring can be turned on for certain variables with the +# following: +# $form->{"Watchdog::"} = 1; +# Monitoring has a performance cost and is therefore deactivated by +# default. +watch_form = 0 + +# If you want to debug the creation of LaTeX files then set this to 1. +# That way the temporary LaTeX files created during PDF creation are +# not removed and remain in the "users" directory. +keep_temp_files = 0 + +# Restart the FastCGI process if changes to the program or template +# files have been detected. The restart will occur after the request +# in which the changes have been detected has completed. +restart_fcgi_process_on_changes = 0 + +# The file name where the debug messages are written to. +file_name = /tmp/kivitendo-debug.log + +# If set to 1 then the installation will be kept unlocked even if a +# database upgrade fails. +keep_installation_unlocked = 0 + +# If set to 1 then all resource links (JavaScript, CSS files) output +# via $::request->{layout}->use_stylesheet() / use_javascript() will +# be made unique by appending a random GET parameter. This will cause +# the web browser to always reload the resources. +auto_reload_resources = 0 + +# If set to 1 each exception will include a full stack backtrace. +backtrace_on_die = 0 + +[cti] +# If you want phone numbers to be clickable then this must be set to a +# command that does the actually dialing. Within this command three +# variables are replaced before it is executed: +# +# 1. <%phone_extension%> and <%phone_password%> are taken from the user +# configuration (changeable in the admin interface). +# 2. <%number%> is the number to dial. It has already been sanitized +# and formatted correctly regarding e.g. the international dialing +# prefix. +# +# The following is an example that works with the OpenUC telephony +# server: +# dial_command = curl --insecure -X PUT https://<%phone_extension%>:<%phone_password%>@IP.AD.DR.ESS:8443/sipxconfig/rest/my/call/<%number%> +dial_command = +# If you need to dial something before the actual number then set +# external_prefix to it. +external_prefix = 0 +# The prefix for international calls (numbers starting with +). +international_dialing_prefix = 00 +# Our own country code +our_country_code = 49 diff --git a/superx-ansible/inventory b/superx-ansible/inventory new file mode 100644 index 0000000..6e7fa17 --- /dev/null +++ b/superx-ansible/inventory @@ -0,0 +1,14 @@ +# Add the IP or domain of your target machine below e.g. +# example.org +# or +# 192.168.121.1 +# +sxdemo +# aditional information for ssh connection (e.g. port, user, key file) can be entered like this +# three.example.com:2222 ansible_user=myuser ansible_ssh_private_key_file=/path/to/key/file +sxdemo:22 ansible_user=root ansible_ssh_private_key_file=/home/superx/.ssh/id_ed25519 +# +# for local install uncomment following line +# localhost ansible_connection=local + +#vim: set ft=ini diff --git a/superx-ansible/main.yml b/superx-ansible/main.yml new file mode 100644 index 0000000..a118707 --- /dev/null +++ b/superx-ansible/main.yml @@ -0,0 +1,56 @@ +--- +- name: Install SuperX dependencies + hosts: all + become: true + + vars_files: + vars.yml + + handlers: + - name: Start postgresql + ansible.builtin.service: + name: postgresql + state: restarted + + tasks: + + - name: Update repos and install dependencies. + ansible.builtin.apt: + name: + - tomcat9 + - default-jre + - postgresql + - postgresql-contrib + - apache2 + - libapache2-mod-jk + - git + - recode + - zip + - rsync + - s-nail + - curl + - dos2unix + - openjdk-11-jdk + - openjdk-17-jdk + - p7zip + - p7zip-full + state: present + update_cache: true + + # install SuperX + - name: Ensure git is installed. + ansible.builtin.apt: + name: git + state: present + + # postrgesql for SuperX + - name: Allow acces from localhost to Postgresql. + ansible.builtin.postgresql_pg_hba: + contype: host + users: all + databases: all + address: 127.0.0.1 + method: trust + dest: /etc/postgresql/14/main/pg_hba.conf + + diff --git a/superx-ansible/vars.yml b/superx-ansible/vars.yml new file mode 100644 index 0000000..cd21505 --- /dev/null +++ b/superx-ansible/vars.yml @@ -0,0 +1,2 @@ +--- +