searx_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Searx for YunoHost

[![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)

[![Install Searx with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Searx quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

Privacy-respecting, hackable metasearch engine


**Shipped version:** 1.1.0~ynh2

**Demo:** https://demo.yunohost.org/searx/

## Screenshots

![Screenshot of Searx](./doc/screenshots/Screenshot.png)

## Disclaimers / important information

As of 2023-09-07, SearX is now unmaintained upstream (cf. [commit](https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3)). 
Installation is discouraged.

SearXNG is a potential alternative, already packaged for YunoHost.

## :red_circle: Antifeatures

- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc.

## Documentation and resources

* Official app website: <https://searx.github.io/searx/>
* Official admin documentation: <https://github.com/searx/searx/wiki>
* Upstream app code repository: <https://github.com/searx/searx>
* YunoHost documentation for this app: <https://yunohost.org/app_searx>
* Report a bug: <https://github.com/YunoHost-Apps/searx_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/searx_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug
or
sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>