commit b06e4e9d032741d7d29ac92e0ac98c5ca8bc8688 Author: Sergio Durigan Junior Date: Sun Dec 8 17:25:27 2024 -0500 Initial commit Signed-off-by: Sergio Durigan Junior diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4aa58f8 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# SearXNG Ansible role + +This is an [Ansible](https://www.ansible.com/) role which installs [SearXNG](https://github.com/searxng/searxng) to run as a [Docker](https://www.docker.com/) container wrapped in a systemd service. + +This role *implicitly* depends on: + +- [`com.devture.ansible.role.playbook_help`](https://github.com/devture/com.devture.ansible.role.playbook_help) +- [`com.devture.ansible.role.systemd_docker_base`](https://github.com/devture/com.devture.ansible.role.systemd_docker_base) + +For an Ansible playbook which integrates this role and makes it easier to use, see the [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook). diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..98e4f9f --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,248 @@ +--- + +# Project source code URL: https://github.com/searxng/searxng + +searxng_enabled: true + +searxng_identifier: searxng + +# Upstream doesn't release versioned images, so we have to stick with +# "latest" here. +searxng_version: latest + +# The scheme with which SearXNG will be served. +searxng_scheme: "https" + +# The hostname at which SearXNG is served. +searxng_hostname: '' + +# The path at which SearXNG is served. +# This value must either be `/` or not end with a slash (e.g. `/searxng`). +searxng_path_prefix: / + +# The base URL for the instance. +searxng_base_url: "{{ searxng_scheme }}://{{ searxng_hostname }}{{ searxng_path_prefix }}" + +searxng_uid: '' +searxng_gid: '' + +searxng_base_path: "/{{ searxng_identifier }}" +searxng_config_path: "{{ searxng_base_path }}/config" + +searxng_container_image: "{{ searxng_container_image_registry_prefix }}searxng/searxng:{{ searxng_container_image_tag }}" +searxng_container_image_registry_prefix: docker.io/ +searxng_container_image_tag: "{{ searxng_version }}" +searxng_container_image_force_pull: "{{ searxng_container_image.endswith(':latest') }}" + +# The base container network. It will be auto-created by this role if it doesn't exist already. +searxng_container_network: "{{ searxng_identifier }}" + +# A list of additional container networks that the container would be connected to. +# The role does not create these networks, so make sure they already exist. +# Use this to expose this container to another reverse proxy, which runs in a different container network. +searxng_container_additional_networks: "{{ searxng_container_additional_networks_auto + searxng_container_additional_networks_custom }}" +searxng_container_additional_networks_auto: [] +searxng_container_additional_networks_custom: [] + +# The instance name. +searxng_instance_name: '' + +# The autocomplete backend to use. +# +# Existing autocomplete backends: "dbpedia", "duckduckgo", "google", "yandex", "mwmbl", +# "seznam", "startpage", "stract", "swisscows", "qwant", "wikipedia". +# +# Leave blank to turn it off. +searxng_autocomplete: '' + +# The secret key of this instance. +# +# You can generate a key using "openssl rand -hex 32". +searxng_secret_key: '' + +# Whether to rate limit the number of requests on the instance. +# +# This can be disabled if you're running a private instance. +# +# Note that the rate limiter also requires a valkey database. +searxng_enable_rate_limiter: false + +# When the rate limiter is enabled, you can provide extra +# configuration here. +# +# See https://github.com/searxng/searxng/blob/master/searx/limiter.toml +# for an example file. +searxng_rate_limiter_extra_configuration: '' + +# When the rate limiter is enabled, you must also provide a valkey +# database. +searxng_rate_limiter_config_valkey_hostname: '' + +# Whether to proxy image results through SearXNG. +searxng_enable_image_proxy: true + +# Whether this is a public SearXNG instance. +searxng_public_instance: false + +# You can provide extra configuration snippets here. +# +# See https://github.com/searxng/searxng/blob/master/searx/settings.yml +# for an example file. +searxng_extra_configuration_snippets: '' + +# searxng_basic_auth_enabled controls whether HTTP Basic Auth is enabled. +# Also see `searxng_container_label_basicauth_users`. +searxng_basic_auth_enabled: false +searxng_basic_auth_username: '' +searxng_basic_auth_password: '' +# searxng_container_label_basicauth_users is populated at runtime based on +# searxng_basic_auth_username and searxng_basic_auth_password +searxng_container_label_basicauth_users: '' +searxng_basic_auth_apache_container_image: "{{ searxng_basic_auth_apache_container_image_registry_prefix }}httpd:{{ searxng_basic_auth_apache_container_image_tag }}" +searxng_basic_auth_apache_container_image_tag: "2.4.56-alpine3.17" +searxng_basic_auth_apache_container_image_force_pull: "{{ searxng_basic_auth_apache_container_image.endswith(':latest') }}" +searxng_basic_auth_apache_container_image_registry_prefix: docker.io/ + +searxng_container_http_port: 8080 +# Controls whether the searxng container exposes its HTTP port (as +# defined by `searxng_container_http_port`). +# +# Takes an ":" or "" value (e.g. "127.0.0.1:8731"), or +# empty string to not expose. +searxng_container_http_host_bind_port: "" + +# searxng_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. +# See `../templates/labels.j2` for details. +# +# To inject your own other container labels, see `searxng_container_labels_additional_labels`. +searxng_container_labels_traefik_enabled: true +searxng_container_labels_traefik_docker_network: "{{ searxng_container_network }}" +searxng_container_labels_traefik_hostname: "{{ searxng_hostname }}" +# The path prefix must either be `/` or not end with a slash (e.g. `/searxng`). +searxng_container_labels_traefik_path_prefix: "{{ searxng_path_prefix }}" +searxng_container_labels_traefik_rule: "Host(`{{ searxng_container_labels_traefik_hostname }}`){% if searxng_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ searxng_container_labels_traefik_path_prefix }}`){% endif %}" +searxng_container_labels_traefik_priority: 0 +searxng_container_labels_traefik_entrypoints: web-secure +searxng_container_labels_traefik_tls: "{{ searxng_container_labels_traefik_entrypoints != 'web' }}" +searxng_container_labels_traefik_tls_certResolver: default # noqa var-naming + +# Controls which additional headers to attach to all HTTP requests. +# To add your own custom request headers, use `searxng_container_labels_traefik_additional_response_headers_custom` +searxng_container_labels_traefik_additional_request_headers: "{{ searxng_container_labels_traefik_additional_request_headers_auto | combine(searxng_container_labels_traefik_additional_request_headers_custom) }}" +searxng_container_labels_traefik_additional_request_headers_auto: {} +searxng_container_labels_traefik_additional_request_headers_custom: {} + +# Controls which additional headers to attach to all HTTP responses. +# To add your own custom response headers, use `searxng_container_labels_traefik_additional_response_headers_custom` +searxng_container_labels_traefik_additional_response_headers: "{{ searxng_container_labels_traefik_additional_response_headers_auto | combine(searxng_container_labels_traefik_additional_response_headers_custom) }}" +searxng_container_labels_traefik_additional_response_headers_auto: | + {{ + {} + | combine ({'X-XSS-Protection': searxng_http_header_xss_protection} if searxng_http_header_xss_protection else {}) + | combine ({'X-Frame-Options': searxng_http_header_frame_options} if searxng_http_header_frame_options else {}) + | combine ({'X-Content-Type-Options': searxng_http_header_content_type_options} if searxng_http_header_content_type_options else {}) + | combine ({'Content-Security-Policy': searxng_http_header_content_security_policy} if searxng_http_header_content_security_policy else {}) + | combine ({'Permission-Policy': searxng_http_header_content_permission_policy} if searxng_http_header_content_permission_policy else {}) + | combine ({'Strict-Transport-Security': searxng_http_header_strict_transport_security} if searxng_http_header_strict_transport_security and searxng_container_labels_traefik_tls else {}) + }} +searxng_container_labels_traefik_additional_response_headers_custom: {} + +# searxng_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. +# See `../templates/labels.j2` for details. +# +# Example: +# searxng_container_labels_additional_labels: | +# my.label=1 +# another.label="here" +searxng_container_labels_additional_labels: '' + +# Specifies how often the container health-check will run. +# +# For Traefik based setups, it's important that the interval is short, +# because the interval value also specifies the "initial wait time". +# This is a Docker (moby) bug: https://github.com/moby/moby/issues/33410 +# Without a successful healthcheck, Traefik will not register the service for reverse-proxying. +# Thus, the health interval determines the initial start-up time -- the smaller, the better. +# +# For non-Traefik setups, we use the default healthcheck interval (60s) to decrease overhead. +searxng_container_health_interval: "{{ '5s' if searxng_container_labels_traefik_enabled else '60s' }}" + +searxng_container_hostname: "{{ searxng_hostname }}" + +# A list of additional "volumes" to mount in the container. +# +# See the `--mount` documentation for the `docker run` command. +# +# Example: +# searxng_container_additional_volumes: +# - type: bind +# src: /path/on/the/host +# dst: /data +# - type: bind +# src: /another-path/on/the/host +# dst: /read-only +# options: readonly +searxng_container_additional_volumes: [] + +# A list of extra arguments to pass to the container +searxng_container_extra_arguments: [] + +# Additional environment variables. +searxng_environment_variables_additional_variables: '' + +# Specifies the value of the `X-XSS-Protection` header +# Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. +# +# Learn more about it is here: +# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection +# - https://portswigger.net/web-security/cross-site-scripting/reflected +searxng_http_header_xss_protection: "1; mode=block" + +# Specifies the value of the `X-Frame-Options` header which controls whether framing can happen. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options +searxng_http_header_frame_options: SAMEORIGIN + +# Specifies the value of the `X-Content-Type-Options` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options +searxng_http_header_content_type_options: nosniff + +# Specifies the value of the `Content-Security-Policy` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy +searxng_http_header_content_security_policy: frame-ancestors 'self' + +# Specifies the value of the `Permission-Policy` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permission-Policy +searxng_http_header_content_permission_policy: "{{ 'interest-cohort=()' if searxng_floc_optout_enabled else '' }}" + +# Specifies the value of the `Strict-Transport-Security` header. +# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security +searxng_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if searxng_hsts_preload_enabled else '' }}" + +# Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses +# +# Learn more about what it is here: +# - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea +# - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network +# - https://amifloced.org/ +# +# Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices. +# See: `searxng_content_permission_policy` +searxng_floc_optout_enabled: true + +# Controls if HSTS preloading is enabled +# +# In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and +# indicates a willingness to be "preloaded" into browsers: +# `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload` +# For more information visit: +# - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security +# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security +# - https://hstspreload.org/#opt-in +# See: `searxng_http_header_strict_transport_security` +searxng_hsts_preload_enabled: false + +# List of systemd services that searxng.service depends on +searxng_systemd_required_services_list: "{{ searxng_systemd_required_services_list_default + searxng_systemd_required_services_list_auto + searxng_systemd_required_services_list_custom }}" +searxng_systemd_required_services_list_default: ['docker.service'] +searxng_systemd_required_services_list_auto: [] +searxng_systemd_required_services_list_custom: [] diff --git a/justfile b/justfile new file mode 100644 index 0000000..d938c3d --- /dev/null +++ b/justfile @@ -0,0 +1,6 @@ +# show help by default +default: + @just --list --justfile {{ justfile() }} + +lint: + ansible-lint . diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..414b5ea --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,19 @@ +galaxy_info: + author: Sergio Durigan Junior + role_name: searxng + description: SearXNG - Privacy-respecting, hackable metasearch engine + platforms: + - name: Debian + versions: + - all + - name: Ubuntu + versions: + - all + - name: Archlinux + versions: + - all + - name: EL + versions: + - 7 + license: GPL-3.0-or-later + min_ansible_version: '2.1' diff --git a/tasks/install.yml b/tasks/install.yml new file mode 100644 index 0000000..a56430e --- /dev/null +++ b/tasks/install.yml @@ -0,0 +1,73 @@ +--- + +- name: Ensure SearXNG paths exist + ansible.builtin.file: + path: "{{ item }}" + state: directory + mode: 0751 + owner: "{{ searxng_uid }}" + group: "{{ searxng_gid }}" + with_items: + - "{{ searxng_base_path }}" + - "{{ searxng_config_path }}" + +- name: Ensure SearXNG support files are installed + ansible.builtin.template: + src: "{{ role_path }}/templates/{{ item }}.j2" + dest: "{{ searxng_base_path }}/{{ item }}" + mode: 0640 + owner: "{{ searxng_uid }}" + group: "{{ searxng_gid }}" + with_items: + - env + - labels + +- name: Ensure SearXNG configuration files are installed + ansible.builtin.template: + src: "{{ role_path }}/templates/config/{{ item }}.j2" + dest: "{{ searxng_config_path }}/{{ item }}" + mode: 0640 + owner: "{{ searxng_uid }}" + group: "{{ searxng_gid }}" + with_items: + - settings.yml + - limiter.toml + +- name: Ensure SearXNG container image is pulled via community.docker.docker_image + when: devture_systemd_docker_base_container_image_pull_method == 'ansible-module' + community.docker.docker_image: + name: "{{ searxng_container_image }}" + source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" + force_source: "{{ searxng_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else searxng_container_image_force_pull }}" + register: result + retries: "{{ devture_playbook_help_container_retries_count }}" + delay: "{{ devture_playbook_help_container_retries_delay }}" + until: result is not failed + +- name: Ensure SearXNG container image is pulled via command + when: devture_systemd_docker_base_container_image_pull_method == 'command' + ansible.builtin.command: + cmd: "{{ devture_systemd_docker_base_host_command_docker }} pull {{ searxng_container_image }}" + register: result + retries: "{{ devture_playbook_help_container_retries_count }}" + delay: "{{ devture_playbook_help_container_retries_delay }}" + until: result is not failed + +- name: Ensure SearXNG container network is created via community.docker.docker_network + when: devture_systemd_docker_base_container_network_creation_method == 'ansible-module' + community.general.docker_network: + name: "{{ searxng_container_network }}" + driver: bridge + +- name: Ensure SearXNG container network exists via command + when: devture_systemd_docker_base_container_network_creation_method == 'command' + ansible.builtin.command: + cmd: "{{ devture_systemd_docker_base_host_command_docker }} network create {{ searxng_container_network }}" + register: network_creation_result + failed_when: network_creation_result.rc != 0 and 'already exists' not in network_creation_result.stderr + +- name: Ensure SearXNG systemd service is present + ansible.builtin.template: + src: "{{ role_path }}/templates/systemd/searxng.service.j2" + dest: "{{ devture_systemd_docker_base_systemd_path }}/{{ searxng_identifier }}.service" diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..3a8d3d7 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,23 @@ +--- + +- block: + - when: searxng_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" + + - when: searxng_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/prepare_basic_auth.yml" + + - when: searxng_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/install.yml" + tags: + - setup-all + - setup-searxng + - install-all + - install-searxng + +- block: + - when: not searxng_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml" + tags: + - setup-all + - setup-searxng diff --git a/tasks/prepare_basic_auth.yml b/tasks/prepare_basic_auth.yml new file mode 100644 index 0000000..4cbd935 --- /dev/null +++ b/tasks/prepare_basic_auth.yml @@ -0,0 +1,56 @@ +--- +# This file was shamelessly copied from the Docker Registry Browser role. +# +# We use the `htpasswd` tool to generate the htpasswd file. +# There's an Ansible module that helps with that, but it requires passlib (a Python module) to be installed on the server. +# See: https://docs.ansible.com/ansible/2.3/htpasswd_module.html#requirements-on-host-that-executes-module +# We support various distros, with various versions of Python. Installing additional Python modules can be a hassle. +# As a workaround, we run `htpasswd` from an Apache container image. +- when: searxng_basic_auth_enabled | bool + block: + - name: Ensure Apache Docker image is pulled for generating htpasswd file + community.docker.docker_image: + name: "{{ searxng_basic_auth_apache_container_image }}" + source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" + force_source: "{{ searxng_basic_auth_apache_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else searxng_basic_auth_apache_container_image_force_pull }}" + register: result + retries: "{{ devture_playbook_help_container_retries_count }}" + delay: "{{ devture_playbook_help_container_retries_delay }}" + until: result is not failed + + # We store the password in a file and make the `htpasswd` tool read it from there, + # as opposed to passing it directly on stdin (which will expose it to other processes on the server). + - name: Store HTTP Basic Auth password in a temporary file + ansible.builtin.copy: + content: "{{ searxng_basic_auth_password }}" + dest: "/tmp/registry-browser-password" + mode: 0400 + owner: "{{ searxng_uid }}" + group: "{{ searxng_gid }}" + + - name: Generate htpasswd from username/password + ansible.builtin.command: + cmd: >- + {{ devture_systemd_docker_base_host_command_docker }} run + --rm + --user={{ searxng_uid }}:{{ searxng_gid }} + --cap-drop=ALL + --network=none + --read-only + --mount type=bind,src=/tmp/registry-browser-password,dst=/password,ro + --entrypoint=/bin/sh + {{ searxng_basic_auth_apache_container_image }} + -c + 'cat /password | htpasswd -i -n {{ searxng_basic_auth_username }}' + changed_when: true + register: htpasswd_result + + - name: Capture htpasswd password + ansible.builtin.set_fact: + searxng_container_label_basicauth_users: "{{ htpasswd_result.stdout }}" + + - name: Delete temporary HTTP Basic Auth password file + ansible.builtin.file: + path: /tmp/registry-browser-password + state: absent diff --git a/tasks/uninstall.yml b/tasks/uninstall.yml new file mode 100644 index 0000000..e93df27 --- /dev/null +++ b/tasks/uninstall.yml @@ -0,0 +1,25 @@ +--- + +- name: Check existence of SearXNG systemd service + ansible.builtin.stat: + path: "{{ devture_systemd_docker_base_systemd_path }}/{{ searxng_identifier }}.service" + register: searxng_service_stat + +- when: searxng_service_stat.stat.exists | bool + block: + - name: Ensure SearXNG systemd service is stopped + ansible.builtin.service: + name: "{{ searxng_identifier }}" + state: stopped + enabled: false + daemon_reload: true + + - name: Ensure SearXNG systemd service does not exist + ansible.builtin.file: + path: "{{ devture_systemd_docker_base_systemd_path }}/{{ searxng_identifier }}.service" + state: absent + + - name: Ensure SearXNG path doesn't exist + ansible.builtin.file: + path: "{{ searxng_base_path }}" + state: absent diff --git a/tasks/validate_config.yml b/tasks/validate_config.yml new file mode 100644 index 0000000..b015ccf --- /dev/null +++ b/tasks/validate_config.yml @@ -0,0 +1,43 @@ +--- + +- name: Fail if required SearXNG settings not defined + ansible.builtin.fail: + msg: > + You need to define a required configuration setting (`{{ item }}`). + when: "vars[item] == ''" + with_items: + - searxng_identifier + - searxng_uid + - searxng_gid + - searxng_hostname + - searxng_path_prefix + - searxng_scheme + - searxng_base_url + - searxng_container_network + - searxng_instance_name + +- name: Check if Valkey is configured when using rate limiter + when: searxng_enable_rate_limiter | bool and searxng_rate_limiter_config_valkey_hostname == '' + ansible.builtin.fail: + msg: > + You need to configure Valkey when the SearXNG rate limiter is enabled (`searxng_rate_limiter_config_valkey_hostname`). + +- when: searxng_container_labels_traefik_enabled | bool + block: + - name: Fail if required SearxNG Traefik settings not defined + ansible.builtin.fail: + msg: >- + You need to define a required configuration setting (`{{ item }}`). + when: "vars[item] == ''" + with_items: + - searxng_container_labels_traefik_hostname + - searxng_container_labels_traefik_path_prefix + + # We ensure it doesn't end with a slash, because we handle both (slash and no-slash). + # Knowing that `searxng_container_labels_traefik_path_prefix` does not end with a slash + # ensures we know how to set these routes up without having to do "does it end with a slash" checks elsewhere. + - name: Fail if SearXNG_container_labels_traefik_path_prefix ends with a slash + ansible.builtin.fail: + msg: >- + searxng_container_labels_traefik_path_prefix (`{{ searxng_container_labels_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/searxng`). + when: "searxng_container_labels_traefik_path_prefix != '/' and searxng_container_labels_traefik_path_prefix[-1] == '/'" diff --git a/templates/config/limiter.toml.j2 b/templates/config/limiter.toml.j2 new file mode 100644 index 0000000..f1da01c --- /dev/null +++ b/templates/config/limiter.toml.j2 @@ -0,0 +1,8 @@ +# This configuration file updates the default configuration file +# See https://github.com/searxng/searxng/blob/master/searx/limiter.toml + +[botdetection.ip_limit] +# activate link_token method in the ip_limit method +link_token = true + +{{ searxng_rate_limiter_extra_configuration }} diff --git a/templates/config/settings.yml.j2 b/templates/config/settings.yml.j2 new file mode 100644 index 0000000..1d5a037 --- /dev/null +++ b/templates/config/settings.yml.j2 @@ -0,0 +1,20 @@ +# see https://docs.searxng.org/admin/settings/settings.html#settings-use-default-settings +use_default_settings: true +general: + instance_name: {{ searxng_instance_name | to_yaml }} +server: + secret_key: {{ searxng_secret_key | to_yaml }} + limiter: {{ searxng_enable_rate_limiter | to_yaml }} + image_proxy: {{ searxng_enable_image_proxy | to_yaml }} + public_instance: {{ searxng_public_instance | to_yaml }} + base_url: {{ searxng_base_url| to_yaml }} +search: + autocomplete: {{ searxng_autocomplete | to_yaml }} +ui: + static_use_hash: true +{% if searxng_enable_rate_limiter %} +redis: + url: redis://{{ searxng_rate_limiter_config_valkey_hostname }} +{% endif %} + +{{ searxng_extra_configuration_snippets }} diff --git a/templates/env.j2 b/templates/env.j2 new file mode 100644 index 0000000..096d6e7 --- /dev/null +++ b/templates/env.j2 @@ -0,0 +1 @@ +{{ searxng_environment_variables_additional_variables }} diff --git a/templates/labels.j2 b/templates/labels.j2 new file mode 100644 index 0000000..0c62bac --- /dev/null +++ b/templates/labels.j2 @@ -0,0 +1,57 @@ +{% if searxng_container_labels_traefik_enabled %} +traefik.enable=true + +{% if searxng_container_labels_traefik_docker_network %} +traefik.docker.network={{ searxng_container_labels_traefik_docker_network }} +{% endif %} + +{% set middlewares = [] %} + +{% if searxng_basic_auth_enabled %} +traefik.http.middlewares.{{ searxng_identifier }}-auth.basicauth.users={{ searxng_container_label_basicauth_users }} +{% set middlewares = middlewares + [searxng_identifier + '-auth'] %} +{% endif %} + +{% if searxng_container_labels_traefik_path_prefix != '/' %} +traefik.http.middlewares.{{ searxng_identifier }}-slashless-redirect.redirectregex.regex=https?://([^/]+)({{ searxng_container_labels_traefik_path_prefix | quote }})$ +traefik.http.middlewares.{{ searxng_identifier }}-slashless-redirect.redirectregex.replacement=${2}/ +{% set middlewares = middlewares + [searxng_identifier + '-slashless-redirect'] %} +{% endif %} + +{% if searxng_container_labels_traefik_path_prefix != '/' %} +traefik.http.middlewares.{{ searxng_identifier }}-strip-prefix.stripprefix.prefixes={{ searxng_container_labels_traefik_path_prefix }} +{% set middlewares = middlewares + [searxng_identifier + '-strip-prefix'] %} +{% endif %} + +{% if searxng_container_labels_traefik_additional_request_headers.keys() | length > 0 %} +{% for name, value in searxng_container_labels_traefik_additional_request_headers.items() %} +traefik.http.middlewares.{{ searxng_identifier }}-add-request-headers.headers.customrequestheaders.{{ name }}={{ value }} +{% endfor %} +{% set middlewares = middlewares + [searxng_identifier + '-add-request-headers'] %} +{% endif %} + +{% if searxng_container_labels_traefik_additional_response_headers.keys() | length > 0 %} +{% for name, value in searxng_container_labels_traefik_additional_response_headers.items() %} +traefik.http.middlewares.{{ searxng_identifier }}-add-response-headers.headers.customresponseheaders.{{ name }}={{ value }} +{% endfor %} +{% set middlewares = middlewares + [searxng_identifier + '-add-response-headers'] %} +{% endif %} + +traefik.http.routers.{{ searxng_identifier }}.rule={{ searxng_container_labels_traefik_rule }} +{% if searxng_container_labels_traefik_priority | int > 0 %} +traefik.http.routers.{{ searxng_identifier }}.priority={{ searxng_container_labels_traefik_priority }} +{% endif %} +traefik.http.routers.{{ searxng_identifier }}.service={{ searxng_identifier }} +{% if middlewares | length > 0 %} +traefik.http.routers.{{ searxng_identifier }}.middlewares={{ middlewares | join(',') }} +{% endif %} +traefik.http.routers.{{ searxng_identifier }}.entrypoints={{ searxng_container_labels_traefik_entrypoints }} +traefik.http.routers.{{ searxng_identifier }}.tls={{ searxng_container_labels_traefik_tls | to_json }} +{% if searxng_container_labels_traefik_tls %} +traefik.http.routers.{{ searxng_identifier }}.tls.certResolver={{ searxng_container_labels_traefik_tls_certResolver }} +{% endif %} + +traefik.http.services.{{ searxng_identifier }}.loadbalancer.server.port={{ searxng_container_http_port }} +{% endif %} + +{{ searxng_container_labels_additional_labels }} diff --git a/templates/systemd/searxng.service.j2 b/templates/systemd/searxng.service.j2 new file mode 100644 index 0000000..3110091 --- /dev/null +++ b/templates/systemd/searxng.service.j2 @@ -0,0 +1,59 @@ +#jinja2: lstrip_blocks: "True" +[Unit] +Description=SearXNG ({{ searxng_identifier }}) +{% for service in searxng_systemd_required_services_list %} +Requires={{ service }} +After={{ service }} +{% endfor %} +DefaultDependencies=no + +[Service] +Type=simple +Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill {{ searxng_identifier }} 2>/dev/null || true' +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm {{ searxng_identifier }} 2>/dev/null || true' + +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ + --rm \ + --name={{ searxng_identifier }} \ + --user={{ searxng_uid }}:{{ searxng_gid }} \ + --log-driver=none \ + --cap-drop=ALL \ + --cap-add=CHOWN \ + --cap-add=FOWNER \ + --cap-add=setgid \ + --cap-add=setuid \ + --network={{ searxng_container_network }} \ + --hostname={{ searxng_container_hostname }} \ + {% if searxng_container_http_host_bind_port %} + -p {{ searxng_container_http_host_bind_port }}:{{ searxng_container_http_port }} \ + {% endif %} + --env-file={{ searxng_base_path }}/env \ + --label-file={{ searxng_base_path }}/labels \ + --health-interval={{ searxng_container_health_interval }} \ + --mount type=bind,src={{ searxng_config_path }},dst=/etc/searxng \ + --mount type=bind,src=/etc/passwd,dst=/etc/passwd,readonly \ + --tmpfs=/tmp:rw,noexec,nosuid,size=1024m \ + {% for volume in searxng_container_additional_volumes %} + --mount type={{ volume.type | default('bind' if '/' in volume.src else 'volume') }},src={{ volume.src }},dst={{ volume.dst }}{{ (',' + volume.options) if volume.options | default('') else '' }} \ + {% endfor %} + {% for arg in searxng_container_extra_arguments %} + {{ arg }} \ + {% endfor %} + {{ searxng_container_image }} + +{% for network in searxng_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} {{ searxng_identifier }} +{% endfor %} + +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach {{ searxng_identifier }} + +ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill {{ searxng_identifier }} 2>/dev/null || true' +ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm {{ searxng_identifier }} 2>/dev/null || true' + +Restart=always +RestartSec=30 +SyslogIdentifier={{ searxng_identifier }} + +[Install] +WantedBy=multi-user.target