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

Merge pull request #113 from ewilly/testing

Browse source 
Major update
This commit is contained in:
Quentin Michaud 2023-09-27 23:11:58 +02:00 committed by GitHub
commit 7b255ad9b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 316 additions and 3328 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
.github/workflows/updater.sh vendored
View file

@ -14,8 +14,8 @@
#================================================= #=================================================
# Fetching information # Fetching information
current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') current_version=$(cat manifest.toml | tomlq -j '.version|split("~")[0]')
repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') repo=$(cat manifest.toml | tomlq -j '.upstream.code|split("https://github.com/")[1]')
# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) # Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
version_raw=$(curl --silent "https://api.github.com/repos/$repo/commits/master" | jq -r ".commit.author.date") version_raw=$(curl --silent "https://api.github.com/repos/$repo/commits/master" | jq -r ".commit.author.date")
version=$(date -d "$version_raw" +%Y.%m.%d.%H.%M.%S) version=$(date -d "$version_raw" +%Y.%m.%d.%H.%M.%S)
@ -43,42 +43,19 @@ fi
# UPDATE SOURCE FILES # UPDATE SOURCE FILES
#================================================= #=================================================
asset_url="https://github.com/$repo/archive/$commit_hash/master.zip"
# Create the temporary directory
tempdir="$(mktemp -d)"
# Download sources and calculate checksum
curl --silent -4 -L $asset_url -o "$tempdir/master.zip"
checksum=$(sha256sum "$tempdir/master.zip" | head -c 64)
# Delete temporary directory
rm -rf $tempdir
# Rewrite source file
cat <<EOT > conf/app.src
SOURCE_URL=$asset_url
SOURCE_SUM=$checksum
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=zip
SOURCE_IN_SUBDIR=true
SOURCE_FILENAME=searxng.zip
SOURCE_EXTRACT=true
EOT
echo "... conf/$src.src updated"
#================================================= #=================================================
# SPECIFIC UPDATE STEPS # SPECIFIC UPDATE STEPS
#================================================= #=================================================
# Any action on the app's source code can be done. # Replace new version in _common.sh
# The GitHub Action workflow takes care of committing all changes after this script ends. sed -i "s/^commit_sha=.*/commit_sha=$commit_hash/" scripts/_common.sh
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================
# Replace new version in manifest # Replace new version in manifest
echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json sed -i "s/^version = .*/version = \"$version~ynh1\"/" manifest.toml
# No need to update the README, yunohost-bot takes care of it # No need to update the README, yunohost-bot takes care of it

25
.github/workflows/updater.yml vendored
View file

