Merge pull request #48 from YunoHost-Apps/feature/upgrade-to-stretch

Feature/upgrade to stretch

README.md

@@ -5,11 +5,36 @@ An efficient but powerful RSS aggregator with a nice and mobile-friendly design,
 * [FreshRSS website](http://freshrss.org)
 * [YunoHost website](https://yunohost.org)
 
+## INSTALL
+
 [![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=freshrss)
 
 ![](https://freshrss.org/images/screenshot.png)
 
+
+or command line :
+
+`yunohost app install https://github.com/YunoHost-Apps/freshrss_ynh`
+
+## UPGRADE
+`yunohost app upgrade freshrss -u https://github.com/YunoHost-Apps/freshrss_ynh`
+
+# :warning: WARNING :warning:
+upgrade for stretch has now dedicated php-fpm pool. To make upgrade works :
+Check if domain is already sets :
+`yunohost app setting freshrss domain`
+if this command does't return anything :
+`yunohost app setting freshrss domain -v yourdomain.tld`
+
+if you have multiple instances :
+
+`yunohost app setting freshrss__instancenumber domain -v yourdomain.tld`
+
 Changelog:
+* 2018-07-07 :
+    * Update to FreshRSS 1.11.1
+    * Remove deprecated helpers
+    * php-fpm dedicated pool
 * 2018-06-03 : Update to FreshRSS 1.11.0
 * 2018-02-04 : Update to FreshRSS 1.10.1
 * 2017-12-27 : Update to FreshRSS 1.9.0

conf/freshrss-deps.control

@@ -1,13 +0,0 @@
-Section: misc
-Priority: optional
-Homepage: https://github.com/FreshRSS/FreshRSS
-Standards-Version: 3.9.2
-
-Package: freshrss-deps
-Version: 1.11.0
-Depends: php5-cli, php5-gmp
-Architecture: all
-Description: meta package for freshrss dependencies
- FreshRSS is a self-hosted RSS feed aggregator such as Leed or Kriss Feed.
- .
- This meta-package is only responsible of installing its dependencies.

conf/nginx.conf

@@ -7,7 +7,7 @@ location PATHTOCHANGE {
        try_files $uri $uri/ /index.php?$args;
        location ~ [^/]\.php(/|$) {
            fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-           fastcgi_pass unix:/var/run/php5-fpm.sock;
+           fastcgi_pass unix:/var/run/php/php-fpm-APPNAMETOCHANGE.sock;
            fastcgi_index index.php;
            include fastcgi_params;
            fastcgi_param REMOTE_USER $remote_user;

conf/php-fpm.conf

@@ -0,0 +1,250 @@
+; Start a new pool named 'www'.
+; the variable $pool can we used in any directive and will be replaced by the
+; pool name ('www' here)
+[APPNAMETOCHANGE]
+
+; Per pool prefix
+; It only applies on the following directives:
+; - 'slowlog'
+; - 'listen' (unixsocket)
+; - 'chroot'
+; - 'chdir'
+; - 'php_values'
+; - 'php_admin_values'
+; When not set, the global prefix (or /usr) applies instead.
+; Note: This directive can also be relative to the global prefix.
+; Default Value: none
+;prefix = /path/to/pools/$pool
+
+; The address on which to accept FastCGI requests.
+; Valid syntaxes are:
+;   'ip.add.re.ss:port'    - to listen on a TCP socket to a specific address on
+;                            a specific port;
+;   'port'                 - to listen on a TCP socket to all addresses on a
+;                            specific port;
+;   '/path/to/unix/socket' - to listen on a unix socket.
+; Note: This value is mandatory.
+listen = /var/run/php/php-fpm-APPNAMETOCHANGE.sock
+
+; Set listen(2) backlog. A value of '-1' means unlimited.
+; Default Value: 128 (-1 on FreeBSD and OpenBSD)
+;listen.backlog = -1
+
+; List of ipv4 addresses of FastCGI clients which are allowed to connect.
+; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original
+; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address
+; must be separated by a comma. If this value is left blank, connections will be
+; accepted from any ip address.
+; Default Value: any
+;listen.allowed_clients = 127.0.0.1
+
+; Set permissions for unix socket, if one is used. In Linux, read/write
+; permissions must be set in order to allow connections from a web server. Many
+; BSD-derived systems allow connections regardless of permissions.
+; Default Values: user and group are set as the running user
+;                 mode is set to 0666
+listen.owner = www-data
+listen.group = www-data
+listen.mode = 0600
+
+; Unix user/group of processes
+; Note: The user is mandatory. If the group is not set, the default user's group
+;       will be used.
+user = www-data
+group = www-data
+
+; Choose how the process manager will control the number of child processes.
+; Possible Values:
+;   static  - a fixed number (pm.max_children) of child processes;
+;   dynamic - the number of child processes are set dynamically based on the
+;             following directives:
+;             pm.max_children      - the maximum number of children that can
+;                                    be alive at the same time.
+;             pm.start_servers     - the number of children created on startup.
+;             pm.min_spare_servers - the minimum number of children in 'idle'
+;                                    state (waiting to process). If the number
+;                                    of 'idle' processes is less than this
+;                                    number then some children will be created.
+;             pm.max_spare_servers - the maximum number of children in 'idle'
+;                                    state (waiting to process). If the number
+;                                    of 'idle' processes is greater than this
+;                                    number then some children will be killed.
+; Note: This value is mandatory.
+pm = dynamic
+
+; The number of child processes to be created when pm is set to 'static' and the
+; maximum number of child processes to be created when pm is set to 'dynamic'.
+; This value sets the limit on the number of simultaneous requests that will be
+; served. Equivalent to the ApacheMaxClients directive with mpm_prefork.
+; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP
+; CGI.
+; Note: Used when pm is set to either 'static' or 'dynamic'
+; Note: This value is mandatory.
+pm.max_children = 6
+
+; The number of child processes created on startup.
+; Note: Used only when pm is set to 'dynamic'
+; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2
+pm.start_servers = 3
+
+; The desired minimum number of idle server processes.
+; Note: Used only when pm is set to 'dynamic'
+; Note: Mandatory when pm is set to 'dynamic'
+pm.min_spare_servers = 3
+
+; The desired maximum number of idle server processes.
+; Note: Used only when pm is set to 'dynamic'
+; Note: Mandatory when pm is set to 'dynamic'
+pm.max_spare_servers = 5
+
+; The number of requests each child process should execute before respawning.
+; This can be useful to work around memory leaks in 3rd party libraries. For
+; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
+; Default Value: 0
+pm.max_requests = 500
+
+; The URI to view the FPM status page. If this value is not set, no URI will be
+; recognized as a status page. By default, the status page shows the following
+; information:
+;   accepted conn        - the number of request accepted by the pool;
+;   pool                 - the name of the pool;
+;   process manager      - static or dynamic;
+;   idle processes       - the number of idle processes;
+;   active processes     - the number of active processes;
+;   total processes      - the number of idle + active processes.
+;   max children reached - number of times, the process limit has been reached,
+;                          when pm tries to start more children (works only for
+;                          pm 'dynamic')
+; The values of 'idle processes', 'active processes' and 'total processes' are
+; updated each second. The value of 'accepted conn' is updated in real time.
+; Example output:
+;   accepted conn:        12073
+;   pool:                 www
+;   process manager:      static
+;   idle processes:       35
+;   active processes:     65
+;   total processes:      100
+;   max children reached: 1
+; By default the status page output is formatted as text/plain. Passing either
+; 'html' or 'json' as a query string will return the corresponding output
+; syntax. Example:
+;   http://www.foo.bar/status
+;   http://www.foo.bar/status?json
+;   http://www.foo.bar/status?html
+; Note: The value must start with a leading slash (/). The value can be
+;       anything, but it may not be a good idea to use the .php extension or it
+;       may conflict with a real PHP file.
+; Default Value: not set
+pm.status_path = /fpm-status
+
+; The ping URI to call the monitoring page of FPM. If this value is not set, no
+; URI will be recognized as a ping page. This could be used to test from outside
+; that FPM is alive and responding, or to
+; - create a graph of FPM availability (rrd or such);
+; - remove a server from a group if it is not responding (load balancing);
+; - trigger alerts for the operating team (24/7).
+; Note: The value must start with a leading slash (/). The value can be
+;       anything, but it may not be a good idea to use the .php extension or it
+;       may conflict with a real PHP file.
+; Default Value: not set
+ping.path = /ping
+
+; This directive may be used to customize the response of a ping request. The
+; response is formatted as text/plain with a 200 response code.
+; Default Value: pong
+;ping.response = pong
+
+; The timeout for serving a single request after which the worker process will
+; be killed. This option should be used when the 'max_execution_time' ini option
+; does not stop script execution for some reason. A value of '0' means 'off'.
+; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
+; Default Value: 0
+request_terminate_timeout = 120s
+
+; The timeout for serving a single request after which a PHP backtrace will be
+; dumped to the 'slowlog' file. A value of '0s' means 'off'.
+; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
+; Default Value: 0
+request_slowlog_timeout = 5s
+
+; The log file for slow requests
+; Default Value: not set
+; Note: slowlog is mandatory if request_slowlog_timeout is set
+slowlog = /var/log/nginx/APPNAMETOCHANGE.slow.log
+
+; Set open file descriptor rlimit.
+; Default Value: system defined value
+rlimit_files = 4096
+
+; Set max core size rlimit.
+; Possible Values: 'unlimited' or an integer greater or equal to 0
+; Default Value: system defined value
+rlimit_core = 0
+
+; Chroot to this directory at the start. This value must be defined as an
+; absolute path. When this value is not set, chroot is not used.
+; Note: you can prefix with '$prefix' to chroot to the pool prefix or one
+; of its subdirectories. If the pool prefix is not set, the global prefix
+; will be used instead.
+; Note: chrooting is a great security feature and should be used whenever
+;       possible. However, all PHP paths will be relative to the chroot
+;       (error_log, sessions.save_path, ...).
+; Default Value: not set
+;chroot =
+
+; Chdir to this directory at the start.
+; Note: relative path can be used.
+; Default Value: current directory or / when chroot
+chdir = ALIASTOCHANGE
+
+; Redirect worker stdout and stderr into main error log. If not set, stdout and
+; stderr will be redirected to /dev/null according to FastCGI specs.
+; Note: on highloaded environement, this can cause some delay in the page
+; process time (several ms).
+; Default Value: no
+catch_workers_output = yes
+
+; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
+; the current environment.
+; Default Value: clean env
+;env[HOSTNAME] = $HOSTNAME
+;env[PATH] = /usr/local/bin:/usr/bin:/bin
+;env[TMP] = /tmp
+;env[TMPDIR] = /tmp
+;env[TEMP] = /tmp
+
+; Additional php.ini defines, specific to this pool of workers. These settings
+; overwrite the values previously defined in the php.ini. The directives are the
+; same as the PHP SAPI:
+;   php_value/php_flag             - you can set classic ini defines which can
+;                                    be overwritten from PHP call 'ini_set'.
+;   php_admin_value/php_admin_flag - these directives won't be overwritten by
+;                                     PHP call 'ini_set'
+; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no.
+
+; Defining 'extension' will load the corresponding shared extension from
+; extension_dir. Defining 'disable_functions' or 'disable_classes' will not
+; overwrite previously defined php.ini values, but will append the new value
+; instead.
+
+; Note: path INI options can be relative and will be expanded with the prefix
+; (pool, global or /usr)
+
+; Default Value: nothing is defined by default except the values in php.ini and
+;                specified at startup with the -d argument
+;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com
+;php_flag[display_errors] = off
+;php_admin_value[error_log] = /var/log/fpm-php.www.log
+;php_admin_flag[log_errors] = on
+;php_admin_value[memory_limit] = 32M
+
+; Common values to change to increase file upload limit
+;php_value[upload_max_filesize] = 50M
+;php_value[post_max_size] = 50M
+;php_value[mail.add_x_header] = Off
+
+; Other common parameters
+;php_value[max_execution_time] = 600
+;php_value[max_input_time] = 300
+;php_value[memory_limit] = 256M
+;php_value[short_open_tag] = On

scripts/_common.sh

@@ -3,19 +3,16 @@
 #
 APPNAME="freshrss"
 # FreshRSS version
-VERSION="1.11.0"
+VERSION="1.11.1"
 
 # FreshRSS complete tarball checksum
-FRESHRSS_SOURCE_SHA256="1915f09b45654291d1a42574770cc680ea4edf87d1278cb9cd007c0d942d77cc"
+FRESHRSS_SOURCE_SHA256="df23af6878a4f4f27245320c9c29e481530c6b205bc03fc92179c625e2dd1c18"
 
 # Remote URL to fetch FreshRSS source tarball
-FRESHRSS_SOURCE_URL="https://github.com/FreshRSS/FreshRSS/archive/1.11.0.tar.gz"
+FRESHRSS_SOURCE_URL="https://github.com/FreshRSS/FreshRSS/archive/1.11.1.tar.gz"
 
 PKGDIR=$(cd ../; pwd)
 
-#apt dependencies
-DEPS_PKG_NAME="freshrss-deps"
-
 #
 # Common helpers
 #
@@ -36,6 +33,5 @@ extract_freshrss() {
 }
 
 install_freshrss_dependencies() {
-    ynh_package_install_from_equivs ../conf/${DEPS_PKG_NAME}.control \
+    ynh_install_app_dependencies php-cli php-gmp
-      || ynh_die "Unable to install dependencies"
 }

scripts/backup

@@ -16,6 +16,7 @@ ynh_backup "$path" "www"
 # Backup conf files
 ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "nginx.conf"
 ynh_backup "/etc/cron.d/$app" "cron"
+ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf" "php-fpm.conf"
 
 # Backup mysql
 ynh_mysql_dump_db $app > $app.dmp

scripts/install

@@ -1,12 +1,24 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Load common variables and helpers
+source _common.sh
-. ./_common.sh
+source /usr/share/yunohost/helpers
 
-# Retrieve arguments
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+# 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=${YNH_APP_ARG_PATH%/}
 admin_user=$YNH_APP_ARG_ADMIN
@@ -17,42 +29,34 @@ db_name=$app
 
 FINAL_PATH="/var/www/$app"
 
-# Source app helpers
+# Normalize the url path syntax
-. /usr/share/yunohost/helpers
+path=$(ynh_normalize_url_path $path)
-
-# if path do not begin with / add a / at the begining
-if [ "${path:0:1}" != "/" ]; then
-       path="/$path"
-fi
-# if path do not end with / add a / at the end
-if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then
-       path="${path:0:${#path}-1}"
-fi
-
-# keep domain for later
-ynh_app_setting_set $app domain $domain
 
 # Check user parameter if not empty
 if [[ $admin_user != '' ]]; then
     ynh_user_exists $admin_user || ynh_die "Wrong user"
-    ynh_app_setting_set $app admin_user $admin_user
 fi
 
-# Check domain/path availability
+# Check web path availability
-sudo yunohost app checkurl $domain$path -a $app || ynh_die "The path ${domain}${path} is not available for app installation."
+ynh_webpath_available $domain $path
+# Register (book) web path
+ynh_webpath_register $app $domain $path
 
-#install php5-cli
+#install php dependencies
-ynh_package_install_from_equivs ../conf/${DEPS_PKG_NAME}.control \
+install_freshrss_dependencies
-  || ynh_die "Unable to install dependencies"
 
 # Generate random DES key & password
 deskey=$(ynh_string_random)
 db_pwd=$(ynh_string_random)
 app_salt=$(ynh_string_random)
 
+# keep settings for later
+ynh_app_setting_set $app domain $domain
+ynh_app_setting_set $app admin_user $admin_user
+ynh_app_setting_set "$app" mysqlpwd "$db_pwd"
+
 # Initialize database and store mysql password for upgrade
 ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd"
-ynh_app_setting_set "$app" mysqlpwd "$db_pwd"
 
 # Copy files to the right place
 TMPDIR=$(mktemp -d)
@@ -72,8 +76,17 @@ sudo mv $TMPDIR $FINAL_PATH
 # Modify Nginx configuration file and copy it to Nginx conf directory
 sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf
 sed -i "s@ALIASTOCHANGE@$FINAL_PATH/@g" ../conf/nginx.conf
+sed -i "s@APPNAMETOCHANGE@$app@g" ../conf/nginx.conf
 sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
 
+# Modify php-fpm configuration file and copy it to pools directory
+php_conf=/etc/php/7.0/fpm/pool.d/$app.conf
+sed -i "s@APPNAMETOCHANGE@$app@g" ../conf/php-fpm.conf
+sed -i "s@ALIASTOCHANGE@$FINAL_PATH/@g" ../conf/php-fpm.conf
+sudo cp ../conf/php-fpm.conf $php_conf
+sudo chown root: $php_conf
+sudo chmod 644 $php_conf
+
 #update hook for multi instance
 sed -i "s@APPNAMETOCHANGE@$app@g" ../hooks/post_app_addaccess
 sed -i "s@APPNAMETOCHANGE@$app@g" ../hooks/post_user_create
@@ -95,4 +108,5 @@ sudo chown -R www-data: $FINAL_PATH/extensions/
 ynh_app_setting_set "$app" skipped_uris /api/greader.php
 # Reload Nginx and regenerate SSOwat conf
 sudo service nginx reload
+sudo service php7.0-fpm reload
 sudo yunohost app ssowatconf

scripts/remove

@@ -18,6 +18,8 @@ ynh_mysql_drop_user $db_user
 sudo rm -rf /var/www/$app
 sudo rm -rf /etc/cron.d/$app
 sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf
+sudo rm -f /etc/php/7.0/fpm/pool.d/$app.conf
 
 sudo service nginx reload
+sudo service php7.0-fpm reload
 sudo yunohost app ssowatconf

scripts/restore

@@ -1,24 +1,39 @@
 #!/bin/bash
 
-set -eu
+#=================================================
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
+
+source _common.sh
+source /usr/share/yunohost/helpers
+
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
 
 app=$YNH_APP_INSTANCE_NAME
 db_user=$app
 db_name=$app
 
-
-# Source app helpers
-. /usr/share/yunohost/helpers
-
 # retrieve useful param
 domain=$(ynh_app_setting_get $app domain)
 path=$(ynh_app_setting_get $app path)
 
-# Check domain/path availability
+# Check web path availability
-sudo yunohost app checkurl $domain$path -a $app || ynh_die "The path ${domain}${path} is not available for app installation."
+ynh_webpath_available $domain $path
+# Register (book) web path
+ynh_webpath_register $app $domain $path
 
 db_pass=$(ynh_app_setting_get $app mysqlpwd)
 
+#install php dependencies if necessary
+install_freshrss_dependencies
+
 # Restore sources & data
 final_path=/var/www/$app
 ynh_restore_file "$final_path"
@@ -31,6 +46,7 @@ sudo chown -R www-data: $final_path/extensions/
 # Restore conf files
 ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
 ynh_restore_file "/etc/cron.d/$app"
+ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
 
 # Restore mysql dump
 ynh_mysql_create_db "$db_name" "$db_user" "$db_pass"
@@ -38,4 +54,5 @@ ynh_mysql_connect_as "$db_user" "$db_pass" "$db_name" < "$app.dmp"
 
 # Reload Nginx, and regenerate SSOwat conf
 sudo service nginx reload
+sudo service php7.0-fpm reload
 sudo yunohost app ssowatconf

scripts/update-ynh.php

@@ -1,25 +0,0 @@
-<?php
-echo "including libs \n";
-require('constants.php');
-require(LIB_PATH . '/lib_rss.php');
-if (FRESHRSS_VERSION === '0.8.1'){
-	require('app/Models/Configuration.php');
-	require('app/Models/Entry.php');
-}
-echo "downloading update script \n";
-$ch = curl_init(FRESHRSS_UPDATE_WEBSITE);
-$fp = fopen("update.php", "w");
-
-curl_setopt($ch, CURLOPT_FILE, $fp);
-curl_setopt($ch, CURLOPT_HEADER, 0);
-
-curl_exec($ch);
-curl_close($ch);
-fclose($fp);
-echo "checking if update needed \n";
-if (!strstr(file_get_contents('update.php'), 'NO_UPDATE')){
-		echo "launching update \n";
-        require('update.php');
-        apply_update();
-}
-?>

scripts/upgrade

@@ -11,9 +11,8 @@ set -eu
 app=$YNH_APP_INSTANCE_NAME
 FINAL_PATH="/var/www/$app"
 
-#install extention for api if necessary
+#install php dependencies if necessary
-ynh_package_install_from_equivs ../conf/${DEPS_PKG_NAME}.control \
+install_freshrss_dependencies
-  || ynh_die "Unable to install dependencies"
 
 # Check destination directory
 [[ ! -d $FINAL_PATH ]] && ynh_die \
@@ -25,6 +24,28 @@ if [ -f $FINAL_PATH/data/user.php.dist ]; then
     sudo rm $FINAL_PATH/data/user.php.dist
 fi
 
+# retrieve domain
+domain=$(ynh_app_setting_get $app domain)
+
+#add fpm config if not exists
+if [ -n $domain ] && [ ! -f /etc/php/7.0/fpm/pool.d/$app.conf ]; then
+    path=$(ynh_app_setting_get $app path)
+    sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf
+    sed -i "s@ALIASTOCHANGE@$FINAL_PATH/@g" ../conf/nginx.conf
+    sed -i "s@APPNAMETOCHANGE@$app@g" ../conf/nginx.conf
+    sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
+
+    php_conf=/etc/php/7.0/fpm/pool.d/$app.conf
+    sed -i "s@APPNAMETOCHANGE@$app@g" ../conf/php-fpm.conf
+    sed -i "s@ALIASTOCHANGE@$FINAL_PATH/@g" ../conf/php-fpm.conf
+    sudo cp ../conf/php-fpm.conf $php_conf
+    sudo chown root: $php_conf
+    sudo chmod 644 $php_conf
+
+    sudo service nginx reload
+    sudo service php7.0-fpm reload
+fi
+
 # Create tmp directory and install app inside
 TMPDIR=$(mktemp -d)
 sudo chmod 755 "$TMPDIR"