From a5de655db81d1f2337fe612141a6e18a6d9b3b9e Mon Sep 17 00:00:00 2001 From: partisan Date: Sun, 12 Jan 2025 11:39:12 +0100 Subject: [PATCH] Init --- Config.md | 56 ++++ Flags.md | 19 ++ Home.md | 35 ++- Licence.md | 660 +++++++++++++++++++++++++++++++++++++++++++++++ Nginx-Linux.md | 124 +++++++++ Setup-Docker.md | 77 ++++++ Setup-Linux.md | 93 +++++++ Setup-Other.md | 24 ++ Setup-Windows.md | 69 +++++ Setup.md | 10 + _Footer.md | 8 + _Sidebar.md | 12 + 12 files changed, 1186 insertions(+), 1 deletion(-) create mode 100644 Config.md create mode 100644 Flags.md create mode 100644 Licence.md create mode 100644 Nginx-Linux.md create mode 100644 Setup-Docker.md create mode 100644 Setup-Linux.md create mode 100644 Setup-Other.md create mode 100644 Setup-Windows.md create mode 100644 Setup.md create mode 100644 _Footer.md create mode 100644 _Sidebar.md diff --git a/Config.md b/Config.md new file mode 100644 index 0000000..6e361af --- /dev/null +++ b/Config.md @@ -0,0 +1,56 @@ +# Configuration File (`config.ini`) + +This page documents all configuration variables available in `config.ini`, including their purpose, possible values, and default settings. + +## Server Configuration +| **Variable** | **Description** | **Default Value** | **Possible Values** | +|--------------|-------------------------------------------------|-------------------|---------------------------| +| `Port` | Port number for the application server | `5000` | Any valid port number | +| `Domain` | Domain address of the server | `localhost` | Any valid domain string | +| `LogLevel` | Logging level for the application | `1` | `0` (Silent), `1` (Errors), `2` (Warnings), `3` (Info), `4` (Debug) | + +## Peer Configuration +| **Variable** | **Description** | **Default Value** | **Possible Values** | +|--------------|-------------------------------------------------|-------------------|---------------------------| +| `AuthCode` | Authorization code for peer connections | Auto-generated | 64-character random string | +| `PeerID` | Unique identifier for the peer | Auto-generated | Any unique string | +| `Peers` | Comma-separated list of peer addresses | Empty | List of peer URLs | + +## Feature Toggles +| **Variable** | **Description** | **Default Value** | **Possible Values** | +|-----------------------|---------------------------------------------------------|-------------------|---------------------------| +| `NodesEnabled` | Enable or disable peer-to-peer nodes | `false` | `true` / `false` | +| `MetaSearchEnabled` | Enable metasearch crawling from other search engines | `true` | `true` / `false` | +| `IndexerEnabled` | Enable web crawling and indexing | `false` | `true` / `false` | +| `WebsiteEnabled` | Enable website hosting feature | `true` | `true` / `false` | +| `RamCacheEnabled` | Enable caching in RAM | `true` | `true` / `false` | +| `DriveCacheEnabled` | Enable caching on the disk | `false` | `true` / `false` | + +## Proxy Configuration +| **Variable** | **Description** | **Default Value** | **Possible Values** | +|-----------------------|---------------------------------------------------------|-------------------|---------------------------| +| `MetaProxyEnabled` | Use proxies for metasearch crawling | `false` | `true` / `false` | +| `CrawlerProxyEnabled` | Use proxies for general web crawling and indexing | `false` | `true` / `false` | + +## Crawling and Indexing +| **Variable** | **Description** | **Default Value** | **Possible Values** | +|----------------------------|-----------------------------------------------------|-------------------|---------------------------| +| `ConcurrentStandardCrawlers` | Number of concurrent standard crawlers | `12` | Positive integer | +| `ConcurrentChromeCrawlers` | Number of concurrent Chrome-based crawlers | `4` | Positive integer | +| `CrawlingInterval` | Interval for refreshing crawled results | `24h` | Any valid Go duration | +| `MaxPagesPerDomain` | Maximum number of pages to crawl per domain | `10` | Positive integer | +| `IndexBatchSize` | Number of pages to index in a single batch | `50` | Positive integer | + +## Cache Configuration +### RAM Cache +| **Variable** | **Description** | **Default Value** | **Possible Values** | +|----------------------|-------------------------------------|-------------------|---------------------------| +| `Duration` | Duration to store results in RAM | `6h` | Any valid Go duration | +| `MaxUsage` | Maximum usage of RAM cache | `90%` | Percentage (`%`) or size (e.g., `2GiB`) | + +### Drive Cache +| **Variable** | **Description** | **Default Value** | **Possible Values** | +|----------------------|-------------------------------------|-------------------|---------------------------| +| `Duration` | Duration to store results on disk | `48h` | Any valid Go duration | +| `MaxUsage` | Maximum usage of drive cache | `90%` | Percentage (`%`) or size (e.g., `10GiB`) | +| `Path` | Path to the drive cache directory | `./cache` | Any valid file path | diff --git a/Flags.md b/Flags.md new file mode 100644 index 0000000..91b54f3 --- /dev/null +++ b/Flags.md @@ -0,0 +1,19 @@ +# Flags + +The following flags can be used when running QGato. They override any corresponding variables set in the `config.ini` file. + +--- + +### Available Flags + +- **`--port`** + Sets the port for the application. + Example: `go rum . --port 8080` + +- **`--domain`** + Sets the domain address for the application. + Example: `go rum . --domain example.com` + +- **`--skip-config-check`** + Skips validation of `config.ini`. + Example: `go rum . --skip-config-check` \ No newline at end of file diff --git a/Home.md b/Home.md index 5d08b7b..41f3b42 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,34 @@ -Welcome to the Wiki. \ No newline at end of file +# QGato Search Engine Documentation + +Welcome to the **QGato Search Engine** documentation! This wiki provides all the information you need to set up, configure, and use QGato effectively. Whether you're self-hosting or exploring advanced features, you'll find everything you need here. + +--- + +## Getting Started + +- Follow the **[Setup Guides](Setup.md)** to install QGato. +- Customize your instance using the **[Configuration Guide](Config.md)**. +- Secure your setup with HTTPS using **[Nginx](Nginx-Linux.md)**. + +--- + +## Wiki Pages + +### Setup Guides +- **[Linux](Setup-Linux.md)** +- **[Windows](Setup-Windows.md)** +- **[Docker](Setup-Docker.md)** +- **[Other Platforms](Setup-Other.md)** + +### Configuration and Features +- **[Setting Up Domain (HTTPS)](Nginx-Linux.md)** +- **[Configuration](Config.md)** +- **[Flags](Flags.md)** + +### Additional Resources +- **[License](Licence.md)** +- **[Demo](https://qgato.xyz/)** +- **[Repository](https://weforge.xyz/Spitfire/Search)** + +--- + diff --git a/Licence.md b/Licence.md new file mode 100644 index 0000000..c6f01c6 --- /dev/null +++ b/Licence.md @@ -0,0 +1,660 @@ +# 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/Nginx-Linux.md b/Nginx-Linux.md new file mode 100644 index 0000000..2aaee62 --- /dev/null +++ b/Nginx-Linux.md @@ -0,0 +1,124 @@ +# Setting Up Domain with HTTPS + +Follow these steps to set up Nginx as a reverse proxy for QGato with HTTPS using Certbot. This guide assumes you are using Debian/Ubuntu. For more detailed or alternative Nginx setups, search online for platform-specific guides. + +--- + +### Prerequisites + +- A domain name (e.g., `example.com`). +- QGato running on a server (e.g., `localhost:5000`). +- Nginx installed on your server. + + ```bash + sudo apt update + sudo apt install -y nginx + ``` +- Certbot installed for SSL certificates. + + ```bash + sudo apt install -y certbot python3-certbot-nginx + ``` + +--- + +### Nginx Configuration + +1. Create a new Nginx configuration file: + + ```bash + sudo nano /etc/nginx/sites-available/qgato + ``` +2. Add the following configuration: + + ```nginx + server { + listen 80; + server_name example.com; + + location / { + proxy_pass http://localhost:5000; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + } + ``` +3. Enable the configuration: + + ```bash + sudo ln -s /etc/nginx/sites-available/qgato /etc/nginx/sites-enabled/ + sudo nginx -t + sudo systemctl reload nginx + ``` + +--- + +### Enable HTTPS with Certbot + +1. Obtain an SSL certificate for your domain: + + ```bash + sudo certbot --nginx -d example.com + ``` +2. Update the Nginx configuration to redirect HTTP to HTTPS and listen on port 443. + Edit the configuration file: + + ```bash + sudo nano /etc/nginx/sites-available/qgato + ``` + + Add or replace the configuration with: + + ```nginx + server { + listen 80; + server_name example.com; + return 301 https://$host$request_uri; + } + + server { + listen 443 ssl; + server_name example.com; + + ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem; + ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem; + + location / { + proxy_pass http://localhost:5000; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + } + ``` +3. Reload Nginx to apply changes: + + ```bash + sudo systemctl reload nginx + ``` + +--- + +### Renew SSL Certificates Automatically + +Certbot should automatically sets up a cron job for certificate renewal. To ensure it works correctly: + +1. Test the renewal process: + + ```bash + sudo certbot renew --dry-run + ``` +2. If the test succeeds, Certbot will renew certificates automatically before expiration. + +--- + +### Final Steps + +- Access QGato at: + `https://example.com` +- Ensure Nginx and Certbot are working together seamlessly for secure, automated HTTPS. + +That's it! Your QGato instance is now securely running behind Nginx with HTTPS. diff --git a/Setup-Docker.md b/Setup-Docker.md new file mode 100644 index 0000000..8e54568 --- /dev/null +++ b/Setup-Docker.md @@ -0,0 +1,77 @@ +# Setup for Docker + +### Prerequisites + +- **Docker**: Ensure Docker is installed on your system. + - Installation instructions: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) + +--- + +### Building the Docker Image + +1. Clone the repository: + ```ash + git clone https://weforge.xyz/Spitfire/Search.git + cd Search + ``` + +2. Build the Docker image: + ```ash + docker build -t qgato . + ``` + +--- + +### Running the Container + +#### Using Command-Line Flags + +You can pass configuration options directly as environment variables when running the container: + +1. Run the container with flags for `PORT` and `DOMAIN`: + ```ash + docker run -d -p 5000:5000 --name qgato \ + -e PORT=5000 \ + -e DOMAIN=localhost \ + qgato + ``` + +2. Access the application at: + [http://localhost:5000](http://localhost:5000) + +--- + +#### Using a Pre-Configured `config.ini` + +1. Modify or create the `config.ini` file in the cloned repository to include your desired settings. + +2. Mount the `config.ini` file into the container: + ```ash + docker run -d -p 5000:5000 --name qgato \ + -v $(pwd)/config.ini:/home/myuser/Search/config.ini \ + qgato + ``` + +This method avoids the need to pass environment variables as flags during runtime. + +--- + +### Exposed Port + +The application listens on port `5000` by default. You can map it to any port on your host system using the `-p` flag during `docker run`. + +--- + +### Stopping and Removing the Container + +- Stop the container: + ```ash + docker stop qgato + ``` + +- Remove the container: + ```ash + docker rm qgato + ``` + +That's it! Your QGato instance is now running inside a Docker container. diff --git a/Setup-Linux.md b/Setup-Linux.md new file mode 100644 index 0000000..2103fd3 --- /dev/null +++ b/Setup-Linux.md @@ -0,0 +1,93 @@ +# Setup for Linux + +### Prerequisites + +- **Go**: Version 1.23 or higher is required. +- **Git**: Necessary for cloning the repository. +- **Internet Access**: Required for fetching search results. + +--- + +### Installing Go (if not already installed or version is too low) + +#### Using Package Manager (Recommended) +1. **Ubuntu/Debian-based systems**: + ```bash + sudo apt update + sudo apt install -y golang-go + ``` + +2. **Fedora/RHEL-based systems**: + ```bash + sudo dnf install -y golang + ``` + +3. **Arch-based systems**: + ```bash + sudo pacman -S go + ``` + +#### Manual Installation (If Go version from package manager is too low) +1. Download the latest Go tarball: + ```bash + wget https://go.dev/dl/go1.23.linux-amd64.tar.gz + ``` + +2. Extract it to `/usr/local`: + ```bash + sudo tar -C /usr/local -xzf go1.23.linux-amd64.tar.gz + ``` + +3. Add Go to your PATH (add this to `~/.bashrc` or `~/.zshrc`): + ```bash + export PATH=$PATH:/usr/local/go/bin + ``` + +4. Verify installation: + ```bash + go version + ``` + +--- + +### Running QGato + +1. Install Git: + ```bash + sudo apt install -y git # For Ubuntu/Debian + sudo dnf install -y git # For Fedora/RHEL + sudo pacman -S git # For Arch + ``` + +2. Clone the repository: + ```bash + git clone https://weforge.xyz/Spitfire/Search.git + cd Search + ``` + +3. Make the script executable: + ```bash + chmod +x ./run.sh + ``` + +4. Run the script: + ```bash + ./run.sh + ``` + +--- + +### Alternative (Using Go Directly) + +1. Clone the repository: + ```bash + git clone https://weforge.xyz/Spitfire/Search.git + cd Search + ``` + +2. Run QGato with Go: + ```bash + go run . + ``` + +That's it! QGato is now running. diff --git a/Setup-Other.md b/Setup-Other.md new file mode 100644 index 0000000..0b7b977 --- /dev/null +++ b/Setup-Other.md @@ -0,0 +1,24 @@ +# Setup for Other Platforms + +### Prerequisites + +- **Go**: Version 1.23 or higher is required. +- **Git**: Necessary for cloning the repository. +- **Internet Access**: Required for fetching search results. + +--- + +### Running QGato + +1. Clone the repository: +```sh +git clone https://weforge.xyz/Spitfire/Search.git +cd Search +``` + +2. Run the server using Go: +```sh +go run . +``` + +That's it! QGato is now running. diff --git a/Setup-Windows.md b/Setup-Windows.md new file mode 100644 index 0000000..c82f38b --- /dev/null +++ b/Setup-Windows.md @@ -0,0 +1,69 @@ +# Setup for Windows + +### Prerequisites + +- **Go**: Version 1.23 or higher is required. +- **Git**: Necessary for cloning the repository. +- **Internet Access**: Required for fetching search results. + +--- + +### Installing Go + +1. Download the latest Go installer from the official website: + [https://go.dev/dl/](https://go.dev/dl/) + +2. Run the installer and follow the prompts. Ensure "Add Go to PATH" is selected during installation. + +3. Verify the installation by opening a Command Prompt or PowerShell and running: + ```PowerShell + go version + ``` + +--- + +### Installing Git + +1. Download Git for Windows: + [https://git-scm.com/](https://git-scm.com/) + +2. Run the installer and follow the prompts. Ensure "Git from the command line" is selected. + +3. Verify the installation by running: + ```PowerShell + git --version + ``` + +--- + +### Running QGato + +1. Open Command Prompt or PowerShell. + +2. Clone the repository: + ```PowerShell + git clone https://weforge.xyz/Spitfire/Search.git + cd Search + ``` + +3. Run the server using the provided batch script: + ```PowerShell + .\run.bat + ``` + +--- + +### Alternative (Using Go Directly) + +1. Clone the repository: + ```PowerShell + git clone https://weforge.xyz/Spitfire/Search.git + cd Search + ``` + +2. Run QGato with Go: + ```PowerShell + go run . + ``` + +That's it! QGato is now running. diff --git a/Setup.md b/Setup.md new file mode 100644 index 0000000..214674d --- /dev/null +++ b/Setup.md @@ -0,0 +1,10 @@ +# Setup + +Welcome to the **Setup Guide**! Choose your preferred platform to get started: + +- **[Linux Setup](Setup-Linux.md)** +- **[Windows Setup](Setup-Windows.md)** +- **[Docker Setup](Setup-Docker.md)** +- **[Other Platforms](Setup-Other.md)** + +For additional setup options, such as configuring a domain with HTTPS, see **[Setting Up Domain (HTTPS)](Nginx-Linux.md)**. diff --git a/_Footer.md b/_Footer.md new file mode 100644 index 0000000..7144640 --- /dev/null +++ b/_Footer.md @@ -0,0 +1,8 @@ +

+ + Repository | + Demo | + License + +

+

diff --git a/_Sidebar.md b/_Sidebar.md new file mode 100644 index 0000000..1cc5926 --- /dev/null +++ b/_Sidebar.md @@ -0,0 +1,12 @@ +## Navigation + +- **[Home](Home.md)** +- **[Setup](Setup.md)** + - **[Linux](Setup-Linux.md)** + - **[Windows](Setup-Windows.md)** + - **[Docker](Setup-Docker.md)** + - **[Other Platforms](Setup-Other.md)** +- **[Setting Up Domain (HTTPS)](Nginx-Linux.md)** +- **[Configuration](Config.md)** +- **[Flags](Flags.md)** +- **[License](Licence.md)**