@ -17,6 +17,11 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
- name: Install python
uses: actions/setup-python@v4
- name: Install yq/tomlq
id: install_yq
run: pip install yq
- name: Run the updater script - name: Run the updater script
id: run_updater id: run_updater
run: | run: |
@ -36,7 +41,25 @@ jobs:
uses: peter-evans/create-pull-request@v4 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
commit-message: Update to version ${{ env.VERSION }} commit-message: Update testing to version ${{ env.VERSION }}
committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
signoff: false
base: testing
branch: ci-auto-update-v${{ env.VERSION }}
delete-branch: true
title: 'Upgrade to version ${{ env.VERSION }}'
body: |
Upgrade to v${{ env.VERSION }}
[See upstream release page](https://github.com/${{ env.REPO }}/releases/tag/v${{ env.VERSION }})
draft: false
- name: Create Pull Request
id: cpr
if: ${{ env.PROCEED == 'true' }}
uses: peter-evans/create-pull-request@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: Update master to version ${{ env.VERSION }}
committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>' committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>' author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
signoff: false signoff: false

2
README.md
View file

@ -19,7 +19,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
SearxXNG is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. SearxXNG is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled.
**Shipped version:** 2023.08.30.14.25.41~ynh1 **Shipped version:** 2023.09.12.16.01.06~ynh1
**Demo:** https://searx.be/ **Demo:** https://searx.be/

2
README_fr.md
View file

@ -19,7 +19,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
SearxXNG is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. SearxXNG is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled.
**Version incluse :** 2023.08.30.14.25.41~ynh1 **Version incluse :** 2023.09.12.16.01.06~ynh1
**Démo :** https://searx.be/ **Démo :** https://searx.be/

21
check_process
View file

@ -1,21 +0,0 @@
;; Test complet
; Manifest
domain="domain.tld"
path="/path"
is_public=1
language="fr"
admin="john"
password="1Strong-Password"
port="666"
; Checks
pkg_linter=1
setup_sub_dir=1
setup_root=1
setup_nourl=0
setup_private=1
setup_public=1
upgrade=1
backup_restore=1
multi_instance=0
port_already_use=0
change_url=1

7
conf/app.src
View file

@ -1,7 +0,0 @@
SOURCE_URL=https://github.com/searxng/searxng/archive/7af66736c018d4cc6da9331808c32a529ebae7db/master.zip
SOURCE_SUM=6276860845be5d145cf267e40081a5e9dc3e2ddb34e6ac2f7c6b80f63f086d8f
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=zip
SOURCE_IN_SUBDIR=true
SOURCE_FILENAME=searxng.zip
SOURCE_EXTRACT=true

3
conf/nginx.conf
View file

@ -1,7 +1,6 @@
#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
location __PATH__/ { location __PATH__/ {
uwsgi_pass unix:///var/run/__NAME__/app.socket; uwsgi_pass unix:///var/run/__APP__/app.socket;
include uwsgi_params; include uwsgi_params;
uwsgi_param HTTP_HOST $host; uwsgi_param HTTP_HOST $host;

2057
conf/settings.yml
View file

File diff suppressed because it is too large Load diff

70
conf/uwsgi.ini
View file

@ -1,37 +1,70 @@
# -*- mode: conf; coding: utf-8 -*-
[uwsgi] [uwsgi]
# Who will run the code
# uWSGI core
# ----------
#
# https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core
# Who will run the code / Hint: in emperor-tyrant mode uid & gid setting will be
# ignored [1]. Mode emperor-tyrant is the default on fedora (/etc/uwsgi.ini).
#
# [1] https://uwsgi-docs.readthedocs.io/en/latest/Emperor.html#tyrant-mode-secure-multi-user-hosting
#
uid = __APP__ uid = __APP__
gid = __APP__ gid = __APP__
# Number of workers # set (python) default encoding UTF-8
workers = 4 env = LANG=C.UTF-8
env = LANGUAGE=C.UTF-8
env = LC_ALL=C.UTF-8
# chdir to specified directory before apps loading
chdir = __INSTALL_DIR__/searxng-src/searx
# SearXNG configuration (settings.yml)
env = SEARXNG_SETTINGS_PATH=__INSTALL_DIR__/settings.yml
# disable logging for privacy
disable-logging = true
# The right granted on the created socket # The right granted on the created socket
chmod-socket = 666 chmod-socket = 666
# Plugin to use and interpretor config # Plugin to use and interpreter config
single-interpreter = true single-interpreter = true
# enable master process
master = true master = true
plugin = python3,http
# load apps in each worker instead of the master
lazy-apps = true lazy-apps = true
# load uWSGI plugins
plugin = python3,http
# By default the Python plugin does not initialize the GIL. This means your
# app-generated threads will not run. If you need threads, remember to enable
# them with enable-threads. Running uWSGI in multithreading mode (with the
# threads options) will automatically enable threading support. This *strange*
# default behaviour is for performance reasons.
enable-threads = true enable-threads = true
# Application base folder
base = __FINALPATH__
# Support running the module from a webserver subdirectory. # plugin: python
route-run = fixpathinfo: # --------------
#
# https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python
# Module to import # load a WSGI module
module = searx.webapp module = searx.webapp
# Virtualenv and python path # set PYTHONHOME/virtualenv
virtualenv = __FINALPATH__/venv/ virtualenv = __INSTALL_DIR__/searxng-pyenv
pythonpath = __FINALPATH__
chdir = __FINALPATH__/searx/ # add directory (or glob) to pythonpath
pythonpath = __INSTALL_DIR__
# The variable holding flask application
callable = app
# speak to upstream # speak to upstream
# ----------------- # -----------------
@ -44,11 +77,8 @@ buffer-size = 8192
# ui: # ui:
# static_use_hash: true # static_use_hash: true
# #
static-map = /static=__FINALPATH__/searx/static static-map = /static=__INSTALL_DIR__/searxng-src/searx/static
# expires set to one year since there are hashes # expires set to one year since there are hashes
static-expires = /* 31557600 static-expires = /* 31557600
static-gzip-all = True static-gzip-all = True
offload-threads = %k offload-threads = %k
# Cache
cache2 = name=searxngcache,items=2000,blocks=2000,blocksize=4096,bitmap=1

295
config_panel.toml.example
View file

@ -1,295 +0,0 @@
## Config panel are available from webadmin > Apps > YOUR_APP > Config Panel Button
## Those panels let user configure some params on their apps using a friendly interface,
## and remove the need to manually edit files from the command line.
## From a packager perspective, this .toml is coupled to the scripts/config script,
## which may be used to define custom getters/setters. However, most use cases
## should be covered automagically by the core, thus it may not be necessary
## to define a scripts/config at all!
## -----------------------------------------------------------------------------
## IMPORTANT: In accordance with YunoHost's spirit, please keep things simple and
## do not overwhelm the admin with tons of misunderstandable or advanced settings.
## -----------------------------------------------------------------------------
## The top level describe the entire config panels screen.
## The version is a required property.
## Here a small reminder to associate config panel version with YunoHost version
## | Config | YNH | Config panel small change log |
## | ------ | --- | ------------------------------------------------------- |
## | 0.1 | 3.x | 0.1 config script not compatible with YNH >= 4.3 |
## | 1.0 | 4.3.x | The new config panel system with 'bind' property |
version = "1.0"
## (optional) i18n property let you internationalize questions, however this feature
## is only available in core configuration panel (like yunohost domain config).
## So in app config panel this key is ignored for now, but you can internationalize
## by using a lang dictionary (see property name bellow)
# i18n = "prefix_translation_key"
################################################################################
#### ABOUT PANELS
################################################################################
## The next level describes web admin panels
## You have to choose an ID for each panel, in this example the ID is "main"
## Keep in mind this ID will be used in CLI to refer to your question, so choose
## something short and meaningfull.
## In the webadmin, each panel corresponds to a distinct tab / form
[main]
## Define the label for your panel
## Internationalization works similarly to the 'description' and 'ask' questions in the manifest
# name.en = "Main configuration"
# name.fr = "Configuration principale"
## (optional) If you need to trigger a service reload-or-restart after the user
## change a question in this panel, you can add your service in the list.
services = ["__APP__"]
# or services = ["nginx", "__APP__"] to also reload-or-restart nginx
## (optional) This help properties is a short help displayed on the same line
## than the panel title but not displayed in the tab.
# help = ""
############################################################################
#### ABOUT SECTIONS
############################################################################
## A panel is composed of one or several sections.
##
## Sections are meant to group questions together when they correspond to
## a same subtopic. This impacts the rendering in terms of CLI prompts
## and HTML forms
##
## You should choose an ID for your section, and prefix it with the panel ID
## (Be sure to not make a typo in the panel ID, which would implicitly create
## an other entire panel)
##
## We use the context of pepettes_ynh as an example,
## which is a simple donation form app written in python,
## and for which the admin will want to edit the configuration
[main.customization]
## (optional) Defining a proper title for sections is not mandatory
## and depends on the exact rendering you're aiming for the CLI / webadmin
name = ""
## (optional) This help properties is a short help displayed on the same line
## than the section title, meant to provide additional details
# help = ""
## (optional) As for panel, you can specify to trigger a service
## reload-or-restart after the user change a question in this section.
## This property is added to the panel property, it doesn't deactivate it.
## So no need to replicate, the service list from panel services property.
# services = []
## (optional) By default all questions are optionals, but you can specify a
## default behaviour for question in the section
optional = false
## (optional) It's also possible with the 'visible' property to only
## display the section depending on the user's answers to previous questions.
##
## Be careful that the 'visible' property should only refer to **previous** questions
## Hence, it should not make sense to have a "visible" property on the very first section.
##
## Also, keep in mind that this feature only works in the webadmin and not in CLI
## (therefore a user could be prompted in CLI for a question that may not be relevant)
# visible = true
########################################################################
#### ABOUT QUESTIONS
########################################################################
## A section is compound of one or several questions.
## ---------------------------------------------------------------------
## IMPORTANT: as for panel and section you have to choose an ID, but this
## one should be unique in all this document, even if the question is in
## an other panel.
## ---------------------------------------------------------------------
## You can use same questions types and properties than in manifest.yml
## install part. However, in YNH 4.3, a lot of change has been made to
## extend availables questions types list.
## See: TODO DOC LINK
[main.customization.project_name]
## (required) The ask property is equivalent to the ask property in
## the manifest. However, in config panels, questions are displayed on the
## left side and therefore have less space to be rendered. Therefore,
## it is better to use a short question, and use the "help" property to
## provide additional details if necessary.
ask.en = "Name of the project"
## (required) The type property indicates how the question should be
## displayed, validated and managed. Some types have specific properties.
##
## Types available: string, boolean, number, range, text, password, path
## email, url, date, time, color, select, domain, user, tags, file.
##
## For a complete list with specific properties, see: TODO DOC LINK
type = "string"
########################################################################
#### ABOUT THE BIND PROPERTY
########################################################################
## (recommended) 'bind' property is a powerful feature that let you
## configure how and where the data will be read, validated and written.
## By default, 'bind property is in "settings" mode, it means it will
## **only** read and write the value in application settings file.
## bind = "settings"
## However, settings usually correspond to key/values in actual app configurations
## Hence, a more useful mode is to have bind = ":FILENAME". In that case, YunoHost
## will automagically find a line with "KEY=VALUE" in FILENAME
## (with the adequate separator between KEY and VALUE)
##
## YunoHost will then use this value for the read/get operation.
## During write/set operations, YunoHost will overwrite the value
## in **both** FILENAME and in the app's settings.yml
## Configuration file format supported: yaml, toml, json, ini, env, php,
## python. The feature probably works with others formats, but should be tested carefully.
## Note that this feature only works with relatively simple cases
## such as `KEY: VALUE`, but won't properly work with
## complex data structures like multilin array/lists or dictionnaries.
## It also doesn't work with XML format, custom config function call, php define(), ...
## More info on TODO
# bind = ":/var/www/__APP__/settings.py"
## By default, bind = ":FILENAME" will use the question ID as KEY
## ... but the question ID may sometime not be the exact KEY name in the configuration file.
##
## In particular, in pepettes, the python variable is 'name' and not 'project_name'
## (c.f. https://github.com/YunoHost-Apps/pepettes_ynh/blob/5cc2d3ffd6529cc7356ff93af92dbb6785c3ab9a/conf/settings.py##L11 )
##
## In that case, the key name can be specified before the column ':'
bind = "name:/var/www/__APP__/settings.py"
## ---------------------------------------------------------------------
## IMPORTANT: other 'bind' mode exists:
##
## bind = "FILENAME" (with no column character before FILENAME)
## may be used to bind to the **entire file content** (instead of a single KEY/VALUE)
## This could be used to expose an entire configuration file, or binary files such as images
## For example:
## bind = "/var/www/__APP__/img/logo.png"
##
## bind = "null" can be used to disable reading / writing in settings.
## This creates sort of a "virtual" or "ephemeral" question which is not related to any actual setting
## In this mode, you are expected to define custom getter/setters/validators in scripts/config:
##
## getter: get__QUESTIONID()
## setter: set__QUESTIONID()
## validator: validate__QUESTIONID()
##
## You can also specify a common getter / setter / validator, with the
## function 'bind' mode, for example here it will try to run
## get__array_settings() first.
# bind = "array_settings()"
## ---------------------------------------------------------------------
## ---------------------------------------------------------------------
## IMPORTANT: with the exception of bind=null questions,
## question IDs should almost **always** correspond to an app setting
## initialized / reused during install/upgrade.
## Not doing so may result in inconsistencies between the config panel mechanism
## and the use of ynh_add_config
## ---------------------------------------------------------------------
########################################################################
#### OTHER GENERIC PROPERTY FOR QUESTIONS
########################################################################
## (optional) An help text for the question
help = "Fill the name of the project which will received donation"
## (optional) An example display as placeholder in web form
# example = "YunoHost"
## (optional) set to true in order to redact the value in operation logs
# redact = false
## (optional) A validation pattern
## ---------------------------------------------------------------------
## IMPORTANT: your pattern should be between simple quote, not double.
## ---------------------------------------------------------------------
pattern.regexp = '^\w{3,30}$'
pattern.error = "The name should be at least 3 chars and less than 30 chars. Alphanumeric chars are accepted"
## Note: visible and optional properties are also available for questions
[main.customization.contact_url]
ask = "Contact url"
type = "url"
example = "mailto: contact@example.org"
help = "mailto: accepted"
pattern.regexp = '^mailto:[^@]+@[^@]+|https://$'
pattern.error = "Should be https or mailto:"
bind = ":/var/www/__APP__/settings.py"
[main.customization.logo]
ask = "Logo"
type = "file"
accept = ".png"
help = "Fill with an already resized logo"
bind = "__FINALPATH__/img/logo.png"
[main.customization.favicon]
ask = "Favicon"
type = "file"
accept = ".png"
help = "Fill with an already sized favicon"
bind = "__FINALPATH__/img/favicon.png"
[main.stripe]
name = "Stripe general info"
optional = false
# The next alert is overwrited with a getter from the config script
[main.stripe.amount]
ask = "Donation in the month : XX €
type = "alert"
style = "success"
[main.stripe.publishable_key]
ask = "Publishable key"
type = "string"
redact = true
help = "Indicate here the stripe publishable key"
bind = ":/var/www/__APP__/settings.py"
[main.stripe.secret_key]
ask = "Secret key"
type = "string"
redact = true
help = "Indicate here the stripe secret key"
bind = ":/var/www/__APP__/settings.py"
[main.stripe.prices]
ask = "Prices ID"
type = "tags"
help = """\
Indicates here the prices ID of donation products you created in stripe interfaces. \
Go on [Stripe products](https://dashboard.stripe.com/products) to create those donation products. \
Fill it tag with 'FREQUENCY/CURRENCY/PRICE_ID' \
FREQUENCY: 'one_time' or 'recuring' \
CURRENCY: 'EUR' or 'USD' \
PRICE_ID: ID from stripe interfaces starting with 'price_' \
"""
pattern.regexp = '^(one_time|recuring)/(EUR|USD)/price_.*$'
pattern.error = "Please respect the format describe in help text for each price ID"

4
doc/DISCLAIMER.md → doc/ADMIN.md
View file

@ -1 +1,5 @@
The app install dir is `__INSTALL_DIR__`.
Don't edit settings in that directory.
Instead edit them in `__INSTALL_DIR__/settings.conf`. That file overwrite the default settings thanks to `use_default_settings: true`
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. 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.

54
manifest.json
View file

@ -1,54 +0,0 @@
{
"name": "SearXNG",
"id": "searxng",
"packaging_format": 1,
"description": {
"en": "A free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled",
"fr": "Un méta-moteur de recherche qui rassemble les résultats de plus de 70 services de recherche. Les utilisateurs ne sont ni suivis ni espionnés"
},
"version": "2023.08.30.14.25.41~ynh1",
"url": "https://docs.searxng.org/",
"upstream": {
"license": "AGPL-3.0-or-later",
"website": "https://docs.searxng.org/",
"demo": "https://searx.be/",
"admindoc": "https://docs.searxng.org/admin/",
"userdoc": "https://docs.searxng.org/user/",
"code": "https://github.com/searxng/searxng"
},
"license": "AGPL-3.0-or-later",
"maintainer": {
"name": "mh4ckt3mh4ckt1c4s",
"email": "mh4ckt3mh4ckt1c4s@protonmail.com"
},
"requirements": {
"yunohost": ">= 11.0.0"
},
"multi_instance": false,
"services": [
"nginx"
],
"arguments": {
"install": [
{
"name": "domain",
"type": "domain"
},
{
"name": "path",
"type": "path",
"example": "/searxng",
"default": "/searxng"
},
{
"name": "is_public",
"type": "boolean",
"default": true
},
{
"name": "admin",
"type": "user"
}
]
}
}

52
manifest.toml Normal file
View file

@ -0,0 +1,52 @@
packaging_format = 2
id = "searxng"
name = "SearXNG"
description.en = "A free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled"
description.fr = "Un méta-moteur de recherche qui rassemble les résultats de plus de 70 services de recherche. Les utilisateurs ne sont ni suivis ni espionnés"
version = "2023.09.18.10.00.00~ynh1"
maintainers = ["mh4ckt3mh4ckt1c4s"]
[upstream]
license = "AGPL-3.0-or-later"
website = "https://docs.searxng.org"
demo = "https://searx.be"
admindoc = "https://docs.searxng.org/admin/"
userdoc = "https://docs.searxng.org/user/"
code = "https://github.com/searxng/searxng"
[integration]
yunohost = ">= 11.1.0"
architectures = "all"
multi_instance = false
ldap = "not_relevant"
sso = "not_relevant"
disk = "210M"
ram.build = "250M"
ram.runtime = "200M"
[install]
[install.domain]
type = "domain"
[install.path]
type = "path"
default = "/searxng"
[install.init_main_permission]
type = "group"
default = "visitors"
[resources]
[resources.system_user]
[resources.install_dir]
dir = "/var/www/__APP__"
[resources.permissions]
main.url = "/"
[resources.apt]
packages = "git, build-essential, libxslt-dev, python3-dev, python3-venv, python3-cffi, python3-babel, zlib1g-dev, libffi-dev, libssl-dev, python3-lxml, uwsgi, uwsgi-plugin-python3, shellcheck"

209
scripts/_common.sh
View file

@ -4,8 +4,8 @@
# COMMON VARIABLES # COMMON VARIABLES
#================================================= #=================================================
# dependencies used by the app repo_fullpath="https://github.com/searxng/searxng"
pkg_dependencies="git build-essential libxslt-dev python3-dev python3-venv python3-cffi python3-babel zlib1g-dev libffi-dev libssl-dev python3-lxml uwsgi uwsgi-plugin-python3 shellcheck" commit_sha="a9b6963971327605db1509795be7795dc7401f3f"
#================================================= #=================================================
# UWSGI HELPERS # UWSGI HELPERS
@ -15,9 +15,9 @@ pkg_dependencies="git build-essential libxslt-dev python3-dev python3-venv pytho
# #
# usage: ynh_check_global_uwsgi_config # usage: ynh_check_global_uwsgi_config
ynh_check_global_uwsgi_config () { ynh_check_global_uwsgi_config () {
uwsgi --version || ynh_die --message "You need to add uwsgi (and appropriate plugin) as a dependency" uwsgi --version || ynh_die --message="You need to add uwsgi (and appropriate plugin) as a dependency"
cat > /etc/systemd/system/uwsgi-app@.service <<EOF cat > "/etc/systemd/system/uwsgi-app@.service" <<EOF
[Unit] [Unit]
Description=%i uWSGI app Description=%i uWSGI app
After=syslog.target After=syslog.target
@ -26,11 +26,12 @@ After=syslog.target
RuntimeDirectory=%i RuntimeDirectory=%i
ExecStart=/usr/bin/uwsgi \ ExecStart=/usr/bin/uwsgi \
--ini /etc/uwsgi/apps-available/%i.ini \ --ini /etc/uwsgi/apps-available/%i.ini \
--socket /var/run/%i/app.socket \ --socket /run/%i/app.socket \
--logto /var/log/uwsgi/%i/%i.log --logto /var/log/uwsgi/%i/%i.log
User=%i User=%i
Group=www-data Group=www-data
Restart=on-failure Restart=always
RestartSec=10
KillSignal=SIGQUIT KillSignal=SIGQUIT
Type=notify Type=notify
StandardError=syslog StandardError=syslog
@ -45,76 +46,44 @@ EOF
# Create a dedicated uwsgi ini file to use with generic uwsgi service # Create a dedicated uwsgi ini file to use with generic uwsgi service
# #
# This will use a template in ../conf/uwsgi.ini
# and will replace the following keywords with
# global variables that should be defined before calling
# this helper :
#
# __APP__ by $app
# __PATH__ by $path_url
# __FINALPATH__ by $final_path
#
# And dynamic variables (from the last example) :
# __PATH_2__ by $path_2
# __PORT_2__ by $port_2
#
# To be able to customise the settings of the systemd unit you can override the rules with the file "conf/uwsgi-app@override.service". # To be able to customise the settings of the systemd unit you can override the rules with the file "conf/uwsgi-app@override.service".
# This file will be automatically placed on the good place # This file will be automatically placed on the good place
# #
# Note that the service need to be started manually at the end of the installation.
# Generally you can start the service with this command:
# ynh_systemd_action --service_name "uwsgi-app@$app.service" --line_match "WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path "/var/log/uwsgi/$app/$app.log"
#
# usage: ynh_add_uwsgi_service # usage: ynh_add_uwsgi_service
# #
# to interact with your service: `systemctl <action> uwsgi-app@app` # to interact with your service: `systemctl <action> uwsgi-app@app`
ynh_add_uwsgi_service () { ynh_add_uwsgi_service () {
ynh_check_global_uwsgi_config ynh_check_global_uwsgi_config
local others_var=${1:-}
local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini" local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini"
# www-data group is needed since it is this nginx who will start the service # www-data group is needed since it is this nginx who will start the service
usermod --append --groups www-data "$app" || ynh_die --message "It wasn't possible to add user $app to group www-data" usermod --append --groups www-data "$app" || ynh_die --message="It wasn't possible to add user $app to group www-data"
ynh_backup_if_checksum_is_different "$finaluwsgiini"
cp ../conf/uwsgi.ini "$finaluwsgiini"
# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
# Substitute in a nginx config file only if the variable is not empty
if test -n "${final_path:-}"; then
ynh_replace_string --match_string "__FINALPATH__" --replace_string "$final_path" --target_file "$finaluwsgiini"
fi
if test -n "${path_url:-}"; then
ynh_replace_string --match_string "__PATH__" --replace_string "$path_url" --target_file "$finaluwsgiini"
fi
if test -n "${app:-}"; then
ynh_replace_string --match_string "__APP__" --replace_string "$app" --target_file "$finaluwsgiini"
fi
# Replace all other variable given as arguments
for var_to_replace in $others_var
do
# ${var_to_replace^^} make the content of the variable on upper-cases
# ${!var_to_replace} get the content of the variable named $var_to_replace
ynh_replace_string --match_string "__${var_to_replace^^}__" --replace_string "${!var_to_replace}" --target_file "$finaluwsgiini"
done
ynh_store_file_checksum --file "$finaluwsgiini"
ynh_add_config --template="uwsgi.ini" --destination="$finaluwsgiini"
ynh_store_file_checksum --file="$finaluwsgiini"
chown $app:root "$finaluwsgiini" chown $app:root "$finaluwsgiini"
# make sure the folder for logs exists and set authorizations # make sure the folder for logs exists and set authorizations
mkdir -p /var/log/uwsgi/$app mkdir -p "/var/log/uwsgi/$app"
chown $app:root /var/log/uwsgi/$app chown $app:root "/var/log/uwsgi/$app"
chmod -R u=rwX,g=rX,o= /var/log/uwsgi/$app chmod -R u=rwX,g=rX,o= "/var/log/uwsgi/$app"
# Setup specific Systemd rules if necessary # Setup specific Systemd rules if necessary
test -e ../conf/uwsgi-app@override.service && \ mkdir -p "/etc/systemd/system/uwsgi-app@$app.service.d"
mkdir /etc/systemd/system/uwsgi-app@$app.service.d && \ if [ -e "../conf/uwsgi-app@override.service" ]; then
cp ../conf/uwsgi-app@override.service /etc/systemd/system/uwsgi-app@$app.service.d/override.conf ynh_add_config --template="uwsgi-app@override.service" --destination="/etc/systemd/system/uwsgi-app@$app.service.d/override.conf"
fi
systemctl daemon-reload systemctl daemon-reload
systemctl enable "uwsgi-app@$app.service" --quiet ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="enable"
# Add as a service # Add as a service
yunohost service add "uwsgi-app@$app" --log "/var/log/uwsgi/$app/$app.log" yunohost service add "uwsgi-app@$app" --description="uWSGI service for searxng" --log "/var/log/uwsgi/$app/$app.log"
} }
# Remove the dedicated uwsgi ini file # Remove the dedicated uwsgi ini file
@ -124,119 +93,37 @@ ynh_remove_uwsgi_service () {
local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini" local finaluwsgiini="/etc/uwsgi/apps-available/$app.ini"
if [ -e "$finaluwsgiini" ]; then if [ -e "$finaluwsgiini" ]; then
yunohost service remove "uwsgi-app@$app" yunohost service remove "uwsgi-app@$app"
systemctl disable "uwsgi-app@$app.service" --quiet ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="stop"
ynh_exec_fully_quiet ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="disable"
ynh_secure_remove --file="$finaluwsgiini" ynh_secure_remove --file="$finaluwsgiini"
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
} }
# Backup the dedicated uwsgi config
#================================================= # Should be used in backup script
# Remove a file or a directory securely
# #
# usage: ynh_regex_secure_remove --file=path_to_remove [--regex=regex to append to $file] [--non_recursive] [--dry_run] # usage: ynh_backup_uwsgi_service
# | arg: -f, --file - File or directory to remove ynh_backup_uwsgi_service () {
# | arg: -r, --regex - Regex to append to $file to filter the files to remove ynh_backup --src_path="/etc/uwsgi/apps-available/$app.ini"
# | arg: -n, --non_recursive - Perform a non recursive rm and a non recursive search with the regex ynh_backup --src_path="/etc/systemd/system/uwsgi-app@$app.service.d"
# | arg: -d, --dry_run - Do not remove, only list the files to remove }
#
# Requires YunoHost version 2.6.4 or higher. # Restore the dedicated uwsgi config
ynh_regex_secure_remove () { # Should be used in restore script
# Declare an array to define the options of this helper. #
local legacy_args=frnd # usage: ynh_restore_uwsgi_service
declare -Ar args_array=( [f]=file= [r]=regex= [n]=non_recursive [d]=dry_run ) ynh_restore_uwsgi_service () {
local file ynh_check_global_uwsgi_config
local regex ynh_restore_file --origin_path="/etc/uwsgi/apps-available/$app.ini"
local dry_run ynh_restore_file --origin_path="/etc/systemd/system/uwsgi-app@$app.service.d"
local non_recursive
# Manage arguments with getopts mkdir -p "/var/log/uwsgi/$app"
ynh_handle_getopts_args "$@" chown $app:root "/var/log/uwsgi/$app"
regex=${regex:-} chmod -R u=rwX,g=rX,o= "/var/log/uwsgi/$app"
dry_run=${dry_run:-0}
non_recursive=${non_recursive:-0} ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="enable"
yunohost service add "uwsgi-app@$app" --description="uWSGI service for searxng" --log "/var/log/uwsgi/$app/$app.log"
local forbidden_path="
/var/www \
/home/yunohost.app"
# Fail if no argument is provided to the helper.
if [ -z "$file" ]
then
ynh_print_warn --message="ynh_regex_secure_remove called with no argument --file, ignoring."
return 0
fi
if [ -n "$regex" ]
then
if [ -e "$file" ]
then
if [ $non_recursive -eq 1 ]; then
local recursive="-maxdepth 1"
else
local recursive=""
fi
# Use find to list the files in $file and grep to filter with the regex
files_to_remove="$(find -P "$file" $recursive -name ".." -prune -o -print | grep --extended-regexp "$regex")"
else
ynh_print_info --message="'$file' wasn't deleted because it doesn't exist."
return 0
fi
else
files_to_remove="$file"
fi
# Check each file before removing it
while read file_to_remove
do
if [ -n "$file_to_remove" ]
then
# Check all forbidden path before removing anything
# First match all paths or subpaths in $forbidden_path
if [[ "$forbidden_path" =~ "$file_to_remove" ]] || \
# Match all first level paths from / (Like /var, /root, etc...)
[[ "$file_to_remove" =~ ^/[[:alnum:]]+$ ]] || \
# Match if the path finishes by /. Because it seems there is an empty variable
[ "${file_to_remove:${#file_to_remove}-1}" = "/" ]
then
ynh_print_err --message="Not deleting '$file_to_remove' because this path is forbidden !!!"
# If the file to remove exists
elif [ -e "$file_to_remove" ]
then
if [ $dry_run -eq 1 ]
then
ynh_print_warn --message="File to remove: $file_to_remove"
else
if [ $non_recursive -eq 1 ]; then
local recursive=""
else
local recursive="--recursive"
fi
# Remove a file or a directory
rm --force $recursive "$file_to_remove"
fi
else
# Ignore non existent files with regex, as we likely remove the parent directory before its content is listed.
if [ -z "$regex" ]
then
ynh_print_info --message="'$file_to_remove' wasn't deleted because it doesn't exist."
fi
fi
fi
done <<< "$(echo "$files_to_remove")"
} }

31
scripts/backup
View file

@ -6,46 +6,19 @@
# IMPORT GENERIC HELPERS # IMPORT GENERIC HELPERS
#================================================= #=================================================
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
ynh_clean_setup () {
### Remove this function if there's nothing to clean before calling the remove script.
true
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info --message="Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
domain=$(ynh_app_setting_get --app=$app --key=domain)
#================================================= #=================================================
# DECLARE DATA AND CONF FILES TO BACKUP # DECLARE DATA AND CONF FILES TO BACKUP
#================================================= #=================================================
ynh_print_info --message="Declaring files to be backed up..." ynh_print_info --message="Declaring files to be backed up..."
### N.B. : the following 'ynh_backup' calls are only a *declaration* of what needs
### to be backuped and not an actual copy of any file. The actual backup that
### creates and fill the archive with the files happens in the core after this
### script is called. Hence ynh_backups calls takes basically 0 seconds to run.
#================================================= #=================================================
# BACKUP THE APP MAIN DIR # BACKUP THE APP MAIN DIR
#================================================= #=================================================
ynh_backup --src_path="$final_path" ynh_backup --src_path="$install_dir"
#================================================= #=================================================
# BACKUP THE NGINX CONFIGURATION # BACKUP THE NGINX CONFIGURATION
@ -59,7 +32,7 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
# BACKUP UWSGI CONFIG # BACKUP UWSGI CONFIG
#================================================= #=================================================
ynh_backup --src_path="/etc/uwsgi/apps-available/$app.ini" ynh_backup_uwsgi_service
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

96
scripts/change_url
View file

@ -9,64 +9,6 @@
source _common.sh source _common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# RETRIEVE ARGUMENTS
#=================================================
old_domain=$YNH_APP_OLD_DOMAIN
old_path=$YNH_APP_OLD_PATH
new_domain=$YNH_APP_NEW_DOMAIN
new_path=$YNH_APP_NEW_PATH
app=$YNH_APP_INSTANCE_NAME
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
# Needed for helper "ynh_add_nginx_config"
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
# Add settings here as needed by your application
#db_name=$(ynh_app_setting_get --app=$app --key=db_name)
#db_user=$db_name
#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
#=================================================
# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1
# Backup the current version of the app
ynh_backup_before_upgrade
ynh_clean_setup () {
# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
# Restore it if the upgrade fails
ynh_restore_upgradebackup
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# CHECK WHICH PARTS SHOULD BE CHANGED
#=================================================
change_domain=0
if [ "$old_domain" != "$new_domain" ]
then
change_domain=1
fi
change_path=0
if [ "$old_path" != "$new_path" ]
then
change_path=1
fi
#================================================= #=================================================
# STANDARD MODIFICATIONS # STANDARD MODIFICATIONS
#================================================= #=================================================
@ -74,37 +16,14 @@ fi
#================================================= #=================================================
ynh_script_progression --message="Stopping a systemd service..." --weight=1 ynh_script_progression --message="Stopping a systemd service..." --weight=1
ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/$app/$app.log" ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log"
#================================================= #=================================================
# MODIFY URL IN NGINX CONF # MODIFY URL IN NGINX CONF
#================================================= #=================================================
ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf ynh_change_url_nginx_config
# Change the path in the NGINX config file
if [ $change_path -eq 1 ]
then
# Make a backup of the original NGINX config file if modified
ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
# Set global variables for NGINX helper
domain="$old_domain"
path_url="$new_path"
path_no_root=${path_url%/}
# Create a dedicated NGINX config
ynh_add_nginx_config "path_no_root"
fi
# Change the domain for NGINX
if [ $change_domain -eq 1 ]
then
# Delete file checksum for the old conf file location
ynh_delete_file_checksum --file="$nginx_conf_path"
mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
# Store file checksum for the new config file location
ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
fi
#================================================= #=================================================
# SPECIFIC MODIFICATIONS # SPECIFIC MODIFICATIONS
@ -113,7 +32,7 @@ fi
#================================================= #=================================================
ynh_script_progression --message="Reconfiguring SearXNG..." --weight=2 ynh_script_progression --message="Reconfiguring SearXNG..." --weight=2
ynh_replace_string --match_string="base_url: https://$old_domain$old_path" --replace_string="base_url: https://$new_domain$new_path" --target_file="$final_path/searx/settings.yml" ynh_replace_string --match_string="base_url: https://$old_domain$old_path" --replace_string="base_url: https://$new_domain$new_path" --target_file="$install_dir/settings.yml"
#================================================= #=================================================
# GENERIC FINALISATION # GENERIC FINALISATION
@ -122,14 +41,7 @@ ynh_replace_string --match_string="base_url: https://$old_domain$old_path" --rep
#================================================= #=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_script_progression --message="Starting a systemd service..." --weight=1
ynh_systemd_action --service_name=uwsgi-app@$app.service --action="start" --log_path="/var/log/$app/$app.log" ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="start" --log_path="/var/log/uwsgi/$app/$app.log"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

102
scripts/config
View file

@ -1,102 +0,0 @@
#!/bin/bash
# In simple cases, you don't need a config script.
# With a simple config_panel.toml, you can write in the app settings, in the
# upstream config file or replace complete files (logo ...) and restart services.
# The config scripts allows you to go further, to handle specific cases
# (validation of several interdependent fields, specific getter/setter for a value,
# display dynamic informations or choices, pre-loading of config type .cube... ).
#=================================================
# GENERIC STARTING
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source /usr/share/yunohost/helpers
ynh_abort_if_errors
#=================================================
# RETRIEVE ARGUMENTS
#=================================================
final_path=$(ynh_app_setting_get $app final_path)
#=================================================
# SPECIFIC GETTERS FOR TOML SHORT KEY
#=================================================
get__amount() {
# Here we can imagine to have an API call to stripe to know the amount of donation during a month
local amount = 200
# It's possible to change some properties of the question by overriding it:
if [ $amount -gt 100 ]
then
cat << EOF
style: success
value: $amount
ask:
en: A lot of donation this month: **$amount €**
EOF
else
cat << EOF
style: danger
value: $amount
ask:
en: Not so much donation this month: $amount €
EOF
fi
}
get__prices() {
local prices = "$(grep "DONATION\['" "$final_path/settings.py" | sed -r "s@^DONATION\['([^']*)'\]\['([^']*)'\] = '([^']*)'@\1/\2/\3@g" | sed -z 's/\n/,/g;s/,$/\n/')"
if [ "$prices" == "," ];
then
# Return YNH_NULL if you prefer to not return a value at all.
echo YNH_NULL
else
echo $prices
fi
}
#=================================================
# SPECIFIC VALIDATORS FOR TOML SHORT KEYS
#=================================================
validate__publishable_key() {
# We can imagine here we test if the key is really a publisheable key
(is_secret_key $publishable_key) &&
echo 'This key seems to be a secret key'
}
#=================================================
# SPECIFIC SETTERS FOR TOML SHORT KEYS
#=================================================
set__prices() {
#---------------------------------------------
# IMPORTANT: setter are trigger only if a change is detected
#---------------------------------------------
for price in $(echo $prices | sed "s/,/ /"); do
frequency=$(echo $price | cut -d/ -f1)
currency=$(echo $price | cut -d/ -f2)
price_id=$(echo $price | cut -d/ -f3)
sed "d/DONATION\['$frequency'\]\['$currency'\]" "$final_path/settings.py"
echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$final_path/settings.py"
done
#---------------------------------------------
# IMPORTANT: to be able to upgrade properly, you have to saved the value in settings too
#---------------------------------------------
ynh_app_setting_set $app prices $prices
}
#=================================================
# GENERIC FINALIZATION
#=================================================
ynh_app_config_run $1

201
scripts/install
View file

@ -10,170 +10,46 @@ source _common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#================================================= #=================================================
# MANAGE SCRIPT FAILURE # APP "BUILD" (DEPLOYING SOURCES, VENV, COMPILING ETC)
#=================================================
ynh_clean_setup () {
### Remove this function if there's nothing to clean before calling the remove script.
true
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
domain=$YNH_APP_ARG_DOMAIN
path_url=$YNH_APP_ARG_PATH
is_public=$YNH_APP_ARG_IS_PUBLIC
admin=$YNH_APP_ARG_ADMIN
### If it's a multi-instance app, meaning it can be installed several times independently
### The id of the app as stated in the manifest is available as $YNH_APP_ID
### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2"...)
### The app instance name is available as $YNH_APP_INSTANCE_NAME
### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
### - ynhexample__{N} for the subsequent installations, with N=3,4...
### The app instance name is probably what interests you most, since this is
### guaranteed to be unique. This is a good unique identifier to define installation path,
### db names...
app=$YNH_APP_INSTANCE_NAME
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
### About --weight and --time
### ynh_script_progression will show to your final users the progression of each scripts.
### In order to do that, --weight will represent the relative time of execution compared to the other steps in the script.
### --time is a packager option, it will show you the execution time since the previous call.
### This option is implied when running in CI_package_check, you can manually add it if you are manually testing the app.
### Use the execution time displayed in the CI report or by adding --time to the command, to estimate the weight of a step.
### A common way to do it is to set a weight equal to the execution time in second +1.
### The execution time is given for the duration since the previous call. So the weight should be applied to this previous call.
ynh_script_progression --message="Validating installation parameters..." --weight=1
### If the app uses NGINX as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
### If the app provides an internal web server (or uses another application server such as uWSGI), the final path should be "/opt/yunohost/$app"
final_path="/opt/yunohost/$app"
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
# Register (book) web path
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
ynh_script_progression --message="Storing installation settings..." --weight=1
ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set --app=$app --key=path --value=$path_url
#=================================================
# STANDARD MODIFICATIONS
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Installing dependencies..." --weight=1
### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
### Those deb packages will be installed as dependencies of this package.
### If you're not using this helper:
### - Remove the section "REMOVE DEPENDENCIES" in the remove script
### - Remove the variable "pkg_dependencies" in _common.sh
### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
ynh_install_app_dependencies $pkg_dependencies
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Configuring system user..." --weight=1
# Create a system user
ynh_system_user_create --username=$app --home_dir="$final_path"
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
#================================================= #=================================================
ynh_script_progression --message="Setting up source files..." --weight=1 ynh_script_progression --message="Setting up source files..." --weight=1
### `ynh_setup_source` is used to install an app from a zip or tar.gz file, ynh_exec_fully_quiet git clone -n "$repo_fullpath" "$install_dir/searxng-src"
### downloaded from an upstream source, like a git repository. pushd "$install_dir/searxng-src"
### `ynh_setup_source` use the file conf/app.src ynh_exec_fully_quiet git checkout "$commit_sha"
popd
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path"
# FIXME: this should be managed by the core in the future
# Here, as a packager, you may have to tweak the ownerhsip/permissions
# such that the appropriate users (e.g. maybe www-data) can access
# files in some cases.
# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
# this will be treated as a security issue.
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring NGINX web server..." --weight=1
### `ynh_add_nginx_config` will use the file conf/nginx.conf
path_no_root=${path_url%/}
# Create a dedicated NGINX config
ynh_add_nginx_config "path_no_root"
#=================================================
# SPECIFIC SETUP
#=================================================
# INSTALL SEARXNG IN A VIRTUALENV
#=================================================
ynh_script_progression --message="Installing SearXNG..." --weight=2 ynh_script_progression --message="Installing SearXNG..." --weight=2
python3 -m venv --system-site-packages "$final_path/venv" python3 -m venv --system-site-packages "$install_dir/searxng-pyenv"
set +u; source $final_path/venv/bin/activate; set -u set +o nounset; source "$install_dir/searxng-pyenv/bin/activate"; set -o nounset
pip3 install -U pip setuptools wheel pyyaml --no-cache-dir pip3 install -U pip setuptools wheel pyyaml --no-cache-dir
pip3 install -e "$final_path" ynh_exec_fully_quiet pip3 install -e "$install_dir/searxng-src"
#=================================================
# SYSTEM CONFIGURATION
#=================================================
ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
ynh_add_nginx_config
ynh_add_uwsgi_service
#=================================================
# APP INITIAL CONFIGURATION
#================================================= #=================================================
# ADD A CONFIGURATION # ADD A CONFIGURATION
#================================================= #=================================================
ynh_script_progression --message="Adding a configuration file..." --weight=1 ynh_script_progression --message="Adding a configuration file..." --weight=1
secret_key=$(ynh_string_random) secret_key=$(ynh_string_random)
full_url="https://$domain$path_url" ynh_add_config --template="../conf/settings.yml" --destination="$install_dir/settings.yml"
ynh_add_config --template="../conf/settings.yml" --destination="$final_path/searx/settings.yml"
# FIXME: this should be handled by the core in the future chmod 750 "$install_dir"
# You may need to use chmod 600 instead of 400, chmod -R o-rwx "$install_dir"
# for example if the app is expected to be able to modify its own config chown -R $app: "$install_dir"
chmod 400 "$final_path/searx/settings.yml"
chown $app:$app "$final_path/searx/settings.yml"
### For more complex cases where you want to replace stuff using regexes,
### you shoud rely on ynh_replace_string (which is basically a wrapper for sed)
### When doing so, you also need to manually call ynh_store_file_checksum
###
### ynh_replace_string --match_string="match_string" --replace_string="replace_string" --target_file="$final_path/some_config_file"
### ynh_store_file_checksum --file="$final_path/some_config_file"
#### ADDED : SET PERMISSIONS ON SEARXNG DIRECTORY (CF SEARX SCRIPT)
chown -R $app:$app $final_path
#=================================================
# CONFIGURE UWSGI FOR SEARX
#=================================================
ynh_script_progression --message="Configuring uWSGI for SearXNG..." --weight=2
ynh_add_uwsgi_service
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
@ -182,36 +58,7 @@ ynh_add_uwsgi_service
#================================================= #=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_script_progression --message="Starting a systemd service..." --weight=1
### `ynh_systemd_action` is used to start a systemd service for an app. ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="start" --line_match="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log"
### Only needed if you have configure a systemd service
### If you're not using these lines:
### - Remove the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the backup script
### - As well as the section "START SYSTEMD SERVICE" in the restore script
### - As well as the section"STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the upgrade script
### - And the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the change_url script
# Start a systemd service
ynh_systemd_action --service_name=uwsgi-app@$app.service --action=start --log_path="/var/log/uwsgi/$app/$app.log"
#=================================================
# SETUP SSOWAT
#=================================================
ynh_script_progression --message="Configuring permissions..." --weight=1
# Make app public if necessary
if [ $is_public -eq 1 ]
then
# Everyone can access the app.
# The "main" permission is automatically created before the install script.
ynh_permission_update --permission="main" --add="visitors"
fi
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

52
scripts/remove
View file

@ -10,59 +10,15 @@ source _common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#================================================= #=================================================
# LOAD SETTINGS # REMOVE SYSTEM CONFIGURATIONS
#================================================= #=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1 # REMOVE SYSTEMD SERVICE
app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#================================================= #=================================================
# STANDARD REMOVE ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
#=================================================
# STOP AND REMOVE SERVICE
#=================================================
ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1
# Remove the uwsgi and systemd configuration
ynh_systemd_action --service_name "uwsgi-app@$app.service" --action stop
ynh_remove_uwsgi_service
#=================================================
# REMOVE APP MAIN DIR
#=================================================
ynh_script_progression --message="Removing app main directory..." --weight=1
# Remove the app directory securely
ynh_secure_remove --file="$final_path"
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
# Remove the dedicated NGINX config
ynh_remove_nginx_config ynh_remove_nginx_config
#================================================= ynh_remove_uwsgi_service
# REMOVE DEPENDENCIES
#=================================================
ynh_script_progression --message="Removing dependencies..." --weight=1
# Remove metapackage and its dependencies
ynh_remove_app_dependencies
#=================================================
# GENERIC FINALIZATION
#=================================================
# REMOVE DEDICATED USER
#=================================================
ynh_script_progression --message="Removing the dedicated system user..." --weight=1
# Delete a system user
ynh_system_user_delete --username=$app
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

99
scripts/restore
View file

@ -6,115 +6,38 @@
# IMPORT GENERIC HELPERS # IMPORT GENERIC HELPERS
#================================================= #=================================================
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
ynh_clean_setup () {
#### Remove this function if there's nothing to clean before calling the remove script.
true
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# CHECK IF THE APP CAN BE RESTORED
#=================================================
ynh_script_progression --message="Validating restoration parameters..." --weight=1
test ! -d $final_path \
|| ynh_die --message="There is already a directory: $final_path "
#=================================================
# STANDARD RESTORATION STEPS
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
# Create the dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#================================================= #=================================================
# RESTORE THE APP MAIN DIR # RESTORE THE APP MAIN DIR
#================================================= #=================================================
ynh_script_progression --message="Restoring the app main directory..." --weight=1 ynh_script_progression --message="Restoring the app main directory..." --weight=1
ynh_restore_file --origin_path="$final_path" ynh_restore_file --origin_path="$install_dir"
# FIXME: this should be managed by the core in the future chown -R $app:www-data "$install_dir"
# Here, as a packager, you may have to tweak the ownerhsip/permissions chmod 750 "$install_dir"
# such that the appropriate users (e.g. maybe www-data) can access chmod -R o-rwx "$install_dir"
# files in some cases.
# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
# this will be treated as a security issue.
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#================================================= #=================================================
# SPECIFIC RESTORATION # RESTORE SYSTEM CONFIGURATIONS
#================================================= #=================================================
# REINSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Reinstalling dependencies..." --weight=1
# Define and install dependencies
ynh_install_app_dependencies $pkg_dependencies
#=================================================
# RESTORE THE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#================================================= ynh_restore_uwsgi_service
# RESTORE VARIOUS FILES
#=================================================
ynh_script_progression --message="Restoring various files..." --weight=1
ynh_restore_file --origin_path="/etc/uwsgi/apps-available/$app.ini"
mkdir -p "/var/log/uwsgi/$app"
chown $app:$app "/var/log/uwsgi/$app"
chmod u+rwX,g=rX,o= "/var/log/uwsgi/$app"
ynh_check_global_uwsgi_config
systemctl enable "uwsgi-app@$app.service" --quiet
#=================================================
# START SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1
ynh_systemd_action --service_name=uwsgi-app@$app.service --action=start --line_match="spawned
uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log"
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================
# RELOAD NGINX # RELOAD NGINX AND PHP-FPM OR THE APP SERVICE
#================================================= #=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="start" --line_match="WSGI app 0 \(mountpoint='[/[:alnum:]_-]*'\) ready in [[:digit:]]* seconds on interpreter" --log_path="/var/log/uwsgi/$app/$app.log"
ynh_systemd_action --service_name="nginx" --action="reload"
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

161
scripts/upgrade
View file

@ -8,44 +8,8 @@
source _common.sh source _common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# CHECK VERSION
#=================================================
### This helper will compare the version of the currently installed app and the version of the upstream package.
### $upgrade_type can have 2 different values
### - UPGRADE_APP if the upstream app version has changed
### - UPGRADE_PACKAGE if only the YunoHost package has changed
### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
upgrade_type=$(ynh_check_app_version_changed) upgrade_type=$(ynh_check_app_version_changed)
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
# Backup the current version of the app
ynh_backup_before_upgrade
ynh_clean_setup () {
# Restore it if the upgrade fails
ynh_restore_upgradebackup
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#================================================= #=================================================
# STANDARD UPGRADE STEPS # STANDARD UPGRADE STEPS
#================================================= #=================================================
@ -53,36 +17,29 @@ ynh_abort_if_errors
#================================================= #=================================================
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
# if [ -e "$install_dir/searx" ]; then
# N.B. : the followings setting migrations snippets are provided as *EXAMPLES* tempdir="$(mktemp -d)"
# of what you may want to do in some cases (e.g. a setting was not defined on mv "$install_dir/searx/settings.yml" "$tempdir/settings.yml"
# some legacy installs and you therefore want to initiaze stuff during upgrade) sed -i '1s/^/use_default_settings: true\n\n/' "$tempdir/settings.yml"
# ynh_secure_remove --file="$install_dir"
mkdir "$install_dir"
# If db_name doesn't exist, create it mv "$tempdir/settings.yml" "$install_dir/settings.yml"
#if [ -z "$db_name" ]; then ynh_secure_remove --file="$tempdir"
# db_name=$(ynh_sanitize_dbid --db_name=$app) ynh_store_file_checksum --file="$install_dir/settings.yml"
# ynh_app_setting_set --app=$app --key=db_name --value=$db_name ynh_delete_file_checksum --file="/opt/yunohost/$app/searx/settings.yml"
#fi
# If final_path doesn't exist, create it
if [ -z "$final_path" ]; then
final_path=/var/www/$app
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
fi fi
mkdir -p /var/log/uwsgi/$app ynh_delete_file_checksum --file="etc/nginx_conf.d/$domain/$app.conf"
chown $app:$app /var/log/uwsgi/$app
chmod -R u=rwX,g=rX,o= /var/log/uwsgi/$app
#================================================= #=================================================
# CREATE DEDICATED USER # STOP SYSTEMD SERVICE
#================================================= #=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 ynh_script_progression --message="Stopping a systemd service..." --weight=1
# Create a dedicated user (if not existing) ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="stop" --log_path="/var/log/uwsgi/$app/$app.log"
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# "REBUILD" THE APP (DEPLOY NEW SOURCES, RERUN NPM BUILD...)
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
#================================================= #=================================================
@ -91,91 +48,45 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]
then then
ynh_script_progression --message="Upgrading source files..." --weight=1 ynh_script_progression --message="Upgrading source files..." --weight=1
# create a temporary directory ynh_secure_remove --file="$install_dir/searxng-src"
tmpdir=$(mktemp -d) ynh_exec_fully_quiet git clone -n "$repo_fullpath" "$install_dir/searxng-src"
pushd "$install_dir/searxng-src"
ynh_exec_fully_quiet git checkout "$commit_sha"
popd
# backup the config file in the temp dir ynh_secure_remove --file="$install_dir/searxng-pyenv"
cp -a "$final_path/searx/settings.yml" "$tmpdir/settings.yml" python3 -m venv --system-site-packages "$install_dir/searxng-pyenv"
set +o nounset; source "$install_dir/searxng-pyenv/bin/activate"; set -o nounset
# Download, check integrity, uncompress and patch the source from app.src pip3 install -U pip setuptools wheel pyyaml --no-cache-dir
ynh_setup_source --dest_dir="$final_path" ynh_exec_fully_quiet pip3 install -e "$install_dir/searxng-src"
# Copy the saved settings back to final path
cp -a "$tmpdir/settings.yml" "$final_path/searx/settings.yml"
# Remove the temporary directory safely
ynh_secure_remove --file="$tmpdir"
fi fi
# FIXME: this should be managed by the core in the future chmod 750 "$install_dir"
# Here, as a packager, you may have to tweak the ownerhsip/permissions chmod -R o-rwx "$install_dir"
# such that the appropriate users (e.g. maybe www-data) can access chown -R $app: "$install_dir"
# files in some cases.
# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
# this will be treated as a security issue.
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#================================================= #=================================================
# UPGRADE DEPENDENCIES # REAPPLY SYSTEM CONFIGURATIONS
#================================================= #=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=1 ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
ynh_install_app_dependencies $pkg_dependencies ynh_add_nginx_config
#================================================= #=================================================
# NGINX CONFIGURATION # RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...)
#================================================= #=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 # UPDATE A CONFIG FILE
path_no_root=${path_url%/}
# Create a dedicated NGINX config
ynh_add_nginx_config "path_no_root"
#================================================= #=================================================
# SPECIFIC UPGRADE ynh_script_progression --message="Updating a configuration file..." --weight=1
#=================================================
# UPGRADE SEARXNG IN ITS VIRTUALENV
#=================================================
ynh_script_progression --message="Upgrading SearXNG..." --weight=2
ynh_secure_remove --file="$final_path/venv"
python3 -m venv --system-site-packages "$final_path/venv"
set +u; source $final_path/venv/bin/activate; set -u
pip3 install -U pip setuptools wheel pyyaml --no-cache-dir
pip3 install -e "$final_path"
chown -R $app: "$final_path"
#=================================================
# CONFIGURE UWSGI FOR SEARX
#=================================================
ynh_script_progression --message="Reconfiguring uWSGI for Searx..." --weight=2
# Clean old files
ynh_secure_remove --file="/etc/uwsgi/apps-enabled/$app.ini"
ynh_secure_remove --file="/etc/uwsgi/apps-available/$app.ini"
ynh_add_uwsgi_service ynh_add_uwsgi_service
#=================================================
# GENERIC FINALIZATION
#================================================= #=================================================
# START SYSTEMD SERVICE # START SYSTEMD SERVICE
#================================================= #=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_script_progression --message="Starting a systemd service..." --weight=1
# Wait for searx to be fully started ynh_systemd_action --service_name="uwsgi-app@$app.service" --action="start" --line_match="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log"
ynh_systemd_action --service_name=uwsgi-app@$app.service --action=restart --line_match="spawned uWSGI master process" --log_path="/var/log/uwsgi/$app/$app.log"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

2
sources/extra_files/app/.gitignore vendored
View file

@ -1,2 +0,0 @@
*~
*.sw[op]

2
sources/patches/.gitignore vendored
View file

@ -1,2 +0,0 @@
*~
*.sw[op]

22
tests.toml Normal file
View file

@ -0,0 +1,22 @@
#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json
test_format = 1.0
[default]
# ------------
# Tests to run
# ------------
# -------------------------------
# Default args to use for install
# -------------------------------
# -------------------------------
# Commits to test upgrade from
# -------------------------------
test_upgrade_from.9de9cc90.name = "2023.09.17.22.15.57~ynh1 / packaging v1"
test_upgrade_from.9de9cc90.args.domain = "domain.tld"
test_upgrade_from.9de9cc90.args.path = "/path"
test_upgrade_from.9de9cc90.args.is_public = 1
test_upgrade_from.9de9cc90.args.admin = "john"