├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── ALL_README.md ├── LICENSE ├── README.md ├── README_es.md ├── README_eu.md ├── README_fr.md ├── README_gl.md ├── README_it.md ├── README_zh_Hans.md ├── conf ├── nginx.conf ├── requirements-ynh.txt ├── settings.yml └── uwsgi.ini ├── doc ├── DESCRIPTION.md └── screenshots │ └── Screenshot.png ├── manifest.toml ├── scripts ├── _common.sh ├── backup ├── change_url ├── install ├── remove ├── restore └── upgrade └── tests.toml /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. 4 | 5 | --- 6 | 7 | **How to post a meaningful bug report** 8 | 1. *Read this whole template first.* 9 | 2. *Determine if you are on the right place:* 10 | - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* 11 | - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* 12 | - *When in doubt, post here and we will figure it out together.* 13 | 3. *Delete the italic comments as you write over them below, and remove this guide.* 14 | --- 15 | 16 | ### Describe the bug 17 | 18 | *A clear and concise description of what the bug is.* 19 | 20 | ### Context 21 | 22 | - Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* 23 | - YunoHost version: x.x.x 24 | - I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* 25 | - Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* 26 | - If yes, please explain: 27 | - Using, or trying to install package version/branch: 28 | - If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* 29 | 30 | ### Steps to reproduce 31 | 32 | - *If you performed a command from the CLI, the command itself is enough. For example:* 33 | ```sh 34 | sudo yunohost app install the_app 35 | ``` 36 | - *If you used the webadmin, please perform the equivalent command from the CLI first.* 37 | - *If the error occurs in your browser, explain what you did:* 38 | 1. *Go to '...'* 39 | 2. *Click on '...'* 40 | 3. *Scroll down to '...'* 41 | 4. *See error* 42 | 43 | ### Expected behavior 44 | 45 | *A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* 46 | 47 | ### Logs 48 | 49 | *When an operation fails, YunoHost provides a simple way to share the logs.* 50 | - *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* 51 | - *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* 52 | 53 | *After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* 54 | 55 | *If applicable and useful, add screenshots to help explain your problem.* 56 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Problem 2 | 3 | - *Description of why you made this PR* 4 | 5 | ## Solution 6 | 7 | - *And how do you fix that problem* 8 | 9 | ## PR Status 10 | 11 | - [ ] Code finished and ready to be reviewed/tested 12 | - [ ] The fix/enhancement were manually tested (if applicable) 13 | 14 | ## Automatic tests 15 | 16 | Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) 17 | -------------------------------------------------------------------------------- /ALL_README.md: -------------------------------------------------------------------------------- 1 | # All available README files by language 2 | 3 | - [Read the README in English](README.md) 4 | - [Lea el README en español](README_es.md) 5 | - [Irakurri README euskaraz](README_eu.md) 6 | - [Lire le README en français](README_fr.md) 7 | - [Le o README en galego](README_gl.md) 8 | - [阅读中文（简体）的 README](README_zh_Hans.md) 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Searx for YunoHost 7 | 8 | [![Integration level](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![Working status](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) 9 | 10 | [![Install Searx with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) 11 | 12 | *[Read this README in other languages.](./ALL_README.md)* 13 | 14 | > *This package allows you to install Searx quickly and simply on a YunoHost server.* 15 | > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.* 16 | 17 | ## Overview 18 | 19 | Privacy-respecting, hackable metasearch engine. 20 | 21 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 22 | Installation is discouraged. 23 | 24 | SearXNG is a potential alternative, already packaged for YunoHost. 25 | 26 | 27 | **Shipped version:** 1.1.0~ynh3 28 | 29 | **Demo:** 30 | 31 | ## Screenshots 32 | 33 | ![Screenshot of Searx](./doc/screenshots/Screenshot.png) 34 | 35 | ## :red_circle: Antifeatures 36 | 37 | - **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. 38 | 39 | ## Documentation and resources 40 | 41 | - Official app website: 42 | - Official admin documentation: 43 | - Upstream app code repository: 44 | - YunoHost Store: 45 | - Report a bug: 46 | 47 | ## Developer info 48 | 49 | Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). 50 | 51 | To try the `testing` branch, please proceed like that: 52 | 53 | ```bash 54 | sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 55 | or 56 | sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 57 | ``` 58 | 59 | **More info regarding app packaging:** 60 | -------------------------------------------------------------------------------- /README_es.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Searx para Yunohost 7 | 8 | [![Nivel de integración](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) 9 | 10 | [![Instalar Searx con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) 11 | 12 | *[Leer este README en otros idiomas.](./ALL_README.md)* 13 | 14 | > *Este paquete le permite instalarSearx rapidamente y simplement en un servidor YunoHost.* 15 | > *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.* 16 | 17 | ## Descripción general 18 | 19 | Privacy-respecting, hackable metasearch engine. 20 | 21 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 22 | Installation is discouraged. 23 | 24 | SearXNG is a potential alternative, already packaged for YunoHost. 25 | 26 | 27 | **Versión actual:** 1.1.0~ynh3 28 | 29 | **Demo:** 30 | 31 | ## Capturas 32 | 33 | ![Captura de Searx](./doc/screenshots/Screenshot.png) 34 | 35 | ## :red_circle: Características no deseables 36 | 37 | - **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. 38 | 39 | ## Documentaciones y recursos 40 | 41 | - Sitio web oficial: 42 | - Documentación administrador oficial: 43 | - Repositorio del código fuente oficial de la aplicación : 44 | - Catálogo YunoHost: 45 | - Reportar un error: 46 | 47 | ## Información para desarrolladores 48 | 49 | Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/searx_ynh/tree/testing 50 | 51 | Para probar la rama `testing`, sigue asÍ: 52 | 53 | ```bash 54 | sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 55 | o 56 | sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 57 | ``` 58 | 59 | **Mas informaciones sobre el empaquetado de aplicaciones:** 60 | -------------------------------------------------------------------------------- /README_eu.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Searx YunoHost-erako 7 | 8 | [![Integrazio maila](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) 9 | 10 | [![Instalatu Searx YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) 11 | 12 | *[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* 13 | 14 | > *Pakete honek Searx YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* 15 | > *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* 16 | 17 | ## Aurreikuspena 18 | 19 | Privacy-respecting, hackable metasearch engine. 20 | 21 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 22 | Installation is discouraged. 23 | 24 | SearXNG is a potential alternative, already packaged for YunoHost. 25 | 26 | 27 | **Paketatutako bertsioa:** 1.1.0~ynh3 28 | 29 | **Demoa:** 30 | 31 | ## Pantaila-argazkiak 32 | 33 | ![Searx(r)en pantaila-argazkia](./doc/screenshots/Screenshot.png) 34 | 35 | ## :red_circle: Ezaugarri zalantzagarriak 36 | 37 | - **Jatorrizko garapena utzita**: Software honek ez du arduradunik. Denborak aurrera egin ahala funtzionatzeari utziko dio, konpondu gabeko segurtasun arazoak izango ditu, etab. 38 | 39 | ## Dokumentazioa eta baliabideak 40 | 41 | - Aplikazioaren webgune ofiziala: 42 | - Administratzaileen dokumentazio ofiziala: 43 | - Jatorrizko aplikazioaren kode-gordailua: 44 | - YunoHost Denda: 45 | - Eman errore baten berri: 46 | 47 | ## Garatzaileentzako informazioa 48 | 49 | Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). 50 | 51 | `testing` abarra probatzeko, ondorengoa egin: 52 | 53 | ```bash 54 | sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 55 | edo 56 | sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 57 | ``` 58 | 59 | **Informazio gehiago aplikazioaren paketatzeari buruz:** 60 | -------------------------------------------------------------------------------- /README_fr.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Searx pour YunoHost 7 | 8 | [![Niveau d’intégration](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) 9 | 10 | [![Installer Searx avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) 11 | 12 | *[Lire le README dans d'autres langues.](./ALL_README.md)* 13 | 14 | > *Ce package vous permet d’installer Searx rapidement et simplement sur un serveur YunoHost.* 15 | > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* 16 | 17 | ## Vue d’ensemble 18 | 19 | Privacy-respecting, hackable metasearch engine. 20 | 21 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 22 | Installation is discouraged. 23 | 24 | SearXNG is a potential alternative, already packaged for YunoHost. 25 | 26 | 27 | **Version incluse :** 1.1.0~ynh3 28 | 29 | **Démo :** 30 | 31 | ## Captures d’écran 32 | 33 | ![Capture d’écran de Searx](./doc/screenshots/Screenshot.png) 34 | 35 | ## :red_circle: Anti-fonctionnalités 36 | 37 | - **Application non maintenue **: Ce logiciel n'est plus maintenu. Attendez-vous à ce qu'il ne fonctionne plus avec le temps, et que l'on découvre des failles de sécurité qui ne seront pas corrigées, etc. 38 | 39 | ## Documentations et ressources 40 | 41 | - Site officiel de l’app : 42 | - Documentation officielle de l’admin : 43 | - Dépôt de code officiel de l’app : 44 | - YunoHost Store : 45 | - Signaler un bug : 46 | 47 | ## Informations pour les développeurs 48 | 49 | Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). 50 | 51 | Pour essayer la branche `testing`, procédez comme suit : 52 | 53 | ```bash 54 | sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 55 | ou 56 | sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 57 | ``` 58 | 59 | **Plus d’infos sur le packaging d’applications :** 60 | -------------------------------------------------------------------------------- /README_gl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Searx para YunoHost 7 | 8 | [![Nivel de integración](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) 9 | 10 | [![Instalar Searx con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) 11 | 12 | *[Le este README en outros idiomas.](./ALL_README.md)* 13 | 14 | > *Este paquete permíteche instalar Searx de xeito rápido e doado nun servidor YunoHost.* 15 | > *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* 16 | 17 | ## Vista xeral 18 | 19 | Privacy-respecting, hackable metasearch engine. 20 | 21 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 22 | Installation is discouraged. 23 | 24 | SearXNG is a potential alternative, already packaged for YunoHost. 25 | 26 | 27 | **Versión proporcionada:** 1.1.0~ynh3 28 | 29 | **Demo:** 30 | 31 | ## Capturas de pantalla 32 | 33 | ![Captura de pantalla de Searx](./doc/screenshots/Screenshot.png) 34 | 35 | ## :red_circle: Debes considerar 36 | 37 | - **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. 38 | 39 | ## Documentación e recursos 40 | 41 | - Web oficial da app: 42 | - Documentación oficial para admin: 43 | - Repositorio de orixe do código: 44 | - Tenda YunoHost: 45 | - Informar dun problema: 46 | 47 | ## Info de desenvolvemento 48 | 49 | Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). 50 | 51 | Para probar a rama `testing`, procede deste xeito: 52 | 53 | ```bash 54 | sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 55 | ou 56 | sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 57 | ``` 58 | 59 | **Máis info sobre o empaquetado da app:** 60 | -------------------------------------------------------------------------------- /README_it.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Searx per YunoHost 7 | 8 | [![Livello di integrazione](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) 9 | 10 | [![Installa Searx con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) 11 | 12 | *[Leggi questo README in altre lingue.](./ALL_README.md)* 13 | 14 | > *Questo pacchetto ti permette di installare Searx su un server YunoHost in modo semplice e veloce.* 15 | > *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* 16 | 17 | ## Panoramica 18 | 19 | Privacy-respecting, hackable metasearch engine. 20 | 21 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 22 | Installation is discouraged. 23 | 24 | SearXNG is a potential alternative, already packaged for YunoHost. 25 | 26 | 27 | **Versione pubblicata:** 1.1.0~ynh3 28 | 29 | **Prova:** 30 | 31 | ## Screenshot 32 | 33 | ![Screenshot di Searx](./doc/screenshots/Screenshot.png) 34 | 35 | ## :red_circle: Anti-funzionalità 36 | 37 | - **Applicazione non mantenuta**: Questo software non è più mantenuto. Ci si può aspettare che con il passare del tempo smetta di funzionare, sia esposto a falle di sicurezza, ecc. 38 | 39 | ## Documentazione e risorse 40 | 41 | - Sito web ufficiale dell’app: 42 | - Documentazione ufficiale per gli amministratori: 43 | - Repository upstream del codice dell’app: 44 | - Store di YunoHost: 45 | - Segnala un problema: 46 | 47 | ## Informazioni per sviluppatori 48 | 49 | Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). 50 | 51 | Per provare la branch di `testing`, si prega di procedere in questo modo: 52 | 53 | ```bash 54 | sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 55 | o 56 | sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 57 | ``` 58 | 59 | **Maggiori informazioni riguardo il pacchetto di quest’app:** 60 | -------------------------------------------------------------------------------- /README_zh_Hans.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # YunoHost 上的 Searx 7 | 8 | [![集成程度](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![工作状态](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) 9 | 10 | [![使用 YunoHost 安装 Searx](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) 11 | 12 | *[阅读此 README 的其它语言版本。](./ALL_README.md)* 13 | 14 | > *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Searx。* 15 | > *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* 16 | 17 | ## 概况 18 | 19 | Privacy-respecting, hackable metasearch engine. 20 | 21 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 22 | Installation is discouraged. 23 | 24 | SearXNG is a potential alternative, already packaged for YunoHost. 25 | 26 | 27 | **分发版本：** 1.1.0~ynh3 28 | 29 | **演示：** 30 | 31 | ## 截图 32 | 33 | ![Searx 的截图](./doc/screenshots/Screenshot.png) 34 | 35 | ## :red_circle: 负面特征 36 | 37 | - **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. 38 | 39 | ## 文档与资源 40 | 41 | - 官方应用网站： 42 | - 官方管理文档： 43 | - 上游应用代码库： 44 | - YunoHost 商店： 45 | - 报告 bug： 46 | 47 | ## 开发者信息 48 | 49 | 请向 [`testing` 分支](https://github.com/YunoHost-Apps/searx_ynh/tree/testing) 发送拉取请求。 50 | 51 | 如要尝试 `testing` 分支，请这样操作： 52 | 53 | ```bash 54 | sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 55 | 或 56 | sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 57 | ``` 58 | 59 | **有关应用打包的更多信息：** 60 | -------------------------------------------------------------------------------- /conf/nginx.conf: -------------------------------------------------------------------------------- 1 | #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; 2 | location __PATH__/ { 3 | 4 | uwsgi_param SCRIPT_NAME '__PATH_NO_ROOT__'; 5 | include uwsgi_params; 6 | uwsgi_modifier1 30; 7 | uwsgi_pass unix:///var/run/__NAME__/app.socket; 8 | 9 | #location __PATH__/searx/static/ { 10 | # alias __INSTALL_DIR__/searx/static/; 11 | #} 12 | 13 | # Include SSOWAT user panel. 14 | include conf.d/yunohost_panel.conf.inc; 15 | } 16 | -------------------------------------------------------------------------------- /conf/requirements-ynh.txt: -------------------------------------------------------------------------------- 1 | # Have a look to https://github.com/searx/searx/blob/master/requirements.txt 2 | certifi==2020.12.05 3 | babel==2.9.1 4 | flask-babel==2.0.0 5 | flask==1.1.4 6 | idna==2.10 7 | jinja2==2.11.3 8 | lxml==4.6.3 9 | pygments==2.8.0 10 | python-dateutil==2.8.1 11 | pyyaml==5.4.1 12 | requests[socks]==2.25.1 13 | langdetect==1.0.8 14 | # cryptography==3.2 15 | markupsafe==2.0.1 16 | 17 | # # Additionnals requirements 18 | # markupsafe>=0.23 19 | # ndg-httpsclient>=0.4.2 20 | # pyasn1>=0.2.3 21 | # pyasn1-modules>=0.0.9 22 | ## cffi>=1.12.1 23 | -------------------------------------------------------------------------------- /conf/settings.yml: -------------------------------------------------------------------------------- 1 | general: 2 | debug : False # Debug mode, only for development 3 | instance_name : "YunoSearx" # displayed name 4 | contact_url: False # mailto:contact@example.com 5 | 6 | brand: 7 | git_url: https://github.com/searx/searx 8 | git_branch: master 9 | issue_url: https://github.com/searx/searx/issues 10 | docs_url: https://searx.github.io/searx 11 | public_instances: https://searx.space 12 | wiki_url: https://github.com/searx/searx/wiki 13 | twitter_url: https://twitter.com/Searx_engine 14 | 15 | search: 16 | safe_search : 0 # Filter results. 0: None, 1: Moderate, 2: Strict 17 | autocomplete : "" # Existing autocomplete backends: "dbpedia", "duckduckgo", "google", "startpage", "swisscows", "qwant", "wikipedia" - leave blank to turn it off by default 18 | default_lang : "" # Default search language - leave blank to detect from browser information or use codes from 'languages.py' 19 | ban_time_on_fail : 5 # ban time in seconds after engine errors 20 | max_ban_time_on_fail : 120 # max ban time in seconds after engine errors 21 | 22 | server: 23 | port : 8888 24 | bind_address : "127.0.0.1" # address to listen on 25 | secret_key : "__SECRET_KEY__" # change this! 26 | base_url : False # Set custom base_url. Possible values: False or "https://your.custom.host/location/" 27 | image_proxy : False # Proxying image results through searx 28 | http_protocol_version : "1.0" # 1.0 and 1.1 are supported 29 | method: "POST" # POST queries are more secure as they don't show up in history but may cause problems when using Firefox containers 30 | default_http_headers: 31 | X-Content-Type-Options : nosniff 32 | X-XSS-Protection : 1; mode=block 33 | X-Download-Options : noopen 34 | X-Robots-Tag : noindex, nofollow 35 | Referrer-Policy : no-referrer 36 | 37 | ui: 38 | static_path : "" # Custom static path - leave it blank if you didn't change 39 | templates_path : "" # Custom templates path - leave it blank if you didn't change 40 | default_theme : oscar # ui theme 41 | default_locale : "" # Default interface locale - leave blank to detect from browser information or use codes from the 'locales' config section 42 | theme_args : 43 | oscar_style : logicodev # default style of oscar 44 | # results_on_new_tab: False # Open result links in a new tab by default 45 | # categories_order : 46 | # - general 47 | # - files 48 | # - map 49 | # - it 50 | # - science 51 | 52 | # Lock arbitrary settings on the preferences page. 53 | # To find the ID of the user setting you want to lock, check 54 | # the ID of the form on the page "preferences". 55 | #preferences: 56 | # lock: 57 | # - language 58 | # - autocomplete 59 | # - method 60 | 61 | # searx supports result proxification using an external service: https://github.com/asciimoo/morty 62 | # uncomment below section if you have running morty proxy 63 | # the key is base64 encoded (keep the !!binary notation) 64 | # Note: since commit af77ec3, morty accepts a base64 encoded key. 65 | #result_proxy: 66 | # url : http://127.0.0.1:3000/ 67 | # key : !!binary "your_morty_proxy_key" 68 | 69 | outgoing: # communication with search engines 70 | request_timeout : 2.0 # default timeout in seconds, can be override by engine 71 | # max_request_timeout: 10.0 # the maximum timeout in seconds 72 | useragent_suffix : "" # suffix of searx_useragent, could contain informations like an email address to the administrator 73 | pool_connections : 100 # Number of different hosts 74 | pool_maxsize : 10 # Number of simultaneous requests by host 75 | # uncomment below section if you want to use a proxy 76 | # see https://2.python-requests.org/en/latest/user/advanced/#proxies 77 | # SOCKS proxies are also supported: see https://2.python-requests.org/en/latest/user/advanced/#socks 78 | # proxies: 79 | # http: 80 | # - http://proxy1:8080 81 | # - http://proxy2:8080 82 | # https: 83 | # - http://proxy1:8080 84 | # - http://proxy2:8080 85 | # using_tor_proxy : True 86 | # extra_proxy_timeout : 10.0 # Extra seconds to add in order to account for the time taken by the proxy 87 | # uncomment below section only if you have more than one network interface 88 | # which can be the source of outgoing search requests 89 | # source_ips: 90 | # - 1.1.1.1 91 | # - 1.1.1.2 92 | 93 | # External plugin configuration 94 | # See http://searx.github.io/searx/dev/plugins.html for more details 95 | # 96 | # plugins: 97 | # - plugin1 98 | # - plugin2 99 | # - ... 100 | 101 | # uncomment below section if you want to configure which plugin is enabled by default 102 | # 103 | # enabled_plugins: 104 | # - "HTTPS rewrite" 105 | # - ... 106 | 107 | # Example to rewrite hostnames in external links 108 | # 109 | # enabled_plugins: 110 | # - 'Hostname replace' 111 | # hostname_replace: 112 | # '(.*\.)?youtube\.com$': 'invidious.example.com' 113 | # '(.*\.)?youtu\.be$': 'invidious.example.com' 114 | # '(.*\.)?youtube-noocookie\.com$': 'yotter.example.com' 115 | # '(.*\.)?reddit\.com$': 'teddit.example.com' 116 | # '(.*\.)?redd\.it$': 'teddit.example.com' 117 | # '(www\.)?twitter\.com$': 'nitter.example.com' 118 | 119 | checker: 120 | # disable checker when in debug mode 121 | off_when_debug: True 122 | 123 | # scheduling: interval or int 124 | # use "scheduling: False" to disable scheduling 125 | # to activate the scheduler: 126 | # * uncomment "scheduling" section 127 | # * add "cache2 = name=searxcache,items=2000,blocks=2000,blocksize=4096,bitmap=1" to your uwsgi.ini 128 | 129 | # scheduling: 130 | # start_after: [300, 1800] # delay to start the first run of the checker 131 | # every: [86400, 90000] # how often the checker runs 132 | 133 | # additional tests: only for the YAML anchors (see the engines section) 134 | 135 | additional_tests: 136 | rosebud: &test_rosebud 137 | matrix: 138 | query: rosebud 139 | lang: en 140 | result_container: 141 | - not_empty 142 | - ['one_title_contains', 'citizen kane'] 143 | test: 144 | - unique_results 145 | 146 | android: &test_android 147 | matrix: 148 | query: ['android'] 149 | lang: ['en', 'de', 'fr', 'zh-CN'] 150 | result_container: 151 | - not_empty 152 | - ['one_title_contains', 'google'] 153 | test: 154 | - unique_results 155 | 156 | # tests: only for the YAML anchors (see the engines section) 157 | tests: 158 | infobox: &tests_infobox 159 | infobox: 160 | matrix: 161 | query: ["linux", "new york", "bbc"] 162 | result_container: 163 | - has_infobox 164 | 165 | engines: 166 | - name: apk mirror 167 | engine: apkmirror 168 | timeout: 4.0 169 | shortcut: apkm 170 | disabled: True 171 | 172 | # Requires Tor 173 | - name : ahmia 174 | engine : ahmia 175 | categories : onions 176 | enable_http : True 177 | shortcut : ah 178 | 179 | - name : arch linux wiki 180 | engine : archlinux 181 | shortcut : al 182 | 183 | - name : archive is 184 | engine : xpath 185 | search_url : https://archive.is/{query} 186 | url_xpath : (//div[@class="TEXT-BLOCK"]/a)/@href 187 | title_xpath : (//div[@class="TEXT-BLOCK"]/a) 188 | content_xpath : //div[@class="TEXT-BLOCK"]/ul/li 189 | categories : general 190 | timeout : 7.0 191 | disabled : True 192 | shortcut : ai 193 | about: 194 | website: https://archive.is/ 195 | wikidata_id: Q13515725 196 | official_api_documentation: http://mementoweb.org/depot/native/archiveis/ 197 | use_official_api: false 198 | require_api_key: false 199 | results: HTML 200 | 201 | - name : arxiv 202 | engine : arxiv 203 | shortcut : arx 204 | categories : science 205 | timeout : 4.0 206 | 207 | # tmp suspended: dh key too small 208 | # - name : base 209 | # engine : base 210 | # shortcut : bs 211 | 212 | - name: bandcamp 213 | engine: bandcamp 214 | shortcut: bc 215 | categories: music 216 | 217 | - name : wikipedia 218 | engine : wikipedia 219 | shortcut : wp 220 | base_url : 'https://{language}.wikipedia.org/' 221 | 222 | - name : bing 223 | engine : bing 224 | shortcut : bi 225 | 226 | - name : bing images 227 | engine : bing_images 228 | shortcut : bii 229 | 230 | - name : bing news 231 | engine : bing_news 232 | shortcut : bin 233 | 234 | - name : bing videos 235 | engine : bing_videos 236 | shortcut : biv 237 | 238 | - name : bitbucket 239 | engine : xpath 240 | paging : True 241 | search_url : https://bitbucket.org/repo/all/{pageno}?name={query} 242 | url_xpath : //article[@class="repo-summary"]//a[@class="repo-link"]/@href 243 | title_xpath : //article[@class="repo-summary"]//a[@class="repo-link"] 244 | content_xpath : //article[@class="repo-summary"]/p 245 | categories : it 246 | timeout : 4.0 247 | disabled : True 248 | shortcut : bb 249 | about: 250 | website: https://bitbucket.org/ 251 | wikidata_id: Q2493781 252 | official_api_documentation: https://developer.atlassian.com/bitbucket 253 | use_official_api: false 254 | require_api_key: false 255 | results: HTML 256 | 257 | - name : btdigg 258 | engine : btdigg 259 | shortcut : bt 260 | 261 | - name : ccc-tv 262 | engine : xpath 263 | paging : False 264 | search_url : https://media.ccc.de/search/?q={query} 265 | url_xpath : //div[@class="caption"]/h3/a/@href 266 | title_xpath : //div[@class="caption"]/h3/a/text() 267 | content_xpath : //div[@class="caption"]/h4/@title 268 | categories : videos 269 | disabled : True 270 | shortcut : c3tv 271 | about: 272 | website: https://media.ccc.de/ 273 | wikidata_id: Q80729951 274 | official_api_documentation: https://github.com/voc/voctoweb 275 | use_official_api: false 276 | require_api_key: false 277 | results: HTML 278 | 279 | - name : ccengine 280 | engine : ccengine 281 | categories : images 282 | shortcut : cce 283 | 284 | # - name : core.ac.uk 285 | # engine : core 286 | # categories : science 287 | # shortcut : cor 288 | # # get your API key from: https://core.ac.uk/api-keys/register/ 289 | # api_key : 'unset' 290 | 291 | - name : crossref 292 | engine : json_engine 293 | paging : True 294 | search_url : https://search.crossref.org/dois?q={query}&page={pageno} 295 | url_query : doi 296 | title_query : title 297 | title_html_to_text: True 298 | content_query : fullCitation 299 | content_html_to_text: True 300 | categories : science 301 | shortcut : cr 302 | about: 303 | website: https://www.crossref.org/ 304 | wikidata_id: Q5188229 305 | official_api_documentation: https://github.com/CrossRef/rest-api-doc 306 | use_official_api: false 307 | require_api_key: false 308 | results: JSON 309 | 310 | - name : currency 311 | engine : currency_convert 312 | categories : general 313 | shortcut : cc 314 | 315 | - name : deezer 316 | engine : deezer 317 | shortcut : dz 318 | 319 | - name : deviantart 320 | engine : deviantart 321 | shortcut : da 322 | timeout : 3.0 323 | 324 | - name : ddg definitions 325 | engine : duckduckgo_definitions 326 | shortcut : ddd 327 | weight : 2 328 | disabled : True 329 | tests: *tests_infobox 330 | 331 | # cloudflare protected 332 | # - name : digbt 333 | # engine : digbt 334 | # shortcut : dbt 335 | # timeout : 6.0 336 | # disabled : True 337 | 338 | - name : digg 339 | engine : digg 340 | shortcut : dg 341 | 342 | - name : erowid 343 | engine : xpath 344 | paging : True 345 | first_page_num : 0 346 | page_size : 30 347 | search_url : https://www.erowid.org/search.php?q={query}&s={pageno} 348 | url_xpath : //dl[@class="results-list"]/dt[@class="result-title"]/a/@href 349 | title_xpath : //dl[@class="results-list"]/dt[@class="result-title"]/a/text() 350 | content_xpath : //dl[@class="results-list"]/dd[@class="result-details"] 351 | categories : general 352 | shortcut : ew 353 | disabled : True 354 | about: 355 | website: https://www.erowid.org/ 356 | wikidata_id: Q1430691 357 | official_api_documentation: 358 | use_official_api: false 359 | require_api_key: false 360 | results: HTML 361 | 362 | # - name : elasticsearch 363 | # shortcut : es 364 | # engine : elasticsearch 365 | # base_url : http://localhost:9200 366 | # username : elastic 367 | # password : changeme 368 | # index : my-index 369 | # # available options: match, simple_query_string, term, terms, custom 370 | # query_type : match 371 | # # if query_type is set to custom, provide your query here 372 | # #custom_query_json: {"query":{"match_all": {}}} 373 | # #show_metadata: False 374 | # disabled : True 375 | 376 | - name : wikidata 377 | engine : wikidata 378 | shortcut : wd 379 | timeout : 3.0 380 | weight : 2 381 | tests: *tests_infobox 382 | 383 | - name : duckduckgo 384 | engine : duckduckgo 385 | shortcut : ddg 386 | disabled : True 387 | 388 | - name : duckduckgo images 389 | engine : duckduckgo_images 390 | shortcut : ddi 391 | timeout: 3.0 392 | disabled : True 393 | 394 | - name : etools 395 | engine : etools 396 | shortcut : eto 397 | disabled : True 398 | additional_tests: 399 | rosebud: *test_rosebud 400 | 401 | - name : etymonline 402 | engine : xpath 403 | paging : True 404 | search_url : https://etymonline.com/search?page={pageno}&q={query} 405 | url_xpath : //a[contains(@class, "word__name--")]/@href 406 | title_xpath : //a[contains(@class, "word__name--")] 407 | content_xpath : //section[contains(@class, "word__defination")] 408 | first_page_num : 1 409 | shortcut : et 410 | disabled : True 411 | about: 412 | website: https://www.etymonline.com/ 413 | wikidata_id: Q1188617 414 | official_api_documentation: 415 | use_official_api: false 416 | require_api_key: false 417 | results: HTML 418 | 419 | # - name : ebay 420 | # engine : ebay 421 | # shortcut : eb 422 | # disabled : True 423 | # timeout: 5 424 | 425 | - name : 1x 426 | engine : www1x 427 | shortcut : 1x 428 | timeout : 3.0 429 | disabled : True 430 | 431 | - name : fdroid 432 | engine : fdroid 433 | shortcut : fd 434 | disabled : True 435 | 436 | - name : flickr 437 | categories : images 438 | shortcut : fl 439 | # You can use the engine using the official stable API, but you need an API key 440 | # See : https://www.flickr.com/services/apps/create/ 441 | # engine : flickr 442 | # api_key: 'apikey' # required! 443 | # Or you can use the html non-stable engine, activated by default 444 | engine : flickr_noapi 445 | 446 | - name : free software directory 447 | engine : mediawiki 448 | shortcut : fsd 449 | categories : it 450 | base_url : https://directory.fsf.org/ 451 | number_of_results : 5 452 | # what part of a page matches the query string: title, text, nearmatch 453 | # title - query matches title, text - query matches the text of page, nearmatch - nearmatch in title 454 | search_type : title 455 | timeout : 5.0 456 | disabled : True 457 | about: 458 | website: https://directory.fsf.org/ 459 | wikidata_id: Q2470288 460 | 461 | # - name : freesound 462 | # engine : freesound 463 | # shortcut : fnd 464 | # disabled : True 465 | # timeout : 15.0 466 | # api_key : MyAPIkey 467 | # API key required, see : https://freesound.org/docs/api/overview.html 468 | 469 | - name : frinkiac 470 | engine : frinkiac 471 | shortcut : frk 472 | disabled : True 473 | 474 | - name : genius 475 | engine : genius 476 | shortcut : gen 477 | 478 | - name : gigablast 479 | engine : gigablast 480 | shortcut : gb 481 | timeout : 3.0 482 | disabled: True 483 | additional_tests: 484 | rosebud: *test_rosebud 485 | 486 | - name : gentoo 487 | engine : gentoo 488 | shortcut : ge 489 | 490 | - name : gitlab 491 | engine : json_engine 492 | paging : True 493 | search_url : https://gitlab.com/api/v4/projects?search={query}&page={pageno} 494 | url_query : web_url 495 | title_query : name_with_namespace 496 | content_query : description 497 | page_size : 20 498 | categories : it 499 | shortcut : gl 500 | timeout : 10.0 501 | disabled : True 502 | about: 503 | website: https://about.gitlab.com/ 504 | wikidata_id: Q16639197 505 | official_api_documentation: https://docs.gitlab.com/ee/api/ 506 | use_official_api: false 507 | require_api_key: false 508 | results: JSON 509 | 510 | - name : github 511 | engine : github 512 | shortcut : gh 513 | 514 | # This a Gitea service. If you would like to use a different instance, 515 | # change codeberg.org to URL of the desired Gitea host. Or you can create 516 | # a new engine by copying this and changing the name, shortcut and search_url. 517 | - name : codeberg 518 | engine : json_engine 519 | search_url : https://codeberg.org/api/v1/repos/search?q={query}&limit=10 520 | url_query : html_url 521 | title_query : name 522 | content_query : description 523 | categories : it 524 | shortcut : cb 525 | disabled : True 526 | about: 527 | website: https://codeberg.org/ 528 | wikidata_id: 529 | official_api_documentation: https://try.gitea.io/api/swagger 530 | use_official_api: false 531 | require_api_key: false 532 | results: JSON 533 | 534 | - name : google 535 | engine : google 536 | shortcut : go 537 | # additional_tests: 538 | # android: *test_android 539 | 540 | - name : google images 541 | engine : google_images 542 | shortcut : goi 543 | # additional_tests: 544 | # android: *test_android 545 | # dali: 546 | # matrix: 547 | # query: ['Dali Christ'] 548 | # lang: ['en', 'de', 'fr', 'zh-CN'] 549 | # result_container: 550 | # - ['one_title_contains', 'Salvador'] 551 | 552 | - name : google news 553 | engine : google_news 554 | shortcut : gon 555 | # additional_tests: 556 | # android: *test_android 557 | 558 | - name : google videos 559 | engine : google_videos 560 | shortcut : gov 561 | # additional_tests: 562 | # android: *test_android 563 | 564 | - name : google scholar 565 | engine : google_scholar 566 | shortcut : gos 567 | 568 | - name : google play apps 569 | engine : xpath 570 | search_url : https://play.google.com/store/search?q={query}&c=apps 571 | results_xpath : '//div[@class="ImZGtf mpg5gc"]' 572 | title_xpath : './/div[@class="RZEgze"]//div[@class="kCSSQe"]//a' 573 | url_xpath : './/div[@class="RZEgze"]//div[@class="kCSSQe"]//a/@href' 574 | content_xpath : './/div[@class="RZEgze"]//a[@class="mnKHRc"]' 575 | thumbnail_xpath : './/div[@class="uzcko"]/div/span[1]//img/@data-src' 576 | categories : files 577 | shortcut : gpa 578 | disabled : True 579 | about: 580 | website: https://play.google.com/ 581 | wikidata_id: Q79576 582 | official_api_documentation: 583 | use_official_api: false 584 | require_api_key: false 585 | results: HTML 586 | 587 | - name : google play movies 588 | engine : xpath 589 | search_url : https://play.google.com/store/search?q={query}&c=movies 590 | results_xpath : '//div[@class="ImZGtf mpg5gc"]' 591 | title_xpath : './/div[@class="RZEgze"]//div[@class="kCSSQe"]//a' 592 | url_xpath : './/div[@class="RZEgze"]//div[@class="kCSSQe"]//a/@href' 593 | content_xpath : './/div[@class="kCSSQe"]' 594 | thumbnail_xpath : './/div[@class="uzcko"]/div/span[1]//img/@data-src' 595 | categories : videos 596 | shortcut : gpm 597 | disabled : True 598 | about: 599 | website: https://play.google.com/ 600 | wikidata_id: Q79576 601 | official_api_documentation: 602 | use_official_api: false 603 | require_api_key: false 604 | results: HTML 605 | 606 | - name : geektimes 607 | engine : xpath 608 | paging : True 609 | search_url : https://habr.com/en/search/page{pageno}/?q={query} 610 | url_xpath : //article[contains(@class, "post")]//a[@class="post__title_link"]/@href 611 | title_xpath : //article[contains(@class, "post")]//a[@class="post__title_link"] 612 | content_xpath : //article[contains(@class, "post")]//div[contains(@class, "post__text")] 613 | categories : it 614 | timeout : 4.0 615 | disabled : True 616 | shortcut : gt 617 | about: 618 | website: https://geektimes.ru/ 619 | wikidata_id: Q50572423 620 | official_api_documentation: 621 | use_official_api: false 622 | require_api_key: false 623 | results: HTML 624 | 625 | - name : habrahabr 626 | engine : xpath 627 | paging : True 628 | search_url : https://habrahabr.ru/search/page{pageno}/?q={query} 629 | url_xpath : //article[contains(@class, "post")]//a[@class="post__title_link"]/@href 630 | title_xpath : //article[contains(@class, "post")]//a[@class="post__title_link"] 631 | content_xpath : //article[contains(@class, "post")]//div[contains(@class, "post__text")] 632 | categories : it 633 | timeout : 4.0 634 | disabled : True 635 | shortcut : habr 636 | about: 637 | website: https://habr.com/ 638 | wikidata_id: Q4494434 639 | official_api_documentation: https://habr.com/en/docs/help/api/ 640 | use_official_api: false 641 | require_api_key: false 642 | results: HTML 643 | 644 | - name : hoogle 645 | engine : xpath 646 | paging : True 647 | search_url : https://hoogle.haskell.org/?hoogle={query}&start={pageno} 648 | results_xpath : '//div[@class="result"]' 649 | title_xpath : './/div[@class="ans"]//a' 650 | url_xpath : './/div[@class="ans"]//a/@href' 651 | content_xpath : './/div[@class="from"]' 652 | page_size : 20 653 | categories : it 654 | shortcut : ho 655 | about: 656 | website: https://www.haskell.org/ 657 | wikidata_id: Q34010 658 | official_api_documentation: https://hackage.haskell.org/api 659 | use_official_api: false 660 | require_api_key: false 661 | results: JSON 662 | 663 | - name : ina 664 | engine : ina 665 | shortcut : in 666 | timeout : 6.0 667 | disabled : True 668 | 669 | - name : invidious 670 | engine : invidious 671 | base_url : 672 | - https://invidious.tube/ 673 | - https://invidious.snopyta.org/ 674 | shortcut: iv 675 | timeout : 5.0 676 | disabled : True 677 | 678 | - name: kickass 679 | engine : kickass 680 | shortcut : kc 681 | timeout : 4.0 682 | disabled : True 683 | 684 | - name : library genesis 685 | engine : xpath 686 | enable_http: True 687 | search_url : http://libgen.rs/search.php?req={query} 688 | url_xpath : //a[contains(@href,"bookfi.net/md5")]/@href 689 | title_xpath : //a[contains(@href,"book/")]/text()[1] 690 | content_xpath : //td/a[1][contains(@href,"=author")]/text() 691 | categories : general 692 | timeout : 7.0 693 | disabled : True 694 | shortcut : lg 695 | about: 696 | website: http://libgen.rs/ 697 | wikidata_id: Q22017206 698 | official_api_documentation: 699 | use_official_api: false 700 | require_api_key: false 701 | results: HTML 702 | 703 | - name : library of congress 704 | engine : loc 705 | shortcut : loc 706 | categories : images 707 | 708 | - name : lobste.rs 709 | engine : xpath 710 | search_url : https://lobste.rs/search?utf8=%E2%9C%93&q={query}&what=stories&order=relevance 711 | results_xpath : //li[contains(@class, "story")] 712 | url_xpath : .//a[@class="u-url"]/@href 713 | title_xpath : .//a[@class="u-url"] 714 | content_xpath : .//a[@class="domain"] 715 | categories : it 716 | shortcut : lo 717 | timeout : 5.0 718 | disabled: True 719 | about: 720 | website: https://lobste.rs/ 721 | wikidata_id: Q60762874 722 | official_api_documentation: 723 | use_official_api: false 724 | require_api_key: false 725 | results: HTML 726 | 727 | # - name : meilisearch 728 | # engine : meilisearch 729 | # shortcut: mes 730 | # enable_http: True 731 | # base_url : http://localhost:7700 732 | # index : my-index 733 | 734 | - name : microsoft academic 735 | engine : microsoft_academic 736 | categories : science 737 | shortcut : ma 738 | 739 | - name : mixcloud 740 | engine : mixcloud 741 | shortcut : mc 742 | 743 | - name : npm 744 | engine : json_engine 745 | paging : True 746 | search_url : https://api.npms.io/v2/search?q={query}&size=25&from={pageno} 747 | results_query : results 748 | url_query : package/links/npm 749 | title_query : package/name 750 | content_query : package/description 751 | page_size : 25 752 | categories : it 753 | disabled: True 754 | timeout: 5.0 755 | shortcut : npm 756 | about: 757 | website: https://npms.io/ 758 | wikidata_id: Q7067518 759 | official_api_documentation: https://api-docs.npms.io/ 760 | use_official_api: false 761 | require_api_key: false 762 | results: JSON 763 | 764 | # Requires Tor 765 | - name : not evil 766 | engine : not_evil 767 | categories : onions 768 | enable_http : True 769 | shortcut : ne 770 | 771 | - name : nyaa 772 | engine : nyaa 773 | shortcut : nt 774 | disabled : True 775 | 776 | - name : openairedatasets 777 | engine : json_engine 778 | paging : True 779 | search_url : https://api.openaire.eu/search/datasets?format=json&page={pageno}&size=10&title={query} 780 | results_query : response/results/result 781 | url_query : metadata/oaf:entity/oaf:result/children/instance/webresource/url/$ 782 | title_query : metadata/oaf:entity/oaf:result/title/$ 783 | content_query : metadata/oaf:entity/oaf:result/description/$ 784 | content_html_to_text: True 785 | categories : science 786 | shortcut : oad 787 | timeout: 5.0 788 | about: 789 | website: https://www.openaire.eu/ 790 | wikidata_id: Q25106053 791 | official_api_documentation: https://api.openaire.eu/ 792 | use_official_api: false 793 | require_api_key: false 794 | results: JSON 795 | 796 | - name : openairepublications 797 | engine : json_engine 798 | paging : True 799 | search_url : https://api.openaire.eu/search/publications?format=json&page={pageno}&size=10&title={query} 800 | results_query : response/results/result 801 | url_query : metadata/oaf:entity/oaf:result/children/instance/webresource/url/$ 802 | title_query : metadata/oaf:entity/oaf:result/title/$ 803 | content_query : metadata/oaf:entity/oaf:result/description/$ 804 | content_html_to_text: True 805 | categories : science 806 | shortcut : oap 807 | timeout: 5.0 808 | about: 809 | website: https://www.openaire.eu/ 810 | wikidata_id: Q25106053 811 | official_api_documentation: https://api.openaire.eu/ 812 | use_official_api: false 813 | require_api_key: false 814 | results: JSON 815 | 816 | # - name : opensemanticsearch 817 | # engine : opensemantic 818 | # shortcut : oss 819 | # base_url : 'http://localhost:8983/solr/opensemanticsearch/' 820 | 821 | - name : openstreetmap 822 | engine : openstreetmap 823 | shortcut : osm 824 | 825 | - name : openrepos 826 | engine : xpath 827 | paging : True 828 | search_url : https://openrepos.net/search/node/{query}?page={pageno} 829 | url_xpath : //li[@class="search-result"]//h3[@class="title"]/a/@href 830 | title_xpath : //li[@class="search-result"]//h3[@class="title"]/a 831 | content_xpath : //li[@class="search-result"]//div[@class="search-snippet-info"]//p[@class="search-snippet"] 832 | categories : files 833 | timeout : 4.0 834 | disabled : True 835 | shortcut : or 836 | about: 837 | website: https://openrepos.net/ 838 | wikidata_id: 839 | official_api_documentation: 840 | use_official_api: false 841 | require_api_key: false 842 | results: HTML 843 | 844 | - name : pdbe 845 | engine : pdbe 846 | shortcut : pdb 847 | # Hide obsolete PDB entries. 848 | # Default is not to hide obsolete structures 849 | # hide_obsolete : False 850 | 851 | - name : photon 852 | engine : photon 853 | shortcut : ph 854 | 855 | - name : piratebay 856 | engine : piratebay 857 | shortcut : tpb 858 | # You may need to change this URL to a proxy if piratebay is blocked in your country 859 | url: https://thepiratebay.org/ 860 | timeout : 3.0 861 | 862 | # Required dependency: psychopg2 863 | # - name : postgresql 864 | # engine : postgresql 865 | # database : postgres 866 | # username : postgres 867 | # password : postgres 868 | # limit : 10 869 | # query_str : 'SELECT * from my_table WHERE my_column = %(query)s' 870 | # shortcut : psql 871 | 872 | - name : pubmed 873 | engine : pubmed 874 | shortcut : pub 875 | categories: science 876 | timeout : 3.0 877 | 878 | - name : qwant 879 | engine : qwant 880 | shortcut : qw 881 | categories : general 882 | disabled : True 883 | additional_tests: 884 | rosebud: *test_rosebud 885 | 886 | - name : qwant images 887 | engine : qwant 888 | shortcut : qwi 889 | categories : images 890 | 891 | - name : qwant news 892 | engine : qwant 893 | shortcut : qwn 894 | categories : news 895 | 896 | # - name: library 897 | # engine: recoll 898 | # shortcut: lib 899 | # base_url: 'https://recoll.example.org/' 900 | # search_dir: '' 901 | # mount_prefix: /export 902 | # dl_prefix: 'https://download.example.org' 903 | # timeout: 30.0 904 | # categories: files 905 | # disabled: True 906 | 907 | # - name: recoll library reference 908 | # engine: recoll 909 | # base_url: 'https://recoll.example.org/' 910 | # search_dir: reference 911 | # mount_prefix: /export 912 | # dl_prefix: 'https://download.example.org' 913 | # shortcut: libr 914 | # timeout: 30.0 915 | # categories: files 916 | # disabled: True 917 | 918 | - name : reddit 919 | engine : reddit 920 | shortcut : re 921 | page_size : 25 922 | timeout : 10.0 923 | disabled : True 924 | 925 | # tmp suspended: bad certificate 926 | # - name : scanr structures 927 | # shortcut: scs 928 | # engine : scanr_structures 929 | # disabled : True 930 | 931 | - name: sepiasearch 932 | engine: sepiasearch 933 | shortcut: sep 934 | 935 | - name : soundcloud 936 | engine : soundcloud 937 | shortcut : sc 938 | 939 | - name : stackoverflow 940 | engine : stackoverflow 941 | shortcut : st 942 | 943 | - name : searchcode code 944 | engine : searchcode_code 945 | shortcut : scc 946 | disabled : True 947 | 948 | - name : framalibre 949 | engine : framalibre 950 | shortcut : frl 951 | disabled : True 952 | 953 | # - name : searx 954 | # engine : searx_engine 955 | # shortcut : se 956 | # instance_urls : 957 | # - http://127.0.0.1:8888/ 958 | # - ... 959 | # disabled : True 960 | 961 | - name : semantic scholar 962 | engine : semantic_scholar 963 | disabled : True 964 | shortcut : se 965 | categories : science 966 | about: 967 | website: https://www.semanticscholar.org/ 968 | wikidata_id: Q22908627 969 | official_api_documentation: https://api.semanticscholar.org/ 970 | use_official_api: false 971 | require_api_key: false 972 | results: JSON 973 | 974 | # Spotify needs API credentials 975 | # - name : spotify 976 | # engine : spotify 977 | # shortcut : stf 978 | # api_client_id : ******* 979 | # api_client_secret : ******* 980 | 981 | # - name : solr 982 | # engine : solr 983 | # shortcut : slr 984 | # base_url : http://localhost:8983 985 | # collection : collection_name 986 | # sort : '' # sorting: asc or desc 987 | # field_list : '' # comma separated list of field names to display on the UI 988 | # default_fields : '' # default field to query 989 | # query_fields : '' # query fields 990 | # enable_http : True 991 | 992 | # - name : springer nature 993 | # engine : springer 994 | # # get your API key from: https://dev.springernature.com/signup 995 | # api_key : 'unset' # working API key, for test & debug: "a69685087d07eca9f13db62f65b8f601" 996 | # disabled: True 997 | # shortcut : springer 998 | # categories : science 999 | # timeout : 6.0 1000 | 1001 | - name : startpage 1002 | engine : startpage 1003 | shortcut : sp 1004 | timeout : 6.0 1005 | disabled : True 1006 | additional_tests: 1007 | rosebud: *test_rosebud 1008 | 1009 | - name : tokyotoshokan 1010 | engine : tokyotoshokan 1011 | shortcut : tt 1012 | timeout : 6.0 1013 | disabled : True 1014 | 1015 | - name : solidtorrents 1016 | engine : solidtorrents 1017 | shortcut : solid 1018 | timeout : 3.0 1019 | disabled : True 1020 | 1021 | - name : torrentz 1022 | engine : torrentz 1023 | shortcut : tor 1024 | url: https://torrentz2.eu/ 1025 | timeout : 3.0 1026 | 1027 | # Requires Tor 1028 | - name : torch 1029 | engine : xpath 1030 | paging : True 1031 | search_url : http://xmh57jrknzkhv6y3ls3ubitzfqnkrwxhopf5aygthi7d6rplyvk3noyd.onion/cgi-bin/omega/omega?P={query}&DEFAULTOP=and 1032 | results_xpath : //table//tr 1033 | url_xpath : ./td[2]/a 1034 | title_xpath : ./td[2]/b 1035 | content_xpath : ./td[2]/small 1036 | categories : onions 1037 | enable_http : True 1038 | shortcut : tch 1039 | 1040 | # maybe in a fun category 1041 | # - name : uncyclopedia 1042 | # engine : mediawiki 1043 | # shortcut : unc 1044 | # base_url : https://uncyclopedia.wikia.com/ 1045 | # number_of_results : 5 1046 | 1047 | # tmp suspended - too slow, too many errors 1048 | # - name : urbandictionary 1049 | # engine : xpath 1050 | # search_url : http://www.urbandictionary.com/define.php?term={query} 1051 | # url_xpath : //*[@class="word"]/@href 1052 | # title_xpath : //*[@class="def-header"] 1053 | # content_xpath : //*[@class="meaning"] 1054 | # shortcut : ud 1055 | 1056 | - name : unsplash 1057 | engine : unsplash 1058 | disabled: True 1059 | shortcut : us 1060 | 1061 | - name : yahoo 1062 | engine : yahoo 1063 | shortcut : yh 1064 | disabled : True 1065 | 1066 | - name : yahoo news 1067 | engine : yahoo_news 1068 | shortcut : yhn 1069 | 1070 | - name : youtube 1071 | shortcut : yt 1072 | # You can use the engine using the official stable API, but you need an API key 1073 | # See : https://console.developers.google.com/project 1074 | # engine : youtube_api 1075 | # api_key: 'apikey' # required! 1076 | # Or you can use the html non-stable engine, activated by default 1077 | engine : youtube_noapi 1078 | 1079 | - name : yggtorrent 1080 | engine : yggtorrent 1081 | shortcut : ygg 1082 | url: https://www4.yggtorrent.li/ 1083 | disabled : True 1084 | timeout : 4.0 1085 | 1086 | - name : dailymotion 1087 | engine : dailymotion 1088 | shortcut : dm 1089 | 1090 | - name : vimeo 1091 | engine : vimeo 1092 | shortcut : vm 1093 | 1094 | - name : wiby 1095 | engine : json_engine 1096 | search_url : https://wiby.me/json/?q={query} 1097 | url_query : URL 1098 | title_query : Title 1099 | content_query : Snippet 1100 | categories : general 1101 | shortcut : wib 1102 | disabled : True 1103 | 1104 | - name : wikibooks 1105 | engine : mediawiki 1106 | shortcut : wb 1107 | categories : general 1108 | base_url : "https://{language}.wikibooks.org/" 1109 | number_of_results : 5 1110 | search_type : text 1111 | disabled : True 1112 | about: 1113 | website: https://www.wikibooks.org/ 1114 | wikidata_id: Q367 1115 | 1116 | - name : wikinews 1117 | engine : mediawiki 1118 | shortcut : wn 1119 | categories : news 1120 | base_url : "https://{language}.wikinews.org/" 1121 | number_of_results : 5 1122 | search_type : text 1123 | disabled : True 1124 | about: 1125 | website: https://www.wikinews.org/ 1126 | wikidata_id: Q964 1127 | 1128 | - name : wikiquote 1129 | engine : mediawiki 1130 | shortcut : wq 1131 | categories : general 1132 | base_url : "https://{language}.wikiquote.org/" 1133 | number_of_results : 5 1134 | search_type : text 1135 | disabled : True 1136 | additional_tests: 1137 | rosebud: *test_rosebud 1138 | about: 1139 | website: https://www.wikiquote.org/ 1140 | wikidata_id: Q369 1141 | 1142 | - name : wikisource 1143 | engine : mediawiki 1144 | shortcut : ws 1145 | categories : general 1146 | base_url : "https://{language}.wikisource.org/" 1147 | number_of_results : 5 1148 | search_type : text 1149 | disabled : True 1150 | about: 1151 | website: https://www.wikisource.org/ 1152 | wikidata_id: Q263 1153 | 1154 | - name : wiktionary 1155 | engine : mediawiki 1156 | shortcut : wt 1157 | categories : general 1158 | base_url : "https://{language}.wiktionary.org/" 1159 | number_of_results : 5 1160 | search_type : text 1161 | disabled : True 1162 | about: 1163 | website: https://www.wiktionary.org/ 1164 | wikidata_id: Q151 1165 | 1166 | - name : wikiversity 1167 | engine : mediawiki 1168 | shortcut : wv 1169 | categories : general 1170 | base_url : "https://{language}.wikiversity.org/" 1171 | number_of_results : 5 1172 | search_type : text 1173 | disabled : True 1174 | about: 1175 | website: https://www.wikiversity.org/ 1176 | wikidata_id: Q370 1177 | 1178 | - name : wikivoyage 1179 | engine : mediawiki 1180 | shortcut : wy 1181 | categories : general 1182 | base_url : "https://{language}.wikivoyage.org/" 1183 | number_of_results : 5 1184 | search_type : text 1185 | disabled : True 1186 | about: 1187 | website: https://www.wikivoyage.org/ 1188 | wikidata_id: Q373 1189 | 1190 | - name : wolframalpha 1191 | shortcut : wa 1192 | # You can use the engine using the official stable API, but you need an API key 1193 | # See : http://products.wolframalpha.com/api/ 1194 | # engine : wolframalpha_api 1195 | # api_key: '' # required! 1196 | engine : wolframalpha_noapi 1197 | timeout: 6.0 1198 | categories : science 1199 | 1200 | - name : dictzone 1201 | engine : dictzone 1202 | shortcut : dc 1203 | 1204 | - name : mymemory translated 1205 | engine : translated 1206 | shortcut : tl 1207 | timeout : 5.0 1208 | disabled : True 1209 | # You can use without an API key, but you are limited to 1000 words/day 1210 | # See : http://mymemory.translated.net/doc/usagelimits.php 1211 | # api_key : '' 1212 | 1213 | # Required dependency: mysql-connector-python 1214 | # - name : mysql 1215 | # engine : mysql_server 1216 | # database : mydatabase 1217 | # username : user 1218 | # password : pass 1219 | # limit : 10 1220 | # query_str : 'SELECT * from mytable WHERE fieldname=%(query)s' 1221 | # shortcut : mysql 1222 | 1223 | - name : 1337x 1224 | engine : 1337x 1225 | shortcut : 1337x 1226 | disabled : True 1227 | 1228 | - name : duden 1229 | engine : duden 1230 | shortcut : du 1231 | disabled : True 1232 | 1233 | - name : seznam 1234 | shortcut: szn 1235 | engine: seznam 1236 | disabled : True 1237 | 1238 | - name : mojeek 1239 | shortcut: mjk 1240 | engine: xpath 1241 | paging : True 1242 | search_url : https://www.mojeek.com/search?q={query}&s={pageno} 1243 | results_xpath: /html/body//div[@class="results"]/ul[@class="results-standard"]/li 1244 | url_xpath : ./h2/a/@href 1245 | title_xpath : ./h2 1246 | content_xpath : ./p[@class="s"] 1247 | suggestion_xpath : /html/body//div[@class="top-info"]/p[@class="top-info spell"]/a 1248 | first_page_num : 0 1249 | page_size : 10 1250 | disabled : True 1251 | about: 1252 | website: https://www.mojeek.com/ 1253 | wikidata_id: Q60747299 1254 | official_api_documentation: https://www.mojeek.com/services/api.html/ 1255 | use_official_api: false 1256 | require_api_key: false 1257 | results: HTML 1258 | 1259 | - name : naver 1260 | shortcut: nvr 1261 | engine: xpath 1262 | paging : True 1263 | search_url : https://search.naver.com/search.naver?where=webkr&sm=osp_hty&ie=UTF-8&query={query}&start={pageno} 1264 | url_xpath : //a[@class="link_tit"]/@href 1265 | title_xpath : //a[@class="link_tit"] 1266 | content_xpath : //a[@class="total_dsc"]/div 1267 | first_page_num : 1 1268 | page_size : 10 1269 | disabled : True 1270 | about: 1271 | website: https://www.naver.com/ 1272 | wikidata_id: Q485639 1273 | official_api_documentation: https://developers.naver.com/docs/nmt/examples/ 1274 | use_official_api: false 1275 | require_api_key: false 1276 | results: HTML 1277 | 1278 | - name : rubygems 1279 | shortcut: rbg 1280 | engine: xpath 1281 | paging : True 1282 | search_url : https://rubygems.org/search?page={pageno}&query={query} 1283 | results_xpath: /html/body/main/div/a[@class="gems__gem"] 1284 | url_xpath : ./@href 1285 | title_xpath : ./span/h2 1286 | content_xpath : ./span/p 1287 | suggestion_xpath : /html/body/main/div/div[@class="search__suggestions"]/p/a 1288 | first_page_num : 1 1289 | categories: it 1290 | disabled : True 1291 | about: 1292 | website: https://rubygems.org/ 1293 | wikidata_id: Q1853420 1294 | official_api_documentation: https://guides.rubygems.org/rubygems-org-api/ 1295 | use_official_api: false 1296 | require_api_key: false 1297 | results: HTML 1298 | 1299 | - name : peertube 1300 | engine: peertube 1301 | shortcut: ptb 1302 | paging : True 1303 | base_url : https://peer.tube/ 1304 | categories: videos 1305 | disabled : True 1306 | 1307 | - name : mediathekviewweb 1308 | engine : mediathekviewweb 1309 | shortcut : mvw 1310 | 1311 | # - name : yacy 1312 | # engine : yacy 1313 | # shortcut : ya 1314 | # base_url : 'http://localhost:8090' 1315 | # enable_http: True # required if you aren't using HTTPS for your local yacy instance 1316 | # number_of_results : 5 1317 | # timeout : 3.0 1318 | 1319 | - name : rumble 1320 | engine : rumble 1321 | shortcut : ru 1322 | base_url : https://rumble.com/ 1323 | paging : True 1324 | categories: videos 1325 | disabled : True 1326 | 1327 | - name: wordnik 1328 | engine: wordnik 1329 | shortcut: def 1330 | base_url: https://www.wordnik.com/ 1331 | categories: general 1332 | timeout: 5.0 1333 | disabled: True 1334 | 1335 | - name: słownik języka polskiego 1336 | engine: sjp 1337 | shortcut: sjp 1338 | base_url: https://sjp.pwn.pl/ 1339 | categories: general 1340 | timeout: 5.0 1341 | disabled: True 1342 | 1343 | # Doku engine lets you access to any Doku wiki instance: 1344 | # A public one or a privete/corporate one. 1345 | # - name : ubuntuwiki 1346 | # engine : doku 1347 | # shortcut : uw 1348 | # base_url : 'http://doc.ubuntu-fr.org' 1349 | 1350 | # Be careful when enabling this engine if you are 1351 | # running a public instance. Do not expose any sensitive 1352 | # information. You can restrict access by configuring a list 1353 | # of access tokens under tokens. 1354 | # - name: git grep 1355 | # engine: command 1356 | # command: ['git', 'grep', '{{QUERY}}'] 1357 | # shortcut: gg 1358 | # tokens: [] 1359 | # disabled: True 1360 | # delimiter: 1361 | # chars: ':' 1362 | # keys: ['filepath', 'code'] 1363 | 1364 | # Be careful when enabling this engine if you are 1365 | # running a public instance. Do not expose any sensitive 1366 | # information. You can restrict access by configuring a list 1367 | # of access tokens under tokens. 1368 | # - name: locate 1369 | # engine: command 1370 | # command: ['locate', '{{QUERY}}'] 1371 | # shortcut: loc 1372 | # tokens: [] 1373 | # disabled: True 1374 | # delimiter: 1375 | # chars: ' ' 1376 | # keys: ['line'] 1377 | 1378 | # Be careful when enabling this engine if you are 1379 | # running a public instance. Do not expose any sensitive 1380 | # information. You can restrict access by configuring a list 1381 | # of access tokens under tokens. 1382 | # - name: find 1383 | # engine: command 1384 | # command: ['find', '.', '-name', '{{QUERY}}'] 1385 | # query_type: path 1386 | # shortcut: fnd 1387 | # tokens: [] 1388 | # disabled: True 1389 | # delimiter: 1390 | # chars: ' ' 1391 | # keys: ['line'] 1392 | 1393 | # Be careful when enabling this engine if you are 1394 | # running a public instance. Do not expose any sensitive 1395 | # information. You can restrict access by configuring a list 1396 | # of access tokens under tokens. 1397 | # - name: pattern search in files 1398 | # engine: command 1399 | # command: ['fgrep', '{{QUERY}}'] 1400 | # shortcut: fgr 1401 | # tokens: [] 1402 | # disabled: True 1403 | # delimiter: 1404 | # chars: ' ' 1405 | # keys: ['line'] 1406 | 1407 | # Be careful when enabling this engine if you are 1408 | # running a public instance. Do not expose any sensitive 1409 | # information. You can restrict access by configuring a list 1410 | # of access tokens under tokens. 1411 | # - name: regex search in files 1412 | # engine: command 1413 | # command: ['grep', '{{QUERY}}'] 1414 | # shortcut: gr 1415 | # tokens: [] 1416 | # disabled: True 1417 | # delimiter: 1418 | # chars: ' ' 1419 | # keys: ['line'] 1420 | 1421 | locales: 1422 | en : English 1423 | ar : العَرَبِيَّة (Arabic) 1424 | bg : Български (Bulgarian) 1425 | bo : བོད་སྐད་ (Tibetian) 1426 | ca : Català (Catalan) 1427 | cs : Čeština (Czech) 1428 | cy : Cymraeg (Welsh) 1429 | da : Dansk (Danish) 1430 | de : Deutsch (German) 1431 | el_GR : Ελληνικά (Greek_Greece) 1432 | eo : Esperanto (Esperanto) 1433 | es : Español (Spanish) 1434 | et : Eesti (Estonian) 1435 | eu : Euskara (Basque) 1436 | fa_IR : (fārsī) فارسى (Persian) 1437 | fi : Suomi (Finnish) 1438 | fil : Wikang Filipino (Filipino) 1439 | fr : Français (French) 1440 | gl : Galego (Galician) 1441 | he : עברית (Hebrew) 1442 | hr : Hrvatski (Croatian) 1443 | hu : Magyar (Hungarian) 1444 | ia : Interlingua (Interlingua) 1445 | it : Italiano (Italian) 1446 | ja : 日本語 (Japanese) 1447 | lt : Lietuvių (Lithuanian) 1448 | nl : Nederlands (Dutch) 1449 | nl_BE : Vlaams (Dutch_Belgium) 1450 | oc : Lenga D'òc (Occitan) 1451 | pl : Polski (Polish) 1452 | pt : Português (Portuguese) 1453 | pt_BR : Português (Portuguese_Brazil) 1454 | ro : Română (Romanian) 1455 | ru : Русский (Russian) 1456 | sk : Slovenčina (Slovak) 1457 | sl : Slovenski (Slovene) 1458 | sr : српски (Serbian) 1459 | sv : Svenska (Swedish) 1460 | te : తెలుగు (telugu) 1461 | ta : தமிழ் (Tamil) 1462 | tr : Türkçe (Turkish) 1463 | uk : українська мова (Ukrainian) 1464 | vi : tiếng việt (Vietnamese) 1465 | zh : 中文 (Chinese) 1466 | zh_TW : 國語 (Taiwanese Mandarin) 1467 | 1468 | doi_resolvers : 1469 | oadoi.org : 'https://oadoi.org/' 1470 | doi.org : 'https://doi.org/' 1471 | doai.io : 'https://dissem.in/' 1472 | sci-hub.se : 'https://sci-hub.se/' 1473 | sci-hub.do : 'https://sci-hub.do/' 1474 | scihubtw.tw : 'https://scihubtw.tw/' 1475 | sci-hub.st : 'https://sci-hub.st/' 1476 | sci-hub.bar : 'https://sci-hub.bar/' 1477 | sci-hub.it.nf : 'https://sci-hub.it.nf/' 1478 | 1479 | default_doi_resolver : 'oadoi.org' -------------------------------------------------------------------------------- /conf/uwsgi.ini: -------------------------------------------------------------------------------- 1 | [uwsgi] 2 | # Who will run the code 3 | uid = __APP__ 4 | gid = __APP__ 5 | 6 | # Number of workers 7 | workers = 4 8 | 9 | # The right granted on the created socket 10 | chmod-socket = 666 11 | 12 | # Plugin to use and interpretor config 13 | single-interpreter = true 14 | master = true 15 | plugin = python3 16 | lazy-apps = true 17 | enable-threads = true 18 | 19 | # Application base folder 20 | base = __INSTALL_DIR__/source 21 | 22 | # Support running the module from a webserver subdirectory. 23 | route-run = fixpathinfo: 24 | 25 | # Module to import 26 | module = searx.webapp 27 | 28 | # Virtualenv and python path 29 | virtualenv = __INSTALL_DIR__/venv 30 | pythonpath = __INSTALL_DIR__/source/ 31 | chdir = __INSTALL_DIR__/source/searx/ 32 | 33 | # The variable holding flask application 34 | callable = app 35 | -------------------------------------------------------------------------------- /doc/DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | Privacy-respecting, hackable metasearch engine. 2 | 3 | As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 4 | Installation is discouraged. 5 | 6 | SearXNG is a potential alternative, already packaged for YunoHost. 7 | -------------------------------------------------------------------------------- /doc/screenshots/Screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/searx_ynh/fbbef0aefe1778c611c5e99866a13ae50da27114/doc/screenshots/Screenshot.png -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json 2 | 3 | packaging_format = 2 4 | 5 | id = "searx" 6 | name = "Searx" 7 | description.en = "Privacy-respecting, hackable metasearch engine" 8 | description.fr = "Méta-moteur de recherche respectueux de la vie privée et bidouillable" 9 | description.de = "Meta-Suchmaschine, die den Privatsphäre wahrt und 'hackable' ist" 10 | 11 | version = "1.1.0~ynh3" 12 | 13 | maintainers = [] 14 | 15 | [upstream] 16 | license = "AGPL-3.0-or-later" 17 | website = "https://searx.github.io/searx/" 18 | demo = "https://demo.yunohost.org/searx/" 19 | admindoc = "https://github.com/searx/searx/wiki" 20 | code = "https://github.com/searx/searx" 21 | 22 | [integration] 23 | yunohost = ">= 11.2" 24 | architectures = "all" 25 | multi_instance = false 26 | 27 | ldap = false 28 | 29 | sso = false 30 | 31 | disk = "50M" 32 | ram.build = "50M" 33 | ram.runtime = "50M" 34 | 35 | [install] 36 | [install.domain] 37 | type = "domain" 38 | 39 | [install.path] 40 | type = "path" 41 | default = "/searx" 42 | 43 | [install.init_main_permission] 44 | help.en = "If enabled, Searx will be accessible by people who do not have an account. This can be changed later via the webadmin." 45 | help.fr = "Si cette case est cochée, Searx sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." 46 | help.de = "Wenn aktiviert, ist Searx für Personen zugänglich, die kein Konto haben. Dies kann später über den Webadmin geändert werden" 47 | type = "group" 48 | default = "visitors" 49 | 50 | [resources] 51 | [resources.sources.main] 52 | url = "https://github.com/searx/searx/archive/refs/tags/v1.1.0.tar.gz" 53 | sha256 = "fc17371a02ee1d73896c2ac9c55b1ec90e5171fd2eea060b8867fc7efb63d725" 54 | 55 | autoupdate.strategy = "latest_github_tag" 56 | 57 | [resources.system_user] 58 | 59 | [resources.install_dir] 60 | 61 | [resources.permissions] 62 | main.url = "/" 63 | 64 | [resources.apt] 65 | packages = [ 66 | "git", 67 | "build-essential", 68 | "libxslt-dev", 69 | "python3-dev", 70 | "python3-venv", 71 | "python3-pip", 72 | "python3-cffi", 73 | "python3-babel,zlib1g-dev", 74 | "libffi-dev", 75 | "libssl-dev", 76 | "python3-lxml", 77 | "uwsgi", 78 | "uwsgi-plugin-python3", 79 | "shellcheck", 80 | ] 81 | -------------------------------------------------------------------------------- /scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # COMMON VARIABLES 5 | #================================================= 6 | 7 | #================================================= 8 | # PERSONAL HELPERS 9 | #================================================= 10 | 11 | _searx_venv_install() { 12 | ynh_exec_as "$app" python3 -m venv --upgrade "$install_dir/venv" 13 | venvpy="$install_dir/venv/bin/python3" 14 | 15 | ynh_exec_as "$app" "$venvpy" -m pip install --upgrade --no-cache-dir pip 16 | 17 | ynh_exec_as "$app" "$venvpy" -m pip install setuptools wheel pyyaml 18 | } 19 | 20 | #================================================= 21 | # UWSGI HELPERS 22 | #================================================= 23 | 24 | # Check if system wide templates are available and correcly configured 25 | # 26 | # usage: ynh_check_global_uwsgi_config 27 | ynh_check_global_uwsgi_config () { 28 | uwsgi --version || ynh_die --message "You need to add uwsgi (and appropriate plugin) as a dependency" 29 | 30 | cat > /etc/systemd/system/uwsgi-app@.service < uwsgi-app@app` 77 | ynh_add_uwsgi_service () { 78 | ynh_check_global_uwsgi_config 79 | 80 | local others_var=${1:-} 81 | local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini" 82 | 83 | # www-data group is needed since it is this nginx who will start the service 84 | usermod --append --groups www-data "$app" || ynh_die --message "It wasn't possible to add user $app to group www-data" 85 | 86 | ynh_backup_if_checksum_is_different "$finaluwsgiini" 87 | cp ../conf/uwsgi.ini "$finaluwsgiini" 88 | 89 | # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. 90 | # Substitute in a nginx config file only if the variable is not empty 91 | if test -n "${install_dir:-}"; then 92 | ynh_replace_string --match_string "__INSTALL_DIR__" --replace_string "$install_dir" --target_file "$finaluwsgiini" 93 | fi 94 | if test -n "${path:-}"; then 95 | ynh_replace_string --match_string "__PATH__" --replace_string "$path" --target_file "$finaluwsgiini" 96 | fi 97 | if test -n "${app:-}"; then 98 | ynh_replace_string --match_string "__APP__" --replace_string "$app" --target_file "$finaluwsgiini" 99 | fi 100 | 101 | # Replace all other variable given as arguments 102 | for var_to_replace in $others_var 103 | do 104 | # ${var_to_replace^^} make the content of the variable on upper-cases 105 | # ${!var_to_replace} get the content of the variable named $var_to_replace 106 | ynh_replace_string --match_string "__${var_to_replace^^}__" --replace_string "${!var_to_replace}" --target_file "$finaluwsgiini" 107 | done 108 | 109 | ynh_store_file_checksum --file "$finaluwsgiini" 110 | 111 | chown $app:root "$finaluwsgiini" 112 | 113 | # make sure the folder for logs exists and set authorizations 114 | mkdir -p /var/log/uwsgi/$app 115 | chown $app:root /var/log/uwsgi/$app 116 | chmod -R u=rwX,g=rX,o= /var/log/uwsgi/$app 117 | 118 | # Setup specific Systemd rules if necessary 119 | test -e ../conf/uwsgi-app@override.service && \ 120 | mkdir /etc/systemd/system/uwsgi-app@$app.service.d && \ 121 | cp ../conf/uwsgi-app@override.service /etc/systemd/system/uwsgi-app@$app.service.d/override.conf 122 | 123 | systemctl daemon-reload 124 | systemctl enable "uwsgi-app@$app.service" --quiet 125 | 126 | # Add as a service 127 | yunohost service add "uwsgi-app@$app" --log "/var/log/uwsgi/$app/$app.log" 128 | } 129 | 130 | # Remove the dedicated uwsgi ini file 131 | # 132 | # usage: ynh_remove_uwsgi_service 133 | ynh_remove_uwsgi_service () { 134 | local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini" 135 | if [ -e "$finaluwsgiini" ]; then 136 | yunohost service remove "uwsgi-app@$app" 137 | systemctl disable "uwsgi-app@$app.service" --quiet 138 | 139 | ynh_secure_remove --file="$finaluwsgiini" 140 | ynh_secure_remove --file="/var/log/uwsgi/$app" 141 | ynh_secure_remove --file="/etc/systemd/system/uwsgi-app@$app.service.d" 142 | fi 143 | if [ -e /etc/init.d/uwsgi ] 144 | then 145 | # Redémarre le service uwsgi si il n'est pas désinstallé. 146 | ynh_systemd_action --service_name=uwsgi --action=start 147 | else 148 | if yunohost service status | grep -q uwsgi 149 | then 150 | ynh_print_info --message="Remove uwsgi service" 151 | yunohost service remove uwsgi 152 | fi 153 | fi 154 | } 155 | 156 | 157 | #================================================= 158 | 159 | # Remove a file or a directory securely 160 | # 161 | # usage: ynh_regex_secure_remove --file=path_to_remove [--regex=regex to append to $file] [--non_recursive] [--dry_run] 162 | # | arg: -f, --file - File or directory to remove 163 | # | arg: -r, --regex - Regex to append to $file to filter the files to remove 164 | # | arg: -n, --non_recursive - Perform a non recursive rm and a non recursive search with the regex 165 | # | arg: -d, --dry_run - Do not remove, only list the files to remove 166 | # 167 | # Requires YunoHost version 2.6.4 or higher. 168 | ynh_regex_secure_remove () { 169 | # Declare an array to define the options of this helper. 170 | local legacy_args=frnd 171 | declare -Ar args_array=( [f]=file= [r]=regex= [n]=non_recursive [d]=dry_run ) 172 | local file 173 | local regex 174 | local dry_run 175 | local non_recursive 176 | # Manage arguments with getopts 177 | ynh_handle_getopts_args "$@" 178 | regex=${regex:-} 179 | dry_run=${dry_run:-0} 180 | non_recursive=${non_recursive:-0} 181 | 182 | local forbidden_path=" 183 | /var/www \ 184 | /home/yunohost.app" 185 | 186 | # Fail if no argument is provided to the helper. 187 | if [ -z "$file" ] 188 | then 189 | ynh_print_warn --message="ynh_regex_secure_remove called with no argument --file, ignoring." 190 | return 0 191 | fi 192 | 193 | if [ -n "$regex" ] 194 | then 195 | if [ -e "$file" ] 196 | then 197 | if [ $non_recursive -eq 1 ]; then 198 | local recursive="-maxdepth 1" 199 | else 200 | local recursive="" 201 | fi 202 | # Use find to list the files in $file and grep to filter with the regex 203 | files_to_remove="$(find -P "$file" $recursive -name ".." -prune -o -print | grep --extended-regexp "$regex")" 204 | else 205 | ynh_print_info --message="'$file' wasn't deleted because it doesn't exist." 206 | return 0 207 | fi 208 | else 209 | files_to_remove="$file" 210 | fi 211 | 212 | # Check each file before removing it 213 | while read file_to_remove 214 | do 215 | if [ -n "$file_to_remove" ] 216 | then 217 | # Check all forbidden path before removing anything 218 | # First match all paths or subpaths in $forbidden_path 219 | if [[ "$forbidden_path" =~ "$file_to_remove" ]] || \ 220 | # Match all first level paths from / (Like /var, /root, etc...) 221 | [[ "$file_to_remove" =~ ^/[[:alnum:]]+$ ]] || \ 222 | # Match if the path finishes by /. Because it seems there is an empty variable 223 | [ "${file_to_remove:${#file_to_remove}-1}" = "/" ] 224 | then 225 | ynh_print_err --message="Not deleting '$file_to_remove' because this path is forbidden !!!" 226 | 227 | # If the file to remove exists 228 | elif [ -e "$file_to_remove" ] 229 | then 230 | if [ $dry_run -eq 1 ] 231 | then 232 | ynh_print_warn --message="File to remove: $file_to_remove" 233 | else 234 | if [ $non_recursive -eq 1 ]; then 235 | local recursive="" 236 | else 237 | local recursive="--recursive" 238 | fi 239 | 240 | # Remove a file or a directory 241 | rm --force $recursive "$file_to_remove" 242 | fi 243 | else 244 | # Ignore non existent files with regex, as we likely remove the parent directory before its content is listed. 245 | if [ -z "$regex" ] 246 | then 247 | ynh_print_info --message="'$file_to_remove' wasn't deleted because it doesn't exist." 248 | fi 249 | fi 250 | fi 251 | done <<< "$(echo "$files_to_remove")" 252 | } 253 | -------------------------------------------------------------------------------- /scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 10 | source ../settings/scripts/_common.sh 11 | source /usr/share/yunohost/helpers 12 | 13 | #================================================= 14 | # DECLARE DATA AND CONF FILES TO BACKUP 15 | #================================================= 16 | ynh_print_info --message="Declaring files to be backed up..." 17 | 18 | #================================================= 19 | # BACKUP THE APP MAIN DIR 20 | #================================================= 21 | 22 | ynh_backup --src_path="$install_dir" 23 | 24 | #================================================= 25 | # BACKUP THE NGINX CONFIGURATION 26 | #================================================= 27 | 28 | ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" 29 | 30 | #================================================= 31 | # SPECIFIC BACKUP 32 | #================================================= 33 | # BACKUP VARIOUS FILES 34 | #================================================= 35 | 36 | ynh_backup --src_path="/etc/uwsgi/apps-available/$app.ini" 37 | 38 | #================================================= 39 | # END OF SCRIPT 40 | #================================================= 41 | 42 | ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." 43 | -------------------------------------------------------------------------------- /scripts/change_url: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC STARTING 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # STANDARD MODIFICATIONS 14 | #================================================= 15 | # STOP SYSTEMD SERVICE 16 | #================================================= 17 | ynh_script_progression --message="Stopping a systemd service..." --weight=10 18 | 19 | ynh_systemd_action --service_name=uwsgi --action=stop 20 | 21 | #================================================= 22 | # MODIFY URL IN NGINX CONF 23 | #================================================= 24 | ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 25 | 26 | path_no_root=${path%/} 27 | # Create a dedicated NGINX config 28 | ynh_change_url_nginx_config 29 | 30 | #================================================= 31 | # SPECIFIC MODIFICATIONS 32 | #================================================= 33 | # RECONFIGURING SEARX 34 | #================================================= 35 | ynh_script_progression --message="Reconfiguring Searx..." --weight=2 36 | 37 | #ynh_replace_string --match_string="base_url : https://${old_domain}${old_path%/}/" --replace_string="base_url : https://${new_domain}${new_path%/}/" --target_file="$install_dir/searx/settings.yml" 38 | 39 | #================================================= 40 | # GENERIC FINALISATION 41 | #================================================= 42 | # START SYSTEMD SERVICE 43 | #================================================= 44 | ynh_script_progression --message="Starting a systemd service..." --weight=2 45 | 46 | # Start a systemd service 47 | ynh_systemd_action --service_name=uwsgi-app@$app.service --action=restart --line_match="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log" 48 | 49 | #================================================= 50 | # END OF SCRIPT 51 | #================================================= 52 | 53 | ynh_script_progression --message="Change of URL completed for $app" --last 54 | -------------------------------------------------------------------------------- /scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # DOWNLOAD, CHECK AND UNPACK SOURCE 14 | #================================================= 15 | ynh_script_progression --message="Setting up source files..." --weight=2 16 | 17 | # Download, check integrity, uncompress and patch the source from app.src 18 | ynh_setup_source --dest_dir="$install_dir/source" 19 | 20 | chmod -R o-rwx "$install_dir" 21 | chown -R "$app:" "$install_dir" 22 | 23 | #================================================= 24 | # NGINX CONFIGURATION 25 | #================================================= 26 | ynh_script_progression --message="Configuring NGINX web server..." --weight=2 27 | 28 | path_no_root=${path%/} 29 | # Create a dedicated NGINX config 30 | ynh_add_nginx_config "path_no_root" 31 | 32 | #================================================= 33 | # SPECIFIC SETUP 34 | #================================================= 35 | # INSTALL SEARX IN A VIRTUALENV 36 | #================================================= 37 | ynh_script_progression --message="Installing Searx..." --weight=2 38 | 39 | _searx_venv_install 40 | 41 | ynh_add_config --template="requirements-ynh.txt" --destination="$install_dir/requirements-ynh.txt" 42 | 43 | ynh_exec_as "$app" "$venvpy" -m pip install --requirement "$install_dir/requirements-ynh.txt" --no-cache-dir 44 | 45 | #================================================= 46 | # CONFIGURE SEARX 47 | #================================================= 48 | ynh_script_progression --message="Configuring Searx..." --weight=2 49 | 50 | secret_key=$(ynh_string_random) 51 | ynh_add_config --template="settings.yml" --destination="$install_dir/source/searx/settings.yml" 52 | 53 | #================================================= 54 | # SET PERMISSIONS ON SEARX DIRECTORY 55 | #================================================= 56 | 57 | chown -R "$app:" "$install_dir" 58 | 59 | #================================================= 60 | # CONFIGURE UWSGI FOR SEARX 61 | #================================================= 62 | ynh_script_progression --message="Configuring uWSGI for Searx..." --weight=2 63 | 64 | ynh_add_uwsgi_service 65 | 66 | #================================================= 67 | # GENERIC FINALIZATION 68 | #================================================= 69 | # START SYSTEMD SERVICE 70 | #================================================= 71 | ynh_script_progression --message="Starting a systemd service..." --weight=4 72 | 73 | # Start a systemd service 74 | ynh_systemd_action --service_name="uwsgi-app@$app.service" --action=start --line_match="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log" 75 | 76 | #================================================= 77 | # END OF SCRIPT 78 | #================================================= 79 | 80 | ynh_script_progression --message="Installation of $app completed" --last 81 | -------------------------------------------------------------------------------- /scripts/remove: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # STANDARD REMOVE 14 | #================================================= 15 | # STOP AND REMOVE SERVICE 16 | #================================================= 17 | ynh_script_progression --message="Stopping and removing the systemd service..." --weight=2 18 | 19 | # Remove the uwsgi configuration 20 | ynh_systemd_action --service_name "uwsgi-app@$app.service" --action stop 21 | ynh_remove_uwsgi_service 22 | 23 | # Remove the dedicated NGINX config 24 | ynh_remove_nginx_config 25 | 26 | #================================================= 27 | # END OF SCRIPT 28 | #================================================= 29 | 30 | ynh_script_progression --message="Removal of $app completed" --last 31 | -------------------------------------------------------------------------------- /scripts/restore: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 10 | source ../settings/scripts/_common.sh 11 | source /usr/share/yunohost/helpers 12 | 13 | #================================================= 14 | # RESTORE THE APP MAIN DIR 15 | #================================================= 16 | ynh_script_progression --message="Restoring the app main directory..." --weight=2 17 | 18 | ynh_restore_file --origin_path="$install_dir" 19 | 20 | chmod -R o-rwx "$install_dir" 21 | chown -R $app: "$install_dir" 22 | 23 | #================================================= 24 | # RESTORE THE NGINX CONFIGURATION 25 | #================================================= 26 | ynh_script_progression --message="Restoring the NGINX web server configuration..." 27 | 28 | ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" 29 | 30 | #================================================= 31 | # RESTORE VARIOUS FILES 32 | #================================================= 33 | ynh_script_progression --message="Restoring various files..." 34 | 35 | ynh_restore_file --origin_path="/etc/uwsgi/apps-available/$app.ini" 36 | mkdir -p /var/log/uwsgi/$app 37 | chown $app:root /var/log/uwsgi/$app 38 | chmod -R u=rwX,g=rX,o= /var/log/uwsgi/$app 39 | ynh_check_global_uwsgi_config 40 | systemctl enable "uwsgi-app@$app.service" --quiet 41 | 42 | #================================================= 43 | # START SYSTEMD SERVICE 44 | #================================================= 45 | ynh_script_progression --message="Starting a systemd service..." --weight=4 46 | 47 | ynh_systemd_action --service_name=uwsgi-app@$app.service --action=start --line_match="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log" 48 | 49 | ynh_systemd_action --service_name=nginx --action=reload 50 | 51 | #================================================= 52 | # END OF SCRIPT 53 | #================================================= 54 | 55 | ynh_script_progression --message="Restoration completed for $app" --last 56 | -------------------------------------------------------------------------------- /scripts/upgrade: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # STANDARD UPGRADE STEPS 14 | #================================================= 15 | # ENSURE DOWNWARD COMPATIBILITY 16 | #================================================= 17 | ynh_script_progression --message="Ensuring downward compatibility..." 18 | 19 | if [ -f "$install_dir/setup.py" ]; then 20 | # Clean up the whole install_dir except settings.yml 21 | tmpdir="$(mktemp -d)" 22 | cp "$install_dir/searx/settings.yml" "$tmpdir" 23 | ynh_secure_remove "$install_dir" 24 | mkdir -p "$install_dir" 25 | chmod 750 "$install_dir" 26 | chown "$app:" "$install_dir" 27 | mkdir -p "$install_dir/source/searx" 28 | cp "$tmpdir/settings.yml" "$install_dir/source/searx" 29 | ynh_secure_remove --file="$tmpdir" 30 | fi 31 | 32 | 33 | #================================================= 34 | # DOWNLOAD, CHECK AND UNPACK SOURCE 35 | #================================================= 36 | ynh_script_progression --message="Upgrading source files..." --weight=3 37 | 38 | # Download, check integrity, uncompress and patch the source from app.src 39 | ynh_setup_source --dest_dir="$install_dir/source" --full_replace=1 --keep="searx/settings.yml" 40 | 41 | #================================================= 42 | # REAPPLY SYSTEM CONFIGURATIONS 43 | #================================================= 44 | ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 45 | 46 | path_no_root=${path%/} 47 | # Create a dedicated NGINX config 48 | ynh_add_nginx_config "path_no_root" 49 | 50 | #================================================= 51 | # SPECIFIC UPGRADE 52 | #================================================= 53 | # UPGRADE SEARX IN ITS VIRTUALENV 54 | #================================================= 55 | ynh_script_progression --message="Upgrading Searx..." --weight=7 56 | 57 | _searx_venv_install 58 | 59 | ynh_add_config --template="requirements-ynh.txt" --destination="$install_dir/requirements-ynh.txt" 60 | 61 | ynh_exec_as "$app" "$venvpy" -m pip install --requirement "$install_dir/requirements-ynh.txt" --no-cache-dir 62 | 63 | #================================================= 64 | # CONFIGURE SEARX 65 | #================================================= 66 | # ynh_script_progression --message="Configuring Searx..." --weight=2 67 | 68 | # secret_key=$(ynh_string_random) 69 | # ynh_add_config --template="settings.yml" --destination="$install_dir/source/searx/settings.yml" 70 | 71 | #================================================= 72 | # CONFIGURE UWSGI FOR SEARX 73 | #================================================= 74 | ynh_script_progression --message="Reconfiguring uWSGI for Searx..." --weight=2 75 | 76 | # Clean old files 77 | ynh_secure_remove --file="/etc/uwsgi/apps-enabled/$app.ini" 78 | ynh_secure_remove --file="/etc/uwsgi/apps-available/$app.ini" 79 | ynh_add_uwsgi_service 80 | 81 | #================================================= 82 | # GENERIC FINALISATION 83 | #================================================= 84 | # START SYSTEMD SERVICE 85 | #================================================= 86 | ynh_script_progression --message="Starting a systemd service..." --weight=3 87 | 88 | # Wait for searx to be fully started 89 | ynh_systemd_action --service_name="uwsgi-app@$app.service" --action=restart --line_match="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log" 90 | 91 | #================================================= 92 | # END OF SCRIPT 93 | #================================================= 94 | 95 | ynh_script_progression --message="Upgrade of $app completed" --last 96 | -------------------------------------------------------------------------------- /tests.toml: -------------------------------------------------------------------------------- 1 | test_format = 1.0 2 | 3 | [default] 4 | 5 | # ------------ 6 | # Tests to run 7 | # ------------ --------------------------------------------------------------------------------