├── .github ├── ISSUE_TEMPLATE.md ├── PULL_REQUEST_TEMPLATE.md └── workflows │ ├── package_linter.yml │ └── update_master.yml ├── .gitignore ├── LICENSE ├── README.md ├── conf ├── nginx.conf ├── settings.yml └── uwsgi.ini ├── doc ├── .gitkeep ├── ADMIN.md ├── DESCRIPTION.md └── screenshots │ ├── .gitkeep │ └── screenshot_1.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 | -------------------------------------------------------------------------------- /.github/workflows/package_linter.yml: -------------------------------------------------------------------------------- 1 | name: YunoHost apps package linter 2 | 3 | on: 4 | # Allow to manually trigger the workflow 5 | workflow_dispatch: 6 | push: 7 | pull_request: 8 | 9 | jobs: 10 | test: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4 14 | 15 | - name: Set up Python 16 | uses: actions/setup-python@v5 17 | with: 18 | python-version: '3.11' 19 | 20 | - name: Install dependencies 21 | run: | 22 | python -m pip install --upgrade pip 23 | pip install tomli pyparsing six jsonschema 24 | 25 | - name: 'Clone YunoHost apps package linter' 26 | run: | 27 | git clone --depth=1 https://github.com/YunoHost/package_linter ~/package_linter 28 | 29 | - name: 'Run linter' 30 | run: | 31 | ~/package_linter/package_linter.py . 32 | -------------------------------------------------------------------------------- /.github/workflows/update_master.yml: -------------------------------------------------------------------------------- 1 | name: Create master promotion pull request 2 | on: 3 | # Allow to manually trigger the workflow 4 | workflow_dispatch: 5 | # Run it when when someone pushes to testing 6 | push: 7 | branches: 8 | - testing 9 | jobs: 10 | masterPromotion: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4 14 | with: 15 | ref: master 16 | - name: Reset promotion branch 17 | run: | 18 | git fetch origin testing:testing 19 | git reset --hard testing 20 | - name: Create Pull Request 21 | uses: peter-evans/create-pull-request@v5 22 | with: 23 | branch: master-promotion 24 | title: 'Upgrade master from testing' 25 | body: | 26 | Upgrade master from testing 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *.sw[op] 3 | .DS_Store 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (C) 2023 mh4ckt3mh4ckt1c4s 2 | 3 | The following code is a derivative work of the code from the searX YunoHost 4 | package, which is licensed GPLv3. It is available here : 5 | https://github.com/YunoHost-Apps/searx_ynh 6 | 7 | GNU GENERAL PUBLIC LICENSE 8 | Version 3, 29 June 2007 9 | 10 | Copyright (C) 2007 Free Software Foundation, Inc. 11 | Everyone is permitted to copy and distribute verbatim copies 12 | of this license document, but changing it is not allowed. 13 | 14 | Preamble 15 | 16 | The GNU General Public License is a free, copyleft license for 17 | software and other kinds of works. 18 | 19 | The licenses for most software and other practical works are designed 20 | to take away your freedom to share and change the works. By contrast, 21 | the GNU General Public License is intended to guarantee your freedom to 22 | share and change all versions of a program--to make sure it remains free 23 | software for all its users. We, the Free Software Foundation, use the 24 | GNU General Public License for most of our software; it applies also to 25 | any other work released this way by its authors. You can apply it to 26 | your programs, too. 27 | 28 | When we speak of free software, we are referring to freedom, not 29 | price. Our General Public Licenses are designed to make sure that you 30 | have the freedom to distribute copies of free software (and charge for 31 | them if you wish), that you receive source code or can get it if you 32 | want it, that you can change the software or use pieces of it in new 33 | free programs, and that you know you can do these things. 34 | 35 | To protect your rights, we need to prevent others from denying you 36 | these rights or asking you to surrender the rights. Therefore, you have 37 | certain responsibilities if you distribute copies of the software, or if 38 | you modify it: responsibilities to respect the freedom of others. 39 | 40 | For example, if you distribute copies of such a program, whether 41 | gratis or for a fee, you must pass on to the recipients the same 42 | freedoms that you received. You must make sure that they, too, receive 43 | or can get the source code. And you must show them these terms so they 44 | know their rights. 45 | 46 | Developers that use the GNU GPL protect your rights with two steps: 47 | (1) assert copyright on the software, and (2) offer you this License 48 | giving you legal permission to copy, distribute and/or modify it. 49 | 50 | For the developers' and authors' protection, the GPL clearly explains 51 | that there is no warranty for this free software. For both users' and 52 | authors' sake, the GPL requires that modified versions be marked as 53 | changed, so that their problems will not be attributed erroneously to 54 | authors of previous versions. 55 | 56 | Some devices are designed to deny users access to install or run 57 | modified versions of the software inside them, although the manufacturer 58 | can do so. This is fundamentally incompatible with the aim of 59 | protecting users' freedom to change the software. The systematic 60 | pattern of such abuse occurs in the area of products for individuals to 61 | use, which is precisely where it is most unacceptable. Therefore, we 62 | have designed this version of the GPL to prohibit the practice for those 63 | products. If such problems arise substantially in other domains, we 64 | stand ready to extend this provision to those domains in future versions 65 | of the GPL, as needed to protect the freedom of users. 66 | 67 | Finally, every program is threatened constantly by software patents. 68 | States should not allow patents to restrict development and use of 69 | software on general-purpose computers, but in those that do, we wish to 70 | avoid the special danger that patents applied to a free program could 71 | make it effectively proprietary. To prevent this, the GPL assures that 72 | patents cannot be used to render the program non-free. 73 | 74 | The precise terms and conditions for copying, distribution and 75 | modification follow. 76 | 77 | TERMS AND CONDITIONS 78 | 79 | 0. Definitions. 80 | 81 | "This License" refers to version 3 of the GNU General Public License. 82 | 83 | "Copyright" also means copyright-like laws that apply to other kinds of 84 | works, such as semiconductor masks. 85 | 86 | "The Program" refers to any copyrightable work licensed under this 87 | License. Each licensee is addressed as "you". "Licensees" and 88 | "recipients" may be individuals or organizations. 89 | 90 | To "modify" a work means to copy from or adapt all or part of the work 91 | in a fashion requiring copyright permission, other than the making of an 92 | exact copy. The resulting work is called a "modified version" of the 93 | earlier work or a work "based on" the earlier work. 94 | 95 | A "covered work" means either the unmodified Program or a work based 96 | on the Program. 97 | 98 | To "propagate" a work means to do anything with it that, without 99 | permission, would make you directly or secondarily liable for 100 | infringement under applicable copyright law, except executing it on a 101 | computer or modifying a private copy. Propagation includes copying, 102 | distribution (with or without modification), making available to the 103 | public, and in some countries other activities as well. 104 | 105 | To "convey" a work means any kind of propagation that enables other 106 | parties to make or receive copies. Mere interaction with a user through 107 | a computer network, with no transfer of a copy, is not conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" 110 | to the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work 121 | for making modifications to it. "Object code" means any non-source 122 | form of a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users 154 | can regenerate automatically from other parts of the Corresponding 155 | Source. 156 | 157 | The Corresponding Source for a work in source code form is that 158 | same work. 159 | 160 | 2. Basic Permissions. 161 | 162 | All rights granted under this License are granted for the term of 163 | copyright on the Program, and are irrevocable provided the stated 164 | conditions are met. This License explicitly affirms your unlimited 165 | permission to run the unmodified Program. The output from running a 166 | covered work is covered by this License only if the output, given its 167 | content, constitutes a covered work. This License acknowledges your 168 | rights of fair use or other equivalent, as provided by copyright law. 169 | 170 | You may make, run and propagate covered works that you do not 171 | convey, without conditions so long as your license otherwise remains 172 | in force. You may convey covered works to others for the sole purpose 173 | of having them make modifications exclusively for you, or provide you 174 | with facilities for running those works, provided that you comply with 175 | the terms of this License in conveying all material for which you do 176 | not control copyright. Those thus making or running the covered works 177 | for you must do so exclusively on your behalf, under your direction 178 | and control, on terms that prohibit them from making any copies of 179 | your copyrighted material outside their relationship with you. 180 | 181 | Conveying under any other circumstances is permitted solely under 182 | the conditions stated below. Sublicensing is not allowed; section 10 183 | makes it unnecessary. 184 | 185 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 186 | 187 | No covered work shall be deemed part of an effective technological 188 | measure under any applicable law fulfilling obligations under article 189 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 190 | similar laws prohibiting or restricting circumvention of such 191 | measures. 192 | 193 | When you convey a covered work, you waive any legal power to forbid 194 | circumvention of technological measures to the extent such circumvention 195 | is effected by exercising rights under this License with respect to 196 | the covered work, and you disclaim any intention to limit operation or 197 | modification of the work as a means of enforcing, against the work's 198 | users, your or third parties' legal rights to forbid circumvention of 199 | technological measures. 200 | 201 | 4. Conveying Verbatim Copies. 202 | 203 | You may convey verbatim copies of the Program's source code as you 204 | receive it, in any medium, provided that you conspicuously and 205 | appropriately publish on each copy an appropriate copyright notice; 206 | keep intact all notices stating that this License and any 207 | non-permissive terms added in accord with section 7 apply to the code; 208 | keep intact all notices of the absence of any warranty; and give all 209 | recipients a copy of this License along with the Program. 210 | 211 | You may charge any price or no price for each copy that you convey, 212 | and you may offer support or warranty protection for a fee. 213 | 214 | 5. Conveying Modified Source Versions. 215 | 216 | You may convey a work based on the Program, or the modifications to 217 | produce it from the Program, in the form of source code under the 218 | terms of section 4, provided that you also meet all of these conditions: 219 | 220 | a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | 223 | b) The work must carry prominent notices stating that it is 224 | released under this License and any conditions added under section 225 | 7. This requirement modifies the requirement in section 4 to 226 | "keep intact all notices". 227 | 228 | c) You must license the entire work, as a whole, under this 229 | License to anyone who comes into possession of a copy. This 230 | License will therefore apply, along with any applicable section 7 231 | additional terms, to the whole of the work, and all its parts, 232 | regardless of how they are packaged. This License gives no 233 | permission to license the work in any other way, but it does not 234 | invalidate such permission if you have separately received it. 235 | 236 | d) If the work has interactive user interfaces, each must display 237 | Appropriate Legal Notices; however, if the Program has interactive 238 | interfaces that do not display Appropriate Legal Notices, your 239 | work need not make them do so. 240 | 241 | A compilation of a covered work with other separate and independent 242 | works, which are not by their nature extensions of the covered work, 243 | and which are not combined with it such as to form a larger program, 244 | in or on a volume of a storage or distribution medium, is called an 245 | "aggregate" if the compilation and its resulting copyright are not 246 | used to limit the access or legal rights of the compilation's users 247 | beyond what the individual works permit. Inclusion of a covered work 248 | in an aggregate does not cause this License to apply to the other 249 | parts of the aggregate. 250 | 251 | 6. Conveying Non-Source Forms. 252 | 253 | You may convey a covered work in object code form under the terms 254 | of sections 4 and 5, provided that you also convey the 255 | machine-readable Corresponding Source under the terms of this License, 256 | in one of these ways: 257 | 258 | a) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by the 260 | Corresponding Source fixed on a durable physical medium 261 | customarily used for software interchange. 262 | 263 | b) Convey the object code in, or embodied in, a physical product 264 | (including a physical distribution medium), accompanied by a 265 | written offer, valid for at least three years and valid for as 266 | long as you offer spare parts or customer support for that product 267 | model, to give anyone who possesses the object code either (1) a 268 | copy of the Corresponding Source for all the software in the 269 | product that is covered by this License, on a durable physical 270 | medium customarily used for software interchange, for a price no 271 | more than your reasonable cost of physically performing this 272 | conveying of source, or (2) access to copy the 273 | Corresponding Source from a network server at no charge. 274 | 275 | c) Convey individual copies of the object code with a copy of the 276 | written offer to provide the Corresponding Source. This 277 | alternative is allowed only occasionally and noncommercially, and 278 | only if you received the object code with such an offer, in accord 279 | with subsection 6b. 280 | 281 | d) Convey the object code by offering access from a designated 282 | place (gratis or for a charge), and offer equivalent access to the 283 | Corresponding Source in the same way through the same place at no 284 | further charge. You need not require recipients to copy the 285 | Corresponding Source along with the object code. If the place to 286 | copy the object code is a network server, the Corresponding Source 287 | may be on a different server (operated by you or a third party) 288 | that supports equivalent copying facilities, provided you maintain 289 | clear directions next to the object code saying where to find the 290 | Corresponding Source. Regardless of what server hosts the 291 | Corresponding Source, you remain obligated to ensure that it is 292 | available for as long as needed to satisfy these requirements. 293 | 294 | e) Convey the object code using peer-to-peer transmission, provided 295 | you inform other peers where the object code and Corresponding 296 | Source of the work are being offered to the general public at no 297 | charge under subsection 6d. 298 | 299 | A separable portion of the object code, whose source code is excluded 300 | from the Corresponding Source as a System Library, need not be 301 | included in conveying the object code work. 302 | 303 | A "User Product" is either (1) a "consumer product", which means any 304 | tangible personal property which is normally used for personal, family, 305 | or household purposes, or (2) anything designed or sold for incorporation 306 | into a dwelling. In determining whether a product is a consumer product, 307 | doubtful cases shall be resolved in favor of coverage. For a particular 308 | product received by a particular user, "normally used" refers to a 309 | typical or common use of that class of product, regardless of the status 310 | of the particular user or of the way in which the particular user 311 | actually uses, or expects or is expected to use, the product. A product 312 | is a consumer product regardless of whether the product has substantial 313 | commercial, industrial or non-consumer uses, unless such uses represent 314 | the only significant mode of use of the product. 315 | 316 | "Installation Information" for a User Product means any methods, 317 | procedures, authorization keys, or other information required to install 318 | and execute modified versions of a covered work in that User Product from 319 | a modified version of its Corresponding Source. The information must 320 | suffice to ensure that the continued functioning of the modified object 321 | code is in no case prevented or interfered with solely because 322 | modification has been made. 323 | 324 | If you convey an object code work under this section in, or with, or 325 | specifically for use in, a User Product, and the conveying occurs as 326 | part of a transaction in which the right of possession and use of the 327 | User Product is transferred to the recipient in perpetuity or for a 328 | fixed term (regardless of how the transaction is characterized), the 329 | Corresponding Source conveyed under this section must be accompanied 330 | by the Installation Information. But this requirement does not apply 331 | if neither you nor any third party retains the ability to install 332 | modified object code on the User Product (for example, the work has 333 | been installed in ROM). 334 | 335 | The requirement to provide Installation Information does not include a 336 | requirement to continue to provide support service, warranty, or updates 337 | for a work that has been modified or installed by the recipient, or for 338 | the User Product in which it has been modified or installed. Access to a 339 | network may be denied when the modification itself materially and 340 | adversely affects the operation of the network or violates the rules and 341 | protocols for communication across the network. 342 | 343 | Corresponding Source conveyed, and Installation Information provided, 344 | in accord with this section must be in a format that is publicly 345 | documented (and with an implementation available to the public in 346 | source code form), and must require no special password or key for 347 | unpacking, reading or copying. 348 | 349 | 7. Additional Terms. 350 | 351 | "Additional permissions" are terms that supplement the terms of this 352 | License by making exceptions from one or more of its conditions. 353 | Additional permissions that are applicable to the entire Program shall 354 | be treated as though they were included in this License, to the extent 355 | that they are valid under applicable law. If additional permissions 356 | apply only to part of the Program, that part may be used separately 357 | under those permissions, but the entire Program remains governed by 358 | this License without regard to the additional permissions. 359 | 360 | When you convey a copy of a covered work, you may at your option 361 | remove any additional permissions from that copy, or from any part of 362 | it. (Additional permissions may be written to require their own 363 | removal in certain cases when you modify the work.) You may place 364 | additional permissions on material, added by you to a covered work, 365 | for which you have or can give appropriate copyright permission. 366 | 367 | Notwithstanding any other provision of this License, for material you 368 | add to a covered work, you may (if authorized by the copyright holders of 369 | that material) supplement the terms of this License with terms: 370 | 371 | a) Disclaiming warranty or limiting liability differently from the 372 | terms of sections 15 and 16 of this License; or 373 | 374 | b) Requiring preservation of specified reasonable legal notices or 375 | author attributions in that material or in the Appropriate Legal 376 | Notices displayed by works containing it; or 377 | 378 | c) Prohibiting misrepresentation of the origin of that material, or 379 | requiring that modified versions of such material be marked in 380 | reasonable ways as different from the original version; or 381 | 382 | d) Limiting the use for publicity purposes of names of licensors or 383 | authors of the material; or 384 | 385 | e) Declining to grant rights under trademark law for use of some 386 | trade names, trademarks, or service marks; or 387 | 388 | f) Requiring indemnification of licensors and authors of that 389 | material by anyone who conveys the material (or modified versions of 390 | it) with contractual assumptions of liability to the recipient, for 391 | any liability that these contractual assumptions directly impose on 392 | those licensors and authors. 393 | 394 | All other non-permissive additional terms are considered "further 395 | restrictions" within the meaning of section 10. If the Program as you 396 | received it, or any part of it, contains a notice stating that it is 397 | governed by this License along with a term that is a further 398 | restriction, you may remove that term. If a license document contains 399 | a further restriction but permits relicensing or conveying under this 400 | License, you may add to a covered work material governed by the terms 401 | of that license document, provided that the further restriction does 402 | not survive such relicensing or conveying. 403 | 404 | If you add terms to a covered work in accord with this section, you 405 | must place, in the relevant source files, a statement of the 406 | additional terms that apply to those files, or a notice indicating 407 | where to find the applicable terms. 408 | 409 | Additional terms, permissive or non-permissive, may be stated in the 410 | form of a separately written license, or stated as exceptions; 411 | the above requirements apply either way. 412 | 413 | 8. Termination. 414 | 415 | You may not propagate or modify a covered work except as expressly 416 | provided under this License. Any attempt otherwise to propagate or 417 | modify it is void, and will automatically terminate your rights under 418 | this License (including any patent licenses granted under the third 419 | paragraph of section 11). 420 | 421 | However, if you cease all violation of this License, then your 422 | license from a particular copyright holder is reinstated (a) 423 | provisionally, unless and until the copyright holder explicitly and 424 | finally terminates your license, and (b) permanently, if the copyright 425 | holder fails to notify you of the violation by some reasonable means 426 | prior to 60 days after the cessation. 427 | 428 | Moreover, your license from a particular copyright holder is 429 | reinstated permanently if the copyright holder notifies you of the 430 | violation by some reasonable means, this is the first time you have 431 | received notice of violation of this License (for any work) from that 432 | copyright holder, and you cure the violation prior to 30 days after 433 | your receipt of the notice. 434 | 435 | Termination of your rights under this section does not terminate the 436 | licenses of parties who have received copies or rights from you under 437 | this License. If your rights have been terminated and not permanently 438 | reinstated, you do not qualify to receive new licenses for the same 439 | material under section 10. 440 | 441 | 9. Acceptance Not Required for Having Copies. 442 | 443 | You are not required to accept this License in order to receive or 444 | run a copy of the Program. Ancillary propagation of a covered work 445 | occurring solely as a consequence of using peer-to-peer transmission 446 | to receive a copy likewise does not require acceptance. However, 447 | nothing other than this License grants you permission to propagate or 448 | modify any covered work. These actions infringe copyright if you do 449 | not accept this License. Therefore, by modifying or propagating a 450 | covered work, you indicate your acceptance of this License to do so. 451 | 452 | 10. Automatic Licensing of Downstream Recipients. 453 | 454 | Each time you convey a covered work, the recipient automatically 455 | receives a license from the original licensors, to run, modify and 456 | propagate that work, subject to this License. You are not responsible 457 | for enforcing compliance by third parties with this License. 458 | 459 | An "entity transaction" is a transaction transferring control of an 460 | organization, or substantially all assets of one, or subdividing an 461 | organization, or merging organizations. If propagation of a covered 462 | work results from an entity transaction, each party to that 463 | transaction who receives a copy of the work also receives whatever 464 | licenses to the work the party's predecessor in interest had or could 465 | give under the previous paragraph, plus a right to possession of the 466 | Corresponding Source of the work from the predecessor in interest, if 467 | the predecessor has it or can get it with reasonable efforts. 468 | 469 | You may not impose any further restrictions on the exercise of the 470 | rights granted or affirmed under this License. For example, you may 471 | not impose a license fee, royalty, or other charge for exercise of 472 | rights granted under this License, and you may not initiate litigation 473 | (including a cross-claim or counterclaim in a lawsuit) alleging that 474 | any patent claim is infringed by making, using, selling, offering for 475 | sale, or importing the Program or any portion of it. 476 | 477 | 11. Patents. 478 | 479 | A "contributor" is a copyright holder who authorizes use under this 480 | License of the Program or a work on which the Program is based. The 481 | work thus licensed is called the contributor's "contributor version". 482 | 483 | A contributor's "essential patent claims" are all patent claims 484 | owned or controlled by the contributor, whether already acquired or 485 | hereafter acquired, that would be infringed by some manner, permitted 486 | by this License, of making, using, or selling its contributor version, 487 | but do not include claims that would be infringed only as a 488 | consequence of further modification of the contributor version. For 489 | purposes of this definition, "control" includes the right to grant 490 | patent sublicenses in a manner consistent with the requirements of 491 | this License. 492 | 493 | Each contributor grants you a non-exclusive, worldwide, royalty-free 494 | patent license under the contributor's essential patent claims, to 495 | make, use, sell, offer for sale, import and otherwise run, modify and 496 | propagate the contents of its contributor version. 497 | 498 | In the following three paragraphs, a "patent license" is any express 499 | agreement or commitment, however denominated, not to enforce a patent 500 | (such as an express permission to practice a patent or covenant not to 501 | sue for patent infringement). To "grant" such a patent license to a 502 | party means to make such an agreement or commitment not to enforce a 503 | patent against the party. 504 | 505 | If you convey a covered work, knowingly relying on a patent license, 506 | and the Corresponding Source of the work is not available for anyone 507 | to copy, free of charge and under the terms of this License, through a 508 | publicly available network server or other readily accessible means, 509 | then you must either (1) cause the Corresponding Source to be so 510 | available, or (2) arrange to deprive yourself of the benefit of the 511 | patent license for this particular work, or (3) arrange, in a manner 512 | consistent with the requirements of this License, to extend the patent 513 | license to downstream recipients. "Knowingly relying" means you have 514 | actual knowledge that, but for the patent license, your conveying the 515 | covered work in a country, or your recipient's use of the covered work 516 | in a country, would infringe one or more identifiable patents in that 517 | country that you have reason to believe are valid. 518 | 519 | If, pursuant to or in connection with a single transaction or 520 | arrangement, you convey, or propagate by procuring conveyance of, a 521 | covered work, and grant a patent license to some of the parties 522 | receiving the covered work authorizing them to use, propagate, modify 523 | or convey a specific copy of the covered work, then the patent license 524 | you grant is automatically extended to all recipients of the covered 525 | work and works based on it. 526 | 527 | A patent license is "discriminatory" if it does not include within 528 | the scope of its coverage, prohibits the exercise of, or is 529 | conditioned on the non-exercise of one or more of the rights that are 530 | specifically granted under this License. You may not convey a covered 531 | work if you are a party to an arrangement with a third party that is 532 | in the business of distributing software, under which you make payment 533 | to the third party based on the extent of your activity of conveying 534 | the work, and under which the third party grants, to any of the 535 | parties who would receive the covered work from you, a discriminatory 536 | patent license (a) in connection with copies of the covered work 537 | conveyed by you (or copies made from those copies), or (b) primarily 538 | for and in connection with specific products or compilations that 539 | contain the covered work, unless you entered into that arrangement, 540 | or that patent license was granted, prior to 28 March 2007. 541 | 542 | Nothing in this License shall be construed as excluding or limiting 543 | any implied license or other defenses to infringement that may 544 | otherwise be available to you under applicable patent law. 545 | 546 | 12. No Surrender of Others' Freedom. 547 | 548 | If conditions are imposed on you (whether by court order, agreement or 549 | otherwise) that contradict the conditions of this License, they do not 550 | excuse you from the conditions of this License. If you cannot convey a 551 | covered work so as to satisfy simultaneously your obligations under this 552 | License and any other pertinent obligations, then as a consequence you may 553 | not convey it at all. For example, if you agree to terms that obligate you 554 | to collect a royalty for further conveying from those to whom you convey 555 | the Program, the only way you could satisfy both those terms and this 556 | License would be to refrain entirely from conveying the Program. 557 | 558 | 13. Use with the GNU Affero General Public License. 559 | 560 | Notwithstanding any other provision of this License, you have 561 | permission to link or combine any covered work with a work licensed 562 | under version 3 of the GNU Affero General Public License into a single 563 | combined work, and to convey the resulting work. The terms of this 564 | License will continue to apply to the part which is the covered work, 565 | but the special requirements of the GNU Affero General Public License, 566 | section 13, concerning interaction through a network will apply to the 567 | combination as such. 568 | 569 | 14. Revised Versions of this License. 570 | 571 | The Free Software Foundation may publish revised and/or new versions of 572 | the GNU General Public License from time to time. Such new versions will 573 | be similar in spirit to the present version, but may differ in detail to 574 | address new problems or concerns. 575 | 576 | Each version is given a distinguishing version number. If the 577 | Program specifies that a certain numbered version of the GNU General 578 | Public License "or any later version" applies to it, you have the 579 | option of following the terms and conditions either of that numbered 580 | version or of any later version published by the Free Software 581 | Foundation. If the Program does not specify a version number of the 582 | GNU General Public License, you may choose any version ever published 583 | by the Free Software Foundation. 584 | 585 | If the Program specifies that a proxy can decide which future 586 | versions of the GNU General Public License can be used, that proxy's 587 | public statement of acceptance of a version permanently authorizes you 588 | to choose that version for the Program. 589 | 590 | Later license versions may give you additional or different 591 | permissions. However, no additional obligations are imposed on any 592 | author or copyright holder as a result of your choosing to follow a 593 | later version. 594 | 595 | 15. Disclaimer of Warranty. 596 | 597 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 598 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 599 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 600 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 601 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 602 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 603 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 604 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 605 | 606 | 16. Limitation of Liability. 607 | 608 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 609 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 610 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 611 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 612 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 613 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 614 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 615 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 616 | SUCH DAMAGES. 617 | 618 | 17. Interpretation of Sections 15 and 16. 619 | 620 | If the disclaimer of warranty and limitation of liability provided 621 | above cannot be given local legal effect according to their terms, 622 | reviewing courts shall apply local law that most closely approximates 623 | an absolute waiver of all civil liability in connection with the 624 | Program, unless a warranty or assumption of liability accompanies a 625 | copy of the Program in return for a fee. 626 | 627 | END OF TERMS AND CONDITIONS 628 | 629 | How to Apply These Terms to Your New Programs 630 | 631 | If you develop a new program, and you want it to be of the greatest 632 | possible use to the public, the best way to achieve this is to make it 633 | free software which everyone can redistribute and change under these terms. 634 | 635 | To do so, attach the following notices to the program. It is safest 636 | to attach them to the start of each source file to most effectively 637 | state the exclusion of warranty; and each file should have at least 638 | the "copyright" line and a pointer to where the full notice is found. 639 | 640 | 641 | Copyright (C) 642 | 643 | This program is free software: you can redistribute it and/or modify 644 | it under the terms of the GNU General Public License as published by 645 | the Free Software Foundation, either version 3 of the License, or 646 | (at your option) any later version. 647 | 648 | This program is distributed in the hope that it will be useful, 649 | but WITHOUT ANY WARRANTY; without even the implied warranty of 650 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 651 | GNU General Public License for more details. 652 | 653 | You should have received a copy of the GNU General Public License 654 | along with this program. If not, see . 655 | 656 | Also add information on how to contact you by electronic and paper mail. 657 | 658 | If the program does terminal interaction, make it output a short 659 | notice like this when it starts in an interactive mode: 660 | 661 | Copyright (C) 662 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 663 | This is free software, and you are welcome to redistribute it 664 | under certain conditions; type `show c' for details. 665 | 666 | The hypothetical commands `show w' and `show c' should show the appropriate 667 | parts of the General Public License. Of course, your program's commands 668 | might be different; for a GUI interface, you would use an "about box". 669 | 670 | You should also get your employer (if you work as a programmer) or school, 671 | if any, to sign a "copyright disclaimer" for the program, if necessary. 672 | For more information on this, and how to apply and follow the GNU GPL, see 673 | . 674 | 675 | The GNU General Public License does not permit incorporating your program 676 | into proprietary programs. If your program is a subroutine library, you 677 | may consider it more useful to permit linking proprietary applications with 678 | the library. If this is what you want to do, use the GNU Lesser General 679 | Public License instead of this License. But first, please read 680 | . 681 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 5 | 6 |

