diff --git a/README.md b/README.md index 9fae860..c9c3cf7 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -BicBucStriim streams books, digital books. It was primarily designed to fill a gap in the functionality of NAS devices that provide access to music, videos and photos -- but not books. BicBucStriim fills this gap and provides web-based access to your e-book collection. BicBucStriim is a simple PHP application that runs in the Apache/PHP environment provided by the NAS (or any other server). It assumes that you manage your e-book collection with Calibre. The application reads the [Calibre](https://calibre-ebook.com/) data and publishes it in HTML form. To access the e-book catalog you simply point your ebook reader to your NAS, select one of your e-books and download it. **Shipped version:** 1.6.5~ynh1 @@ -43,4 +42,4 @@ or sudo yunohost app upgrade bicbucstriim -u https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing --debug ``` -**More info regarding app packaging:** \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 16f0672..ce6db9f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -43,4 +43,4 @@ ou sudo yunohost app upgrade bicbucstriim -u https://github.com/YunoHost-Apps/bicbucstriim_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 700cbb6..717e32a 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -1,3 +1,4 @@ ## Troubleshooting -If you encounter problems, use the installation test to check your environment. Invoke this test by navigating to `http://domain.ltd/bbs/installcheck.php`. This test checks for problems that users experienced in the past. \ No newline at end of file +If you encounter problems, use the installation test to check your environment. +Invoke this test by navigating to . This test checks for problems that users experienced in the past. diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index c356563..1fa5654 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -1,3 +1,4 @@ ## Dépannage -Si vous rencontrez des problèmes, utilisez le test d'installation pour vérifier votre environnement. Invoquez ce test en accédant à `__DOMAIN__/bbs/installcheck.php`. Ce test vérifie les problèmes rencontrés par les utilisateurs dans le passé. \ No newline at end of file +Si vous rencontrez des problèmes, utilisez le test d'installation pour vérifier votre environnement. +Invoquez ce test en accédant à . Ce test vérifie les problèmes rencontrés par les utilisateurs dans le passé. diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index d8d5964..9abff18 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,2 +1 @@ -BicBucStriim streams books, digital books. It was primarily designed to fill a gap in the functionality of NAS devices that provide access to music, videos and photos -- but not books. BicBucStriim fills this gap and provides web-based access to your e-book collection. -BicBucStriim is a simple PHP application that runs in the Apache/PHP environment provided by the NAS (or any other server). It assumes that you manage your e-book collection with Calibre. The application reads the [Calibre](https://calibre-ebook.com/) data and publishes it in HTML form. To access the e-book catalog you simply point your ebook reader to your NAS, select one of your e-books and download it. \ No newline at end of file +BicBucStriim is a simple PHP application that runs in the Apache/PHP environment provided by the NAS (or any other server). It assumes that you manage your e-book collection with Calibre. The application reads the [Calibre](https://calibre-ebook.com/) data and publishes it in HTML form. To access the e-book catalog you simply point your ebook reader to your NAS, select one of your e-books and download it. diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md index e69de29..75889d2 100644 --- a/doc/POST_INSTALL.md +++ b/doc/POST_INSTALL.md @@ -0,0 +1,4 @@ +A freshly installed BicBucStriim installation will show the login page. The initial login information for the administrator is + + user name: `admin` + password : `admin` diff --git a/doc/POST_INSTALL_fr.md b/doc/POST_INSTALL_fr.md index 1c17085..178f883 100644 --- a/doc/POST_INSTALL_fr.md +++ b/doc/POST_INSTALL_fr.md @@ -1,4 +1,4 @@ Les informations de connexion initiales de l'administrateur sont - nom d'utilisateur : admin - mot de passe : admin \ No newline at end of file + nom d'utilisateur : `admin` + mot de passe : `admin` diff --git a/manifest.toml b/manifest.toml index d8b9568..bbc68e0 100644 --- a/manifest.toml +++ b/manifest.toml @@ -19,11 +19,8 @@ code = "https://github.com/mikespub-org/rvolz-BicBucStriim" yunohost = ">= 11.2" architectures = "all" multi_instance = true - ldap = false - sso = false - disk = "50M" ram.build = "50M" ram.runtime = "50M" @@ -59,5 +56,4 @@ ram.runtime = "50M" "php7.4-xml", "php7.4-sqlite3", "php7.4-mbstring", - "php7.4-mcrypt", ] diff --git a/scripts/backup b/scripts/backup index bd2e977..271f5cb 100644 --- a/scripts/backup +++ b/scripts/backup @@ -19,15 +19,11 @@ ynh_print_info --message="Declaring files to be backed up..." ynh_backup --src_path="$install_dir" #================================================= -# BACKUP THE NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# BACKUP THE PHP-FPM CONFIGURATION -#================================================= - ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= diff --git a/scripts/change_url b/scripts/change_url index 6319926..4ba8cf7 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,15 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# STOP SYSTEMD SERVICE -#================================================= -ynh_script_progression --message="Stopping a systemd service..." --weight=1 - -ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" - #================================================= # MODIFY URL IN NGINX CONF #================================================= diff --git a/scripts/install b/scripts/install index f9f2774..0a993f1 100644 --- a/scripts/install +++ b/scripts/install @@ -14,16 +14,17 @@ source /usr/share/yunohost/helpers #================================================= ynh_script_progression --message="Setting up source files..." --weight=7 +# Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$install_dir" chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +chown -R "$app:www-data" "$install_dir" # chmod -R ga+w "$install_dir/data" #================================================= -# NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=2 +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 ynh_add_nginx_config diff --git a/scripts/password.php b/scripts/password.php deleted file mode 100644 index 4769f90..0000000 --- a/scripts/password.php +++ /dev/null @@ -1,6 +0,0 @@ - diff --git a/scripts/remove b/scripts/remove index ac762c0..a6a8ac5 100644 --- a/scripts/remove +++ b/scripts/remove @@ -10,9 +10,9 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# REMOVE NGINX CONFIGURATION +# REMOVE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 ynh_remove_nginx_config diff --git a/scripts/restore b/scripts/restore index 2e8ce44..76a9cc0 100644 --- a/scripts/restore +++ b/scripts/restore @@ -17,18 +17,18 @@ ynh_script_progression --message="Restoring the app main directory..." --weight= ynh_restore_file --origin_path="$install_dir" chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" -chmod -R ga+w "$install_dir/data" +chown -R "$app:www-data" "$install_dir" +# chmod -R ga+w "$install_dir/data" #================================================= -# RESTORE THE PHP-FPM CONFIGURATION +# RESTORE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Reconfiguring PHP-FPM..." --weight=5 - -ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" + #================================================= # GENERIC FINALIZATION #================================================= @@ -36,8 +36,8 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=2 -ynh_systemd_action --service_name=php${phpversion}-fpm --action=reload -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="php$phpversion-fpm" --action=reload +ynh_systemd_action --service_name="nginx" --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index bd7ec19..563519e 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -10,32 +10,25 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# CHECK VERSION +# ENSURE DOWNWARD COMPATIBILITY #================================================= +# ynh_script_progression --message="Ensuring downward compatibility..." --weight=2 -upgrade_type=$(ynh_check_app_version_changed) - -#================================================= -# STANDARD UPGRADE STEPS #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Upgrading source files..." --weight=7 -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=7 - - ynh_setup_source --dest_dir="$install_dir" -fi - +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir" chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" -chmod -R ga+w "$install_dir/data" +chown -R "$app:www-data" "$install_dir" +# chmod -R ga+w "$install_dir/data" #================================================= -# NGINX CONFIGURATION +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=2 +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 ynh_add_nginx_config