YunoHost-Apps/searx_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/searx_ynh.git synced 2024-09-03 20:16:30 +02:00
Code Issues Activity Actions

Merge pull request #110 from YunoHost-Apps/testing

Browse source 
Apply last example_ynh
This commit is contained in:
yalh76 2022-07-13 17:28:29 +02:00 • committed by GitHub
commit 51007aa202
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 134 additions and 121 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -5,7 +5,7 @@ It shall NOT be edited by hand.
# Searx for YunoHost # Searx for YunoHost
[![Integration level](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) [![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) [![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)* *[Lire ce readme en français.](./README_fr.md)*
@ -17,31 +17,37 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
Privacy-respecting, hackable metasearch engine Privacy-respecting, hackable metasearch engine
**Shipped version:** 1.0.0~ynh5
**Shipped version:** 1.0.0~ynh6
**Demo:** https://demo.yunohost.org/searx/ **Demo:** https://demo.yunohost.org/searx/
## Screenshots ## Screenshots
![](./doc/screenshots/Screenshot.png) ![Screenshot of Searx](./doc/screenshots/Screenshot.png)
## Disclaimers / important information
## Documentation and resources ## Documentation and resources
* Official app website: https://searx.github.io/searx/ * Official app website: <https://searx.github.io/searx/>
* Official admin documentation: https://github.com/searx/searx/wiki * Official admin documentation: <https://github.com/searx/searx/wiki>
* Upstream app code repository: https://github.com/searx/searx * Upstream app code repository: <https://github.com/searx/searx>
* YunoHost documentation for this app: https://yunohost.org/app_searx * YunoHost documentation for this app: <https://yunohost.org/app_searx>
* Report a bug: https://github.com/YunoHost-Apps/searx_ynh/issues * Report a bug: <https://github.com/YunoHost-Apps/searx_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). 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. To try the testing branch, please proceed like that.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug
or or
sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug 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 **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

34
README_fr.md
View file

@ -1,43 +1,53 @@
<!--
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 pour YunoHost # Searx pour YunoHost
[![Niveau d'intégration](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) [![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)
[![Installer Searx avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) [![Installer Searx avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Searx rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Searx rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
Méta-moteur de recherche respectueux de la vie privée et bidouillable Privacy-respecting, hackable metasearch engine
**Version incluse :** 1.0.0~ynh5
**Version incluse :** 1.0.0~ynh6
**Démo :** https://demo.yunohost.org/searx/ **Démo :** https://demo.yunohost.org/searx/
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/Screenshot.png) ![Capture d'écran de Searx](./doc/screenshots/Screenshot.png)
## Avertissements / informations importantes
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://searx.github.io/searx/ * Site officiel de l'app : <https://searx.github.io/searx/>
* Documentation officielle de l'admin : https://github.com/searx/searx/wiki * Documentation officielle de l'admin : <https://github.com/searx/searx/wiki>
* Dépôt de code officiel de l'app : https://github.com/searx/searx * Dépôt de code officiel de l'app : <https://github.com/searx/searx>
* Documentation YunoHost pour cette app : https://yunohost.org/app_searx * Documentation YunoHost pour cette app : <https://yunohost.org/app_searx>
* Signaler un bug : https://github.com/YunoHost-Apps/searx_ynh/issues * Signaler un bug : <https://github.com/YunoHost-Apps/searx_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/searx_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>

9
check_process
View file

@ -12,16 +12,13 @@
setup_public=1 setup_public=1
upgrade=1 upgrade=1
# 1.0.0~ynh1 # 1.0.0~ynh1
#upgrade=1 from_commit=24d48bd0e1268cae80a496855dbd9d404cd555ca #upgrade=1 from_commit=24d48bd0e1268cae80a496855dbd9d404cd555ca
# 1.0.0~ynh5 # 1.0.0~ynh5
upgrade=1 from_commit=1466ec2bc358ba4556c3b8d0725a914b3da69648 upgrade=1 from_commit=38db4d43e2d5e5e8939a6a0d57dd5fe8bcb8f7a9
backup_restore=1 backup_restore=1
multi_instance=0 multi_instance=0
port_already_use=0
change_url=1 change_url=1
;;; Options ;;; Options
Email= Email=
Notification=none Notification=none
;;; Upgrade options
; commit=24d48bd0e1268cae80a496855dbd9d404cd555ca
name=Merge pull request #84
manifest_arg=domain=DOMAIN&path=PATH&is_public=1&

1
conf/app.src
View file

@ -4,3 +4,4 @@ SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true SOURCE_IN_SUBDIR=true
SOURCE_FILENAME=searx.tar.gz SOURCE_FILENAME=searx.tar.gz
SOURCE_EXTRACT=true

18
conf/nginx.conf
View file

@ -1,15 +1,15 @@
#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
location __PATH__/ { location __PATH__/ {
uwsgi_param SCRIPT_NAME '__PATH_NO_ROOT__'; uwsgi_param SCRIPT_NAME '__PATH_NO_ROOT__';
include uwsgi_params; include uwsgi_params;
uwsgi_modifier1 30; uwsgi_modifier1 30;
uwsgi_pass unix:///var/run/__NAME__/app.socket; uwsgi_pass unix:///var/run/__NAME__/app.socket;
#location __PATH__/searx/static/ { #location __PATH__/searx/static/ {
# alias __FINALPATH__/searx/static/; # alias __FINALPATH__/searx/static/;
#} #}
# Include SSOWAT user panel. # Include SSOWAT user panel.
include conf.d/yunohost_panel.conf.inc; include conf.d/yunohost_panel.conf.inc;
} }

1
doc/DESCRIPTION.md Normal file
View file

@ -0,0 +1 @@
Privacy-respecting, hackable metasearch engine

1
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1 @@

84
manifest.json
View file

@ -1,56 +1,56 @@
{ {
"name": "Searx", "name": "Searx",
"id": "searx", "id": "searx",
"packaging_format": 1, "packaging_format": 1,
"description": { "description": {
"en": "Privacy-respecting, hackable metasearch engine", "en": "Privacy-respecting, hackable metasearch engine",
"fr": "Méta-moteur de recherche respectueux de la vie privée et bidouillable", "fr": "Méta-moteur de recherche respectueux de la vie privée et bidouillable",
"de": "Meta-Suchmaschine, die den Privatsphäre wahrt und 'hackable' ist" "de": "Meta-Suchmaschine, die den Privatsphäre wahrt und 'hackable' ist"
}, },
"version": "1.0.0~ynh5", "version": "1.0.0~ynh6",
"url": "https://searx.github.io/searx/", "url": "https://searx.github.io/searx/",
"upstream": { "upstream": {
"license": "AGPL-3.0-or-later", "license": "AGPL-3.0-or-later",
"website": "https://searx.github.io/searx/", "website": "https://searx.github.io/searx/",
"demo": "https://demo.yunohost.org/searx/", "demo": "https://demo.yunohost.org/searx/",
"admindoc": "https://github.com/searx/searx/wiki", "admindoc": "https://github.com/searx/searx/wiki",
"code": "https://github.com/searx/searx" "code": "https://github.com/searx/searx"
}, },
"license": "AGPL-3.0-or-later", "license": "AGPL-3.0-or-later",
"maintainer": { "maintainer": {
"name": "opi", "name": "",
"email": "opi@zeropi.net" "email": ""
}, },
"requirements": { "requirements": {
"yunohost": ">= 4.3.0" "yunohost": ">= 4.3.0"
}, },
"multi_instance": false, "multi_instance": false,
"services": [ "services": [
"nginx", "nginx",
"uwsgi" "uwsgi"
], ],
"arguments": { "arguments": {
"install" : [ "install": [
{ {
"name": "domain", "name": "domain",
"type": "domain" "type": "domain"
}, },
{ {
"name": "path", "name": "path",
"type": "path", "type": "path",
"example": "/searx", "example": "/searx",
"default": "/searx" "default": "/searx"
}, },
{ {
"name": "is_public", "name": "is_public",
"type": "boolean", "type": "boolean",
"help": { "help": {
"en": "If enabled, Searx will be accessible by people who do not have an account. This can be changed later via the webadmin.", "en": "If enabled, Searx will be accessible by people who do not have an account. This can be changed later via the webadmin.",
"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.", "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.",
"de": "Wenn aktiviert, ist Searx für Personen zugänglich, die kein Konto haben. Dies kann später über den Webadmin geändert werden" "de": "Wenn aktiviert, ist Searx für Personen zugänglich, die kein Konto haben. Dies kann später über den Webadmin geändert werden"
}, },
"default": true "default": true
} }
] ]
} }
} }

11
scripts/_common.sh
View file

@ -130,6 +130,17 @@ ynh_remove_uwsgi_service () {
ynh_secure_remove --file="/var/log/uwsgi/$app" ynh_secure_remove --file="/var/log/uwsgi/$app"
ynh_secure_remove --file="/etc/systemd/system/uwsgi-app@$app.service.d" ynh_secure_remove --file="/etc/systemd/system/uwsgi-app@$app.service.d"
fi fi
if [ -e /etc/init.d/uwsgi ]
then
# Redémarre le service uwsgi si il n'est pas désinstallé.
ynh_systemd_action --service_name=uwsgi --action=start
else
if yunohost service status | grep -q uwsgi
then
ynh_print_info --message="Remove uwsgi service"
yunohost service remove uwsgi
fi
fi
} }

2
scripts/install
View file

@ -138,6 +138,8 @@ ynh_script_progression --message="Configuring permissions..." --weight=2
# Make app public if necessary # Make app public if necessary
if [ $is_public -eq 1 ] if [ $is_public -eq 1 ]
then then
# Everyone can access the app.
# The "main" permission is automatically created before the install script.
ynh_permission_update --permission="main" --add="visitors" ynh_permission_update --permission="main" --add="visitors"
fi fi

18
scripts/remove
View file

@ -54,22 +54,6 @@ ynh_script_progression --message="Removing dependencies..." --weight=3
# Remove metapackage and its dependencies # Remove metapackage and its dependencies
ynh_remove_app_dependencies ynh_remove_app_dependencies
#=================================================
# REMOVE SERVICE FROM ADMIN PANEL
#=================================================
if [ -e /etc/init.d/uwsgi ]
then
# Redémarre le service uwsgi si il n'est pas désinstallé.
ynh_systemd_action --service_name=uwsgi --action=start
else
if yunohost service status | grep -q uwsgi
then
ynh_print_info --message="Remove uwsgi service"
yunohost service remove uwsgi
fi
fi
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================
@ -84,4 +68,4 @@ ynh_system_user_delete --username=$app
# END OF SCRIPT # END OF SCRIPT
#================================================= #=================================================
ynh_script_progression --message="Removal of Searx completed" --last ynh_script_progression --message="Removal of $app completed" --last

16
scripts/restore
View file

@ -41,13 +41,6 @@ test ! -d $final_path \
#================================================= #=================================================
# STANDARD RESTORATION STEPS # STANDARD RESTORATION STEPS
#=================================================
# RESTORE THE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Restoring the NGINX web server configuration..."
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#================================================= #=================================================
# RECREATE THE DEDICATED USER # RECREATE THE DEDICATED USER
#================================================= #=================================================
@ -77,6 +70,13 @@ ynh_script_progression --message="Reinstalling dependencies..." --weight=35
# Define and install dependencies # Define and install dependencies
ynh_install_app_dependencies $pkg_dependencies ynh_install_app_dependencies $pkg_dependencies
#=================================================
# RESTORE THE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Restoring the NGINX web server configuration..."
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#================================================= #=================================================
# RESTORE VARIOUS FILES # RESTORE VARIOUS FILES
#================================================= #=================================================
@ -109,4 +109,4 @@ ynh_systemd_action --service_name=nginx --action=reload
# END OF SCRIPT # END OF SCRIPT
#================================================= #=================================================
ynh_script_progression --message="Restoration completed for Searx" --last ynh_script_progression --message="Restoration completed for $app" --last

34
scripts/upgrade
View file

@ -83,21 +83,28 @@ then
ynh_script_progression --message="Upgrading source files..." --weight=3 ynh_script_progression --message="Upgrading source files..." --weight=3
# Create a temporary directory # Create a temporary directory
tmpdir="$(mktemp -d)" tmpdir="$(mktemp -d)"
# Backup the config file in the temp dir # Backup the config file in the temp dir
cp -a "$final_path/searx/settings.yml" "$tmpdir/settings.yml" cp -a "$final_path/searx/settings.yml" "$tmpdir/settings.yml"
# Download, check integrity, uncompress and patch the source from app.src # Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path" ynh_setup_source --dest_dir="$final_path"
# Copy the admin saved settings from tmp directory to final path # Copy the admin saved settings from tmp directory to final path
cp -a "$tmpdir/settings.yml" "$final_path/searx/settings.yml" cp -a "$tmpdir/settings.yml" "$final_path/searx/settings.yml"
# Remove the tmp directory securely # Remove the tmp directory securely
ynh_secure_remove --file="$tmpdir" ynh_secure_remove --file="$tmpdir"
fi fi
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=7
ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# NGINX CONFIGURATION # NGINX CONFIGURATION
#================================================= #=================================================
@ -107,13 +114,6 @@ path_no_root=${path_url%/}
# Create a dedicated NGINX config # Create a dedicated NGINX config
ynh_add_nginx_config "path_no_root" ynh_add_nginx_config "path_no_root"
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=7
ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# SPECIFIC UPGRADE # SPECIFIC UPGRADE
#================================================= #=================================================
@ -124,9 +124,9 @@ ynh_script_progression --message="Upgrading Searx..." --weight=7
# Clean venv if it still on python2 # Clean venv if it still on python2
if [ ! -e $final_path/bin/python3 ] if [ ! -e $final_path/bin/python3 ]
then then
ynh_regex_secure_remove --file=$final_path/lib/ --regex='python[^/.]*' ynh_regex_secure_remove --file=$final_path/lib/ --regex='python[^/.]*'
ynh_regex_secure_remove --file=$final_path/lib64/ --regex='python[^/.]*' ynh_regex_secure_remove --file=$final_path/lib64/ --regex='python[^/.]*'
ynh_regex_secure_remove --file=$final_path/share/python-wheels ynh_regex_secure_remove --file=$final_path/share/python-wheels
fi fi
ynh_regex_secure_remove --file=$final_path/lib/python3/site-packages/setuptools ynh_regex_secure_remove --file=$final_path/lib/python3/site-packages/setuptools
ynh_regex_secure_remove --file=$final_path/lib/python3/site-packages/ --regex='setuptools-[^/.]*' ynh_regex_secure_remove --file=$final_path/lib/python3/site-packages/ --regex='setuptools-[^/.]*'