7 | Logo of SearXNG 8 | SearXNG, packaged for YunoHost 9 |

10 | 11 | Internet metasearch engine which aggregates results from more than 70 search services 12 | 13 | [![🌐 Official app website](https://img.shields.io/badge/Official_app_website-darkgreen?style=for-the-badge)](https://docs.searxng.org) 14 | [![App Demo](https://img.shields.io/badge/App_Demo-blue?style=for-the-badge)](https://searx.be) 15 | [![Version: 2025.06.01~ynh1](https://img.shields.io/badge/Version-2025.06.01~ynh1-rgba(0,150,0,1)?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/searxng/) 16 | 17 |
18 | 19 | 20 |
21 | 22 | ## 📦 Developer info 23 | 24 | [![Automatic tests level](https://apps.yunohost.org/badge/cilevel/searxng)](https://ci-apps.yunohost.org/ci/apps/searxng/) 25 | 26 | 🛠️ Upstream SearXNG repository: 27 | 28 | Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/searxng_ynh/tree/testing). 29 | 30 | The `testing` branch can be tested using: 31 | ``` 32 | # fresh install: 33 | sudo yunohost app install https://github.com/YunoHost-Apps/searxng_ynh/tree/testing 34 | 35 | # upgrade an existing install: 36 | sudo yunohost app upgrade searxng -u https://github.com/YunoHost-Apps/searxng_ynh/tree/testing 37 | ``` 38 | 39 | ### 📚 App packaging documentation 40 | 41 | Please see for more information. -------------------------------------------------------------------------------- /conf/nginx.conf: -------------------------------------------------------------------------------- 1 | location __PATH__/ { 2 | 3 | uwsgi_pass unix:///var/run/__APP__/app.socket; 4 | 5 | include uwsgi_params; 6 | uwsgi_param HTTP_HOST $host; 7 | uwsgi_param HTTP_CONNECTION $http_connection; 8 | 9 | # see flaskfix.py 10 | uwsgi_param HTTP_X_SCHEME $scheme; 11 | uwsgi_param HTTP_X_SCRIPT_NAME /searxng; 12 | 13 | # see limiter.py 14 | uwsgi_param HTTP_X_REAL_IP $remote_addr; 15 | uwsgi_param HTTP_X_FORWARDED_FOR $proxy_add_x_forwarded_for; 16 | 17 | # Include SSOWAT user panel. 18 | include conf.d/yunohost_panel.conf.inc; 19 | } 20 | -------------------------------------------------------------------------------- /conf/settings.yml: -------------------------------------------------------------------------------- 1 | use_default_settings: true 2 | 3 | general: 4 | instance_name: "SearXNG - __DOMAIN__" 5 | 6 | search: 7 | default_lang: "auto" 8 | 9 | server: 10 | base_url: https://__DOMAIN____PATH__ 11 | secret_key: "__SECRET_KEY__" 12 | 13 | ui: 14 | default_locale: "" 15 | -------------------------------------------------------------------------------- /conf/uwsgi.ini: -------------------------------------------------------------------------------- 1 | # -*- mode: conf; coding: utf-8 -*- 2 | [uwsgi] 3 | 4 | # uWSGI core 5 | # ---------- 6 | # 7 | # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core 8 | 9 | # Who will run the code / Hint: in emperor-tyrant mode uid & gid setting will be 10 | # ignored [1]. Mode emperor-tyrant is the default on fedora (/etc/uwsgi.ini). 11 | # 12 | # [1] https://uwsgi-docs.readthedocs.io/en/latest/Emperor.html#tyrant-mode-secure-multi-user-hosting 13 | # 14 | uid = __APP__ 15 | gid = __APP__ 16 | 17 | # set (python) default encoding UTF-8 18 | env = LANG=C.UTF-8 19 | env = LANGUAGE=C.UTF-8 20 | env = LC_ALL=C.UTF-8 21 | 22 | # chdir to specified directory before apps loading 23 | chdir = __INSTALL_DIR__/searxng-src/searx 24 | 25 | # SearXNG configuration (settings.yml) 26 | env = SEARXNG_SETTINGS_PATH=__INSTALL_DIR__/settings.yml 27 | 28 | # disable logging for privacy 29 | disable-logging = true 30 | 31 | # The right granted on the created socket 32 | chmod-socket = 666 33 | 34 | # Plugin to use and interpreter config 35 | single-interpreter = true 36 | 37 | # enable master process 38 | master = true 39 | 40 | # load apps in each worker instead of the master 41 | lazy-apps = true 42 | 43 | # load uWSGI plugins 44 | plugin = python3,http 45 | 46 | # By default the Python plugin does not initialize the GIL. This means your 47 | # app-generated threads will not run. If you need threads, remember to enable 48 | # them with enable-threads. Running uWSGI in multithreading mode (with the 49 | # threads options) will automatically enable threading support. This *strange* 50 | # default behaviour is for performance reasons. 51 | enable-threads = true 52 | 53 | # Number of workers (usually CPU count) 54 | workers = %k 55 | threads = 4 56 | 57 | # plugin: python 58 | # -------------- 59 | # 60 | # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python 61 | 62 | # load a WSGI module 63 | module = searx.webapp 64 | 65 | # set PYTHONHOME/virtualenv 66 | virtualenv = __INSTALL_DIR__/searxng-pyenv 67 | 68 | # add directory (or glob) to pythonpath 69 | pythonpath = __INSTALL_DIR__ 70 | 71 | 72 | # speak to upstream 73 | # ----------------- 74 | 75 | socket = /var/run/__APP__/app.socket 76 | buffer-size = 8192 77 | 78 | # uWSGI serves the static files and in settings.yml we use:: 79 | # 80 | # ui: 81 | # static_use_hash: true 82 | # 83 | static-map = /static=__INSTALL_DIR__/searxng-src/searx/static 84 | # expires set to one day 85 | static-expires = /* 86400 86 | static-gzip-all = True 87 | offload-threads = %k 88 | -------------------------------------------------------------------------------- /doc/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/searxng_ynh/8c11c351f204ff9947e01074a9f877dcbd9cf01e/doc/.gitkeep -------------------------------------------------------------------------------- /doc/ADMIN.md: -------------------------------------------------------------------------------- 1 | The app install dir is `__INSTALL_DIR__`. 2 | 3 | You can set your custom settings in `__INSTALL_DIR__/settings.yml`. That file overwrite the default settings thanks to `use_default_settings: true` 4 | 5 | The default settings are available at `__INSTALL_DIR__/searxng-src/searx/settings.yml`. It is recommended to not edit this file directly and to make changes only in the file mentioned above. 6 | 7 | Please note that this application is a rolling-release (i.e. each commit is a release) and thus is updated very regularly. People not updating frequently may encounter some bugs or disruptions due to the very nature of this software. 8 | -------------------------------------------------------------------------------- /doc/DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | SearxXNG is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. 2 | -------------------------------------------------------------------------------- /doc/screenshots/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/searxng_ynh/8c11c351f204ff9947e01074a9f877dcbd9cf01e/doc/screenshots/.gitkeep -------------------------------------------------------------------------------- /doc/screenshots/screenshot_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/searxng_ynh/8c11c351f204ff9947e01074a9f877dcbd9cf01e/doc/screenshots/screenshot_1.png -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | packaging_format = 2 2 | 3 | id = "searxng" 4 | name = "SearXNG" 5 | description.en = "Internet metasearch engine which aggregates results from more than 70 search services" 6 | description.fr = "Méta-moteur de recherche qui rassemble les résultats de plus de 70 services de recherche" 7 | 8 | version = "2025.06.01~ynh1" 9 | 10 | maintainers = ["ewilly"] 11 | 12 | [upstream] 13 | license = "AGPL-3.0-or-later" 14 | website = "https://docs.searxng.org" 15 | demo = "https://searx.be" 16 | admindoc = "https://docs.searxng.org/admin/" 17 | userdoc = "https://docs.searxng.org/user/" 18 | code = "https://github.com/searxng/searxng" 19 | 20 | [integration] 21 | yunohost = ">= 11.2.30" 22 | helpers_version = "2.1" 23 | architectures = "all" 24 | multi_instance = false 25 | ldap = "not_relevant" 26 | sso = "not_relevant" 27 | disk = "210M" 28 | ram.build = "250M" 29 | ram.runtime = "200M" 30 | 31 | [install] 32 | [install.domain] 33 | type = "domain" 34 | 35 | [install.path] 36 | type = "path" 37 | default = "/searxng" 38 | 39 | [install.init_main_permission] 40 | type = "group" 41 | default = "visitors" 42 | 43 | [resources] 44 | [resources.sources] 45 | 46 | [resources.sources.main] 47 | url = "https://github.com/searxng/searxng/archive/d63bdcd773b05d3a119cc0c710ba424d87172f93.tar.gz" 48 | sha256 = "92145593f4a150e07dc547489e700608ac8d8371ec8767c3fb445b08c9f30a55" 49 | autoupdate.strategy = "latest_github_commit" 50 | 51 | [resources.system_user] 52 | 53 | [resources.install_dir] 54 | dir = "/var/www/__APP__" 55 | 56 | [resources.permissions] 57 | main.url = "/" 58 | 59 | [resources.apt] 60 | packages = "python3-dev, python3-babel, python3-venv, uwsgi, uwsgi-plugin-python3, git, build-essential, libxslt-dev, zlib1g-dev, libffi-dev, libssl-dev" 61 | -------------------------------------------------------------------------------- /scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # COMMON VARIABLES AND CUSTOM HELPERS 5 | #================================================= 6 | 7 | # Install/Upgrade SearXNG in virtual environement 8 | myynh_source_searxng () { 9 | # Retrieve info from manifest 10 | repo_fullpath=$(ynh_read_manifest "upstream.code") 11 | commit_sha=$(ynh_read_manifest "resources.sources.main.url" | xargs basename --suffix=".tar.gz") 12 | 13 | # Download source 14 | sudo -H -u $app -i bash << EOF 15 | mkdir "$install_dir/searxng-src" 16 | git clone -n "$repo_fullpath" "$install_dir/searxng-src" 2>&1 17 | EOF 18 | 19 | # Checkout commit 20 | pushd "$install_dir/searxng-src" 21 | sudo -H -u $app -i bash << EOF 22 | cd "$install_dir/searxng-src" 23 | git checkout "$commit_sha" 2>&1 24 | EOF 25 | popd 26 | } 27 | 28 | myynh_install_searxng () { 29 | # Create the virtual environment 30 | sudo -H -u $app -i bash << EOF 31 | python3 -m venv "$install_dir/searxng-pyenv" 32 | echo ". $install_dir/searxng-pyenv/bin/activate" > "$install_dir/.profile" 33 | EOF 34 | 35 | # Check if virtualenv was sourced from the login 36 | sudo -H -u $app -i bash << EOF 37 | command -v python && python --version 38 | EOF 39 | 40 | sudo -H -u $app -i bash << EOF 41 | pip install --upgrade pip 42 | pip install --upgrade setuptools 43 | pip install --upgrade wheel 44 | pip install --upgrade pyyaml 45 | pip install --upgrade pybind11 46 | pip install --upgrade tomli 47 | cd "$install_dir/searxng-src" 48 | pip install --use-pep517 --no-build-isolation -e . 49 | EOF 50 | } 51 | 52 | # Set permissions 53 | myynh_set_permissions () { 54 | chown -R $app: "$install_dir" 55 | chmod u=rwX,g=rX,o= "$install_dir" 56 | chmod -R o-rwx "$install_dir" 57 | 58 | chown $app:root "/etc/uwsgi/apps-available/$app.ini" 59 | chown -R $app:root "/etc/systemd/system/uwsgi-app@$app.service.d" || true 60 | 61 | chown $app:root "/var/log/uwsgi/$app" 62 | chmod -R u=rwX,g=rX,o= "/var/log/uwsgi/$app" 63 | } 64 | 65 | #================================================= 66 | # UWSGI HELPERS 67 | #================================================= 68 | 69 | # Check if system wide templates are available and correcly configured 70 | # 71 | # usage: ynh_check_global_uwsgi_config 72 | ynh_check_global_uwsgi_config () { 73 | uwsgi --version || ynh_die "You need to add uwsgi (and appropriate plugin) as a dependency" 74 | 75 | cat > "/etc/systemd/system/uwsgi-app@.service" < uwsgi-app@app` 114 | ynh_add_uwsgi_service () { 115 | ynh_check_global_uwsgi_config 116 | 117 | local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini" 118 | 119 | # www-data group is needed since it is this nginx who will start the service 120 | usermod --append --groups www-data "$app" || ynh_die "It wasn't possible to add user $app to group www-data" 121 | 122 | ynh_config_add --template="uwsgi.ini" --destination="$finaluwsgiini" 123 | ynh_store_file_checksum "$finaluwsgiini" 124 | chown $app:root "$finaluwsgiini" 125 | 126 | # make sure the folder for logs exists and set authorizations 127 | mkdir -p "/var/log/uwsgi/$app" 128 | 129 | # Setup specific Systemd rules if necessary 130 | mkdir -p "/etc/systemd/system/uwsgi-app@$app.service.d" 131 | if [ -e "../conf/uwsgi-app@override.service" ] 132 | then 133 | ynh_config_add --template="uwsgi-app@override.service" --destination="/etc/systemd/system/uwsgi-app@$app.service.d/override.conf" 134 | fi 135 | 136 | systemctl daemon-reload 137 | ynh_systemctl --service="uwsgi-app@$app.service" --action="enable" 138 | 139 | # Add as a service 140 | yunohost service add "uwsgi-app@$app" --description="uWSGI service for searxng" --log "/var/log/uwsgi/$app/$app.log" 141 | } 142 | 143 | # Remove the dedicated uwsgi ini file 144 | # 145 | # usage: ynh_remove_uwsgi_service 146 | ynh_remove_uwsgi_service () { 147 | local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini" 148 | if [ -e "$finaluwsgiini" ] 149 | then 150 | yunohost service remove "uwsgi-app@$app" 151 | ynh_systemctl --service="uwsgi-app@$app.service" --action="stop" 152 | ynh_systemctl --service="uwsgi-app@$app.service" --action="disable" 153 | 154 | ynh_safe_rm "$finaluwsgiini" 155 | ynh_safe_rm "/var/log/uwsgi/$app" 156 | ynh_safe_rm "/etc/systemd/system/uwsgi-app@$app.service.d" 157 | fi 158 | } 159 | 160 | # Backup the dedicated uwsgi config 161 | # Should be used in backup script 162 | # 163 | # usage: ynh_backup_uwsgi_service 164 | ynh_backup_uwsgi_service () { 165 | ynh_backup "/etc/uwsgi/apps-available/$app.ini" 166 | ynh_backup "/etc/systemd/system/uwsgi-app@$app.service.d" || true 167 | } 168 | 169 | # Restore the dedicated uwsgi config 170 | # Should be used in restore script 171 | # 172 | # usage: ynh_restore_uwsgi_service 173 | ynh_restore_uwsgi_service () { 174 | ynh_check_global_uwsgi_config 175 | ynh_restore "/etc/uwsgi/apps-available/$app.ini" 176 | ynh_restore "/etc/systemd/system/uwsgi-app@$app.service.d" || true 177 | 178 | mkdir -p "/var/log/uwsgi/$app" 179 | 180 | ynh_systemctl --service="uwsgi-app@$app.service" --action="enable" 181 | yunohost service add "uwsgi-app@$app" --description="uWSGI service for searxng" --log "/var/log/uwsgi/$app/$app.log" 182 | } 183 | -------------------------------------------------------------------------------- /scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source ../settings/scripts/_common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | ynh_print_info "Declaring files to be backed up..." 7 | 8 | #================================================= 9 | # BACKUP THE APP MAIN DIR 10 | #================================================= 11 | 12 | ynh_backup "$install_dir" 13 | 14 | #================================================= 15 | # BACKUP THE NGINX CONFIGURATION 16 | #================================================= 17 | 18 | ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" 19 | 20 | #================================================= 21 | # BACKUP UWSGI CONFIG 22 | #================================================= 23 | 24 | ynh_backup_uwsgi_service 25 | 26 | #================================================= 27 | # END OF SCRIPT 28 | #================================================= 29 | 30 | ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." 31 | -------------------------------------------------------------------------------- /scripts/change_url: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # STOP SYSTEMD SERVICE 8 | #================================================= 9 | ynh_script_progression "Stopping $app's systemd service..." 10 | 11 | ynh_systemctl --service="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log" 12 | 13 | #================================================= 14 | # MODIFY URL IN NGINX CONF 15 | #================================================= 16 | ynh_script_progression "Updating NGINX web server configuration..." 17 | 18 | ynh_config_change_url_nginx 19 | 20 | #================================================= 21 | # RECONFIGURING SEARXNG 22 | #================================================= 23 | ynh_script_progression "Reconfiguring SearXNG..." 24 | 25 | ynh_replace --match="base_url: https://$old_domain$old_path" --replace="base_url: https://$new_domain$new_path" --file="$install_dir/settings.yml" 26 | ynh_replace --match="instance_name: SearXNG - $old_domain" --replace="instance_name: SearXNG - $new_domain" --file="$install_dir/settings.yml" 27 | 28 | #================================================= 29 | # START SYSTEMD SERVICE 30 | #================================================= 31 | ynh_script_progression "Starting $app's systemd service..." 32 | 33 | ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --log_path="/var/log/uwsgi/$app/$app.log" 34 | 35 | #================================================= 36 | # END OF SCRIPT 37 | #================================================= 38 | 39 | ynh_script_progression "Change of URL completed for $app" 40 | -------------------------------------------------------------------------------- /scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # DOWNLOAD, CHECK AND UNPACK SOURCE 8 | #================================================= 9 | ynh_script_progression "Setting up source files..." 10 | myynh_source_searxng 11 | 12 | ynh_script_progression "Installing SearXNG..." 13 | 14 | myynh_install_searxng 15 | 16 | #================================================= 17 | # SYSTEM CONFIGURATION 18 | #================================================= 19 | ynh_script_progression "Adding system configurations related to $app..." 20 | 21 | ynh_config_add_nginx 22 | 23 | ynh_add_uwsgi_service 24 | 25 | #================================================= 26 | # APP INITIAL CONFIGURATION 27 | #================================================= 28 | # ADD A CONFIGURATION 29 | #================================================= 30 | ynh_script_progression "Adding $app's configuration..." 31 | 32 | secret_key=$(ynh_string_random) 33 | ynh_config_add --template="settings.yml" --destination="$install_dir/settings.yml" 34 | 35 | myynh_set_permissions 36 | 37 | #================================================= 38 | # START SYSTEMD SERVICE 39 | #================================================= 40 | ynh_script_progression "Starting $app's systemd service..." 41 | 42 | ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --wait_until="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log" 43 | 44 | #================================================= 45 | # END OF SCRIPT 46 | #================================================= 47 | 48 | ynh_script_progression "Installation of $app completed" 49 | -------------------------------------------------------------------------------- /scripts/remove: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # REMOVE SYSTEM CONFIGURATIONS 8 | #================================================= 9 | ynh_script_progression "Removing system configurations related to $app..." 10 | 11 | ynh_config_remove_nginx 12 | 13 | ynh_remove_uwsgi_service 14 | 15 | #================================================= 16 | # END OF SCRIPT 17 | #================================================= 18 | 19 | ynh_script_progression "Removal of $app completed" 20 | -------------------------------------------------------------------------------- /scripts/restore: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source ../settings/scripts/_common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # RESTORE THE APP MAIN DIR 8 | #================================================= 9 | ynh_script_progression "Restoring the app main directory..." 10 | 11 | ynh_restore "$install_dir" 12 | 13 | #================================================= 14 | # RESTORE SYSTEM CONFIGURATIONS 15 | #================================================= 16 | 17 | ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf" 18 | 19 | ynh_restore_uwsgi_service 20 | 21 | myynh_set_permissions 22 | 23 | #================================================= 24 | # RELOAD NGINX AND PHP-FPM OR THE APP SERVICE 25 | #================================================= 26 | ynh_script_progression "Reloading NGINX web server and $app's service..." 27 | 28 | ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --wait_until="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log" 29 | 30 | ynh_systemctl --service="nginx" --action="reload" 31 | 32 | #================================================= 33 | # END OF SCRIPT 34 | #================================================= 35 | 36 | ynh_script_progression "Restoration completed for $app" 37 | -------------------------------------------------------------------------------- /scripts/upgrade: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # ENSURE DOWNWARD COMPATIBILITY 8 | #================================================= 9 | ynh_script_progression "Ensuring downward compatibility..." 10 | 11 | if [ -e "$install_dir/searx" ]; then 12 | tempdir="$(mktemp -d)" 13 | mv "$install_dir/searx/settings.yml" "$tempdir/settings.yml" 14 | sed -i '1s/^/use_default_settings: true\n\n/' "$tempdir/settings.yml" 15 | ynh_safe_rm "$install_dir" 16 | mkdir "$install_dir" 17 | mv "$tempdir/settings.yml" "$install_dir/settings.yml" 18 | ynh_safe_rm "$tempdir" 19 | ynh_store_file_checksum "$install_dir/settings.yml" 20 | ynh_delete_file_checksum "/opt/yunohost/$app/searx/settings.yml" 21 | fi 22 | 23 | ynh_delete_file_checksum "etc/nginx_conf.d/$domain/$app.conf" 24 | 25 | #================================================= 26 | # STOP SYSTEMD SERVICE 27 | #================================================= 28 | ynh_script_progression "Stopping $app's systemd service..." 29 | 30 | ynh_systemctl --service="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log" 31 | 32 | #================================================= 33 | # DOWNLOAD, CHECK AND UNPACK SOURCE 34 | #================================================= 35 | 36 | # FIXME: this is still supported but the recommendation is now to *always* re-setup the app sources wether or not the upstream sources changed 37 | if ynh_app_upstream_version_changed 38 | then 39 | ynh_safe_rm "$install_dir/.profile" 40 | ynh_safe_rm "$install_dir/.cache" 41 | ynh_safe_rm "$install_dir/searxng-src" 42 | ynh_safe_rm "$install_dir/searxng-pyenv" 43 | myynh_source_searxng 44 | myynh_install_searxng 45 | fi 46 | 47 | myynh_set_permissions 48 | 49 | #================================================= 50 | # REAPPLY SYSTEM CONFIGURATIONS 51 | #================================================= 52 | ynh_script_progression "Upgrading system configurations related to $app..." 53 | 54 | ynh_config_add_nginx 55 | 56 | #================================================= 57 | # UPDATE A CONFIG FILE 58 | #================================================= 59 | ynh_script_progression "Updating configuration..." 60 | 61 | ynh_add_uwsgi_service 62 | 63 | #================================================= 64 | # START SYSTEMD SERVICE 65 | #================================================= 66 | ynh_script_progression "Starting $app's systemd service..." 67 | 68 | ynh_systemctl --service="uwsgi-app@$app.service" --action="start" --wait_until="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log" 69 | 70 | #================================================= 71 | # END OF SCRIPT 72 | #================================================= 73 | 74 | ynh_script_progression "Upgrade of $app completed" 75 | -------------------------------------------------------------------------------- /tests.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json 2 | 3 | test_format = 1.0 4 | 5 | [default] 6 | 7 | # ------------ 8 | # Tests to run 9 | # ------------ 10 | 11 | # ------------------------------- 12 | # Default args to use for install 13 | # ------------------------------- 14 | 15 | # ------------------------------- 16 | # Commits to test upgrade from 17 | # ------------------------------- 18 | 19 | # test_upgrade_from.2449e06fe722660691cc93c83ff0eb1a52baffd7.name = "Upgrade from 2025.02.14~ynh1" 20 | --------------------------------------------------------------------------------