diff --git a/README.md b/README.md index 08b8265..92d6ff9 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,12 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Digital books streamer, providing web-based access to your e-book collection. +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.5.3~ynh2 -**Shipped version:** 1.5.3~ynh1 -**Demo:** https://demo.example.com ## Screenshots @@ -27,8 +28,6 @@ Digital books streamer, providing web-based access to your e-book collection. ## Disclaimers / important information -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. - ## Configuration A freshly installed BicBucStriim installation will show the login page. The initial login information for the administrator is @@ -42,8 +41,6 @@ If you encounter problems, use the installation test to check your environment. ## Documentation and resources * Official app website: http://projekte.textmulch.de/bicbucstriim/ -* Official user documentation: https://yunohost.org/apps -* Official admin documentation: https://yunohost.org/packaging_apps * Upstream app code repository: https://github.com/rvolz/BicBucStriim * YunoHost documentation for this app: https://yunohost.org/app_bicbucstriim * Report a bug: https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues diff --git a/README_fr.md b/README_fr.md index 9c98fb9..0bae50a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -11,11 +11,12 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour ## Vue d'ensemble -Interface web pour accéder à votre collection d'e-book. +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. + +**Version incluse :** 1.5.3~ynh2 -**Version incluse :** 1.5.3~ynh1 -**Démo :** https://demo.example.com ## Captures d'écran @@ -34,8 +35,6 @@ Une installation de BicBucStriim fraîchement installée affichera la page de co ## Documentations et ressources * Site officiel de l'app : http://projekte.textmulch.de/bicbucstriim/ -* Documentation officielle utilisateur : https://yunohost.org/apps -* Documentation officielle de l'admin : https://yunohost.org/packaging_apps * Dépôt de code officiel de l'app : https://github.com/rvolz/BicBucStriim * Documentation YunoHost pour cette app : https://yunohost.org/app_bicbucstriim * Signaler un bug : https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues diff --git a/conf/nginx.conf b/conf/nginx.conf index d672a7c..1b3f784 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -4,11 +4,6 @@ location __PATH__/ { # Path to source alias __FINALPATH__/ ; - # Force usage of https - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - rewrite ^/(__PATH__/img/.*)$ /$1 break; rewrite ^/(__PATH__/js/.*)$ /$1 break; rewrite ^/(__PATH__/style/.*)$ /$1 break; diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..d8d5964 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,2 @@ +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 diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 0a11eb8..7185826 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,5 +1,3 @@ -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. - ## Configuration A freshly installed BicBucStriim installation will show the login page. The initial login information for the administrator is diff --git a/manifest.json b/manifest.json index 3ccb50e..a312283 100644 --- a/manifest.json +++ b/manifest.json @@ -3,17 +3,14 @@ "id": "bicbucstriim", "packaging_format": 1, "description": { - "en": "Digital books streamer, providing web-based access to your e-book collection.", - "fr": "Interface web pour accéder à votre collection d'e-book." + "en": "Digital books streamer, providing web-based access to your e-book collection", + "fr": "Interface web pour accéder à votre collection d'e-book" }, - "version": "1.5.3~ynh1", + "version": "1.5.3~ynh2", "url": "http://projekte.textmulch.de/bicbucstriim/", "upstream": { "license": "MIT", "website": "http://projekte.textmulch.de/bicbucstriim/", - "demo": "https://demo.example.com", - "admindoc": "https://yunohost.org/packaging_apps", - "userdoc": "https://yunohost.org/apps", "code": "https://github.com/rvolz/BicBucStriim" }, "license": "MIT", @@ -22,7 +19,7 @@ "email": "apulido@free.fr" }, "requirements": { - "yunohost": ">> 4.2.4" + "yunohost": ">> 4.3.0" }, "multi_instance": true, "services": [ @@ -33,8 +30,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "example.com" + "type": "domain" }, { "name": "path", diff --git a/scripts/_common.sh b/scripts/_common.sh index b72bac6..f3e28de 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,7 +6,7 @@ YNH_PHP_VERSION="7.3" -extra_php_dependencies="php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-intl php${YNH_PHP_VERSION}-sqlite3 php${YNH_PHP_VERSION}-mbstring" +pkg_dependencies="php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-intl php${YNH_PHP_VERSION}-sqlite3 php${YNH_PHP_VERSION}-mbstring" #php${YNH_PHP_VERSION}-mcrypt #================================================= diff --git a/scripts/install b/scripts/install index 20a63a3..7b585c3 100644 --- a/scripts/install +++ b/scripts/install @@ -26,6 +26,7 @@ app=$YNH_APP_INSTANCE_NAME domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH is_public=$YNH_APP_ARG_IS_PUBLIC +phpversion=$YNH_PHP_VERSION #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS @@ -45,6 +46,14 @@ 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 +ynh_app_setting_set --app=$app --key=phpversion --value=$phpversion + +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing dependencies..." --weight=1 + +ynh_install_app_dependencies $pkg_dependencies #================================================= # CREATE DEDICATED USER @@ -82,8 +91,7 @@ ynh_add_nginx_config ynh_script_progression --message="Configuring PHP-FPM..." --weight=2 # Create a dedicated PHP-FPM config -ynh_add_fpm_config --package="$extra_php_dependencies" -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) +ynh_add_fpm_config #================================================= # SETUP SSOWAT diff --git a/scripts/remove b/scripts/remove index cf4f173..d517f24 100644 --- a/scripts/remove +++ b/scripts/remove @@ -19,6 +19,14 @@ 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) +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_script_progression --message="Removing dependencies..." --weight=1 + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies + #================================================= # REMOVE APP MAIN DIR #================================================= diff --git a/scripts/restore b/scripts/restore index 03051f3..c38500e 100644 --- a/scripts/restore +++ b/scripts/restore @@ -33,10 +33,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= ynh_script_progression --message="Validating restoration parameters..." --weight=2 -ynh_webpath_available --domain=$domain --path_url=$path_url \ - || ynh_die --message="Path not available: ${domain}${path_url}" -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " +test ! -d $final_path || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS @@ -73,7 +70,13 @@ ynh_script_progression --message="Reconfiguring PHP-FPM..." --weight=50 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" -ynh_add_fpm_config --package="$extra_php_dependencies" +#================================================= +# REINSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Reinstalling dependencies..." --weight=1 + +# Define and install dependencies +ynh_install_app_dependencies $pkg_dependencies #================================================= # GENERIC FINALIZATION diff --git a/scripts/upgrade b/scripts/upgrade index f73c120..14b2f7e 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -94,13 +94,20 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=2 # Create a dedicated NGINX config ynh_add_nginx_config +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." --weight=1 + +ynh_install_app_dependencies $pkg_dependencies + #================================================= # PHP-FPM CONFIGURATION #================================================= ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2 # Create a dedicated PHP-FPM config -ynh_add_fpm_config --package="$extra_php_dependencies" +ynh_add_fpm_config #================================================= # GENERIC FINALIZATION