From 10180654479fc50c18fc2912a05df4500df06b61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Fri, 1 Dec 2023 15:47:37 +0100 Subject: [PATCH] fix linter --- doc/POST_INSTALL.md | 4 - doc/POST_UPGRADE.md | 1 - doc/PRE_INSTALL.md | 1 - doc/PRE_INSTALL_fr.md | 1 - doc/PRE_UPGRADE.md | 1 - .../{example.png => screenshot.png} | Bin manifest.toml | 4 +- scripts/install | 16 ++-- scripts/upgrade | 70 ------------------ 9 files changed, 7 insertions(+), 91 deletions(-) delete mode 100644 doc/POST_INSTALL.md delete mode 100644 doc/POST_UPGRADE.md delete mode 100644 doc/PRE_INSTALL.md delete mode 100644 doc/PRE_INSTALL_fr.md delete mode 100644 doc/PRE_UPGRADE.md rename doc/screenshots/{example.png => screenshot.png} (100%) diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md deleted file mode 100644 index 5122574..0000000 --- a/doc/POST_INSTALL.md +++ /dev/null @@ -1,4 +0,0 @@ -Congrats, the application is installed. -You can now put your FastAPI application's code in the folder `__DATA_DIR__`/FastAPIAppFolder/ - -Your application must contain a __init__.py file and the FastAPI object must be named 'app' \ No newline at end of file diff --git a/doc/POST_UPGRADE.md b/doc/POST_UPGRADE.md deleted file mode 100644 index a58e2ae..0000000 --- a/doc/POST_UPGRADE.md +++ /dev/null @@ -1 +0,0 @@ -This is a dummy disclaimer to display after upgrades diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md deleted file mode 100644 index eb3ab3a..0000000 --- a/doc/PRE_INSTALL.md +++ /dev/null @@ -1 +0,0 @@ -This is a dummy disclaimer to display prior to the install diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md deleted file mode 100644 index fc198de..0000000 --- a/doc/PRE_INSTALL_fr.md +++ /dev/null @@ -1 +0,0 @@ -Cette application sert à installer une application FastAPI de démonstration. Il faudra ensuite que vous y mettiez la votre \ No newline at end of file diff --git a/doc/PRE_UPGRADE.md b/doc/PRE_UPGRADE.md deleted file mode 100644 index 780fc15..0000000 --- a/doc/PRE_UPGRADE.md +++ /dev/null @@ -1 +0,0 @@ -This is a dummy disclaimer to display prior to any upgrade diff --git a/doc/screenshots/example.png b/doc/screenshots/screenshot.png similarity index 100% rename from doc/screenshots/example.png rename to doc/screenshots/screenshot.png diff --git a/manifest.toml b/manifest.toml index 9f1ecb3..a8a7bc6 100644 --- a/manifest.toml +++ b/manifest.toml @@ -4,8 +4,8 @@ packaging_format = 2 id = "my_fastapi_app" name = "my_FastAPI_app" -description.en = "Custom Web app to run a FastAPI program written in python" -description.fr = "Une application web personnalisée pour faire tourner une application FastAPI écrite en python" +description.en = "Custom Web app to run a FastAPI program written in Python" +description.fr = "Une application web personnalisée pour faire tourner une application FastAPI écrite en Python" version = "1.0~ynh1" diff --git a/scripts/install b/scripts/install index 4243784..ab37828 100755 --- a/scripts/install +++ b/scripts/install @@ -50,11 +50,11 @@ myynh_setup_log_file # Use logrotate to manage application logfile(s) ynh_use_logrotate --logfile="$log_file" --specific_user=$app - #================================================= # PYTHON VIRTUALENV #================================================= ynh_script_progression --message="Create and setup Python virtualenv..." --weight=45 + cp ../conf/requirements.txt "$data_dir/requirements.txt" myynh_setup_python_venv @@ -68,25 +68,21 @@ ynh_add_config --template="gunicorn.conf.py" --destination="$data_dir/gunicorn.c mkdir -p "$data_dir/FastAPIAppFolder" ynh_add_config --template="__init__.py" --destination="$data_dir/FastAPIAppFolder/__init__.py" - #================================================= # GENERIC FINALIZATION #================================================= # SECURE FILES AND DIRECTORIES #================================================= ynh_script_progression --message="Set file permissions..." -myynh_fix_file_permissions +myynh_fix_file_permissions #================================================= # NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Configuring nginx web server..." +ynh_script_progression --message="Configuring NGINX web server..." -# Create a dedicated nginx config -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/nginx -ynh_add_nginx_config "public_path" "port" +ynh_add_nginx_config #================================================= # SETUP SYSTEMD @@ -100,8 +96,7 @@ ynh_add_systemd_config --service=$app --template="systemd.service" #================================================= ynh_script_progression --message="Integrating service in YunoHost..." -yunohost service add $app - +yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log" #================================================= # Start the app server via systemd @@ -110,7 +105,6 @@ ynh_script_progression --message="Starting systemd service '$app'..." --weight=5 ynh_systemd_action --service_name=$app --action="start" --log_path="$log_file" - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index ddb8ba3..6dcf901 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,52 +9,8 @@ source _common.sh source /usr/share/yunohost/helpers -# Settings are automatically loaded as bash variables -# in every app script context, therefore typically these will exist: -# - $domain -# - $path -# - $language -# - $install_dir -# - $port -# ... - -# In the context of upgrade, -# - resources are automatically provisioned / updated / deleted (depending on existing resources) -# - a safety backup is automatically created by the core and will be restored if the upgrade fails - -### 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) -#================================================= -# STANDARD UPGRADE STEPS -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -#ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# -# N.B. : the following setting migration snippets are provided as *EXAMPLES* -# of what you may want to do in some cases (e.g. a setting was not defined on -# some legacy installs and you therefore want to initiaze stuff during upgrade) -# - -# If db_name doesn't exist, create it -#if [ -z "$db_name" ]; then -# db_name=$(ynh_sanitize_dbid --db_name=$app) -# ynh_app_setting_set --app=$app --key=db_name --value=$db_name -#fi - -# If install_dir doesn't exist, create it -#if [ -z "$install_dir" ]; then -# install_dir=/var/www/$app -# ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir -#fi - #================================================= # STOP SYSTEMD SERVICE #================================================= @@ -76,9 +32,6 @@ then ynh_setup_source --dest_dir="$install_dir" fi -# $install_dir will automatically be initialized with some decent -# permissions by default ... however, you may need to recursively reapply -# ownership to all files such as after the ynh_setup_source step chown -R $app:www-data "$install_dir" #================================================= @@ -86,20 +39,12 @@ chown -R $app:www-data "$install_dir" #================================================= ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 -# This should be a literal copypaste of what happened in the install's "System configuration" section - -ynh_add_fpm_config - ynh_add_nginx_config ynh_add_systemd_config yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log" -ynh_use_logrotate --non-append - -ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login" - #================================================= # RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...) #================================================= @@ -107,26 +52,11 @@ ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failreg #================================================= ynh_script_progression --message="Updating a configuration file..." --weight=1 -### Same as during install -### -### The file will automatically be backed-up if it's found to be manually modified (because -### ynh_add_config keeps track of the file's checksum) - ynh_add_config --template="some_config_file" --destination="$install_dir/some_config_file" -# 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 chmod 400 "$install_dir/some_config_file" chown $app:$app "$install_dir/some_config_file" -### 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="$install_dir/some_config_file" -### ynh_store_file_checksum --file="$install_dir/some_config_file" - #================================================= # START SYSTEMD SERVICE #=================================================