2022-11-23 10:08:54 +01:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# GENERIC START
|
|
|
|
|
#=================================================
|
|
|
|
|
# IMPORT GENERIC HELPERS
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
source _common.sh
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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"
|
2022-11-23 12:46:39 +01:00
|
|
|
final_path="/opt/yunohost/$app"
|
2022-11-23 10:08:54 +01:00
|
|
|
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
|
|
|
|
|
#=================================================
|
|
|
|
|
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,
|
|
|
|
|
### downloaded from an upstream source, like a git repository.
|
|
|
|
|
### `ynh_setup_source` use the file conf/app.src
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
2022-11-23 12:46:39 +01:00
|
|
|
path_no_root=${path_url%/}
|
2022-11-23 10:08:54 +01:00
|
|
|
# Create a dedicated NGINX config
|
2022-11-24 00:46:00 +01:00
|
|
|
ynh_add_nginx_config
|
2022-11-23 10:08:54 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SPECIFIC SETUP
|
|
|
|
|
#=================================================
|
2022-11-23 12:46:39 +01:00
|
|
|
# INSTALL SEARXNG IN A VIRTUALENV
|
2022-11-23 10:08:54 +01:00
|
|
|
#=================================================
|
2022-11-23 12:46:39 +01:00
|
|
|
ynh_script_progression --message="Installing SearXNG..." --weight=2
|
2022-11-23 10:08:54 +01:00
|
|
|
|
2022-11-23 12:46:39 +01:00
|
|
|
python3 -m venv --system-site-packages "$final_path"
|
|
|
|
|
set +u; source $final_path/bin/activate; set -u
|
|
|
|
|
pip3 install -U pip setuptools wheel pyyaml --no-cache-dir
|
2022-11-24 17:13:16 +01:00
|
|
|
pip3 install -e "$final_path"
|
2022-11-23 10:08:54 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# ADD A CONFIGURATION
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Adding a configuration file..." --weight=1
|
|
|
|
|
|
2022-11-23 12:46:39 +01:00
|
|
|
secret_key=$(ynh_string_random)
|
|
|
|
|
ynh_add_config --template="../conf/settings.yml" --destination="$final_path/searx/settings.yml"
|
2022-11-23 10:08:54 +01:00
|
|
|
|
|
|
|
|
# FIXME: this should be handled by the core in the future
|
|
|
|
|
# You may need to use chmod 600 instead of 400,
|
|
|
|
|
# for example if the app is expected to be able to modify its own config
|
2022-11-23 15:32:08 +01:00
|
|
|
chmod 400 "$final_path/searx/settings.yml"
|
|
|
|
|
chown $app:$app "$final_path/searx/settings.yml"
|
2022-11-23 10:08:54 +01:00
|
|
|
|
|
|
|
|
### 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"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
2022-11-23 23:16:21 +01:00
|
|
|
# CONFIGURE UWSGI FOR SEARX
|
2022-11-23 10:08:54 +01:00
|
|
|
#=================================================
|
2022-11-23 23:16:21 +01:00
|
|
|
ynh_script_progression --message="Configuring uWSGI for Searx..." --weight=2
|
2022-11-23 10:08:54 +01:00
|
|
|
|
2022-11-23 23:16:21 +01:00
|
|
|
ynh_add_uwsgi_service
|
2022-11-23 10:08:54 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# GENERIC FINALIZATION
|
|
|
|
|
#=================================================
|
|
|
|
|
# START SYSTEMD SERVICE
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
|
|
|
|
|
|
|
|
### `ynh_systemd_action` is used to start a systemd service for an app.
|
|
|
|
|
### 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
|
2022-11-23 23:59:56 +01:00
|
|
|
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"
|
2022-11-23 10:08:54 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
ynh_script_progression --message="Installation of $app completed" --last
|
