From 19f61e95b546c746a36f6eca690558a4ed328671 Mon Sep 17 00:00:00 2001 From: Inrepublica Date: Wed, 25 Mar 2020 14:52:02 +0100 Subject: [PATCH] Update to ynh 3.6.5 Major change to Yunohost 3.6.5 and upgrade to Phpsysinfo 3.3.2 --- README.md | 57 +++++- conf/app.src | 6 + conf/nginx.conf | 59 ++++-- conf/php-fpm.conf | 436 ++++++++++++++++++++++++++++++++++++++++++++ conf/phpsysinfo.ini | 324 ++++++++++++++++++++++++-------- manifest.json | 20 +- scripts/_common.sh | 1 + scripts/backup | 61 +++++-- scripts/change_url | 92 ++++++++++ scripts/install | 150 ++++++++++----- scripts/remove | 67 +++++-- scripts/restore | 88 ++++++--- scripts/upgrade | 194 +++++++++++++++----- 13 files changed, 1311 insertions(+), 244 deletions(-) create mode 100644 conf/app.src create mode 100644 conf/php-fpm.conf create mode 100644 scripts/_common.sh create mode 100644 scripts/change_url diff --git a/README.md b/README.md index 8979e13..9fa928d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,55 @@ # PHPSysInfo for Yunohost -PhpSysInfo 3.2.5 for [Yunohost](http://yunohost.org/). Work with YunoHost 2.4.0.6. +[![Integration level](https://dash.yunohost.org/integration/phpsysinfo_ynh.svg)](https://dash.yunohost.org/appci/app/phpsysinfo_ynh) +[![Install Custom Webapp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=phpsysinfo_ynh) -# Installation -You can install this package by going through the administration web interface by choosing "Install custom app", or using the moulinette: -`yunohost app install https://github.com/inrepublica/phpsysinfo_ynh` +> *This package allow you to install PHPSysInfo quickly and simply on a YunoHost server. +If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* -# Configuration -Edit `phpsysinfo.ini` in `/var/www/phpsysinfo/phpsysinfo.ini`. \ No newline at end of file +## Overview + +A customizable PHP script that displays information about your system nicely. + +**Shipped version:** 3.3.2 + +## Screenshots +![screenshot phpsyinfo](https://a.fsdn.com/con/app/proj/phpsysinfo/screenshots/294411.jpg/max/max/1 "phpsysinfo screenshot") + +## Demo +[Demo on NAS Synology](http://phpsysinfo.sourceforge.net/multi/index.php?disp=bootstrap&xml=synology) + +## Configuration +Edit `phpsysinfo.ini` in `/var/www/phpsysinfo/phpsysinfo.ini`. + +## Documentation + +## YunoHost specific features + +#### Multi-users support + +#### Supported architectures + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/phpsysinfo_ynh%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/phpsysinfo_ynh/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/phpsysinfo_ynh%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/phpsysinfo_ynh/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/phpsysinfo_ynh%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/phpsysinfo_ynh/) + +## Limitations + +## Additional information + +## Links + +--- + +Developers info +---------------- + +**Only if you want to use a testing branch for coding, instead of merging directly into master.** +Please do your pull request to the [testing branch](https://github.com/inrepublica/phpsysinfo_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/inrepublica/phpsysinfo_ynh/tree/testing --debug +or +sudo yunohost app upgrade my_webapp -u https://github.com/inrepublica/phpsysinfo_ynh/tree/testing --debug +``` diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..5ce8c82 --- /dev/null +++ b/conf/app.src @@ -0,0 +1,6 @@ +SOURCE_URL=https://github.com/phpsysinfo/phpsysinfo/archive/v3.3.2.tar.gz +SOURCE_SUM=C13A3F12DC7E5FBC71A7B12645F2F08D +SOURCE_SUM_PRG=md5sum +ARCH_FORMAT=tar.gz +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= \ No newline at end of file diff --git a/conf/nginx.conf b/conf/nginx.conf index 929d465..2e7ac71 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,23 +1,46 @@ -location YNH_WWW_PATH { +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; +location __PATH__/ { - # Path to source - alias YNH_WWW_ALIAS ; + # Path to source + alias __FINALPATH__/www/; - # Example PHP configuration - index index.php; + # Force usage of https + if ($scheme = http) { + rewrite ^ https://$server_name$request_uri? permanent; + } - try_files $uri $uri/ index.php; - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm.sock; + # Default indexes and catch-all + index index.html index.php; + try_files $uri $uri/ __PATH__/index.php?$args; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } + # Prevent useless logs + location = __PATH__/favicon.ico { + log_not_found off; + access_log off; + } + location = __PATH__/robots.txt { + allow all; + log_not_found off; + access_log off; + } - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; -} + # Deny access to hidden files and directories + location ~ ^__PATH__/(.+/|)\.(?!well-known\/) { + deny all; + } + + # Execute and serve PHP files + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } +### End of PHP configuration part + + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; +} \ No newline at end of file diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf new file mode 100644 index 0000000..1f4f865 --- /dev/null +++ b/conf/php-fpm.conf @@ -0,0 +1,436 @@ +; Start a new pool named 'www'. +; the variable $pool can be used in any directive and will be replaced by the +; pool name ('www' here) +[__NAMETOCHANGE__] + +; Per pool prefix +; It only applies on the following directives: +; - 'access.log' +; - '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 + +; 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 = __USER__ +group = __USER__ + +; 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 IPv4 address on +; a specific port; +; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on +; a specific port; +; 'port' - to listen on a TCP socket to all addresses +; (IPv6 and IPv4-mapped) on a specific port; +; '/path/to/unix/socket' - to listen on a unix socket. +; Note: This value is mandatory. +listen = /var/run/php/php7.0-fpm-__NAMETOCHANGE__.sock + +; Set listen(2) backlog. +; Default Value: 511 (-1 on FreeBSD and OpenBSD) +;listen.backlog = 511 + +; 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 0660 +listen.owner = www-data +listen.group = www-data +;listen.mode = 0660 +; When POSIX Access Control Lists are supported you can set them using +; these options, value is a comma separated list of user/group names. +; When set, listen.owner and listen.group are ignored +;listen.acl_users = +;listen.acl_groups = + +; List of addresses (IPv4/IPv6) 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 + +; Specify the nice(2) priority to apply to the pool processes (only if set) +; The value can vary from -19 (highest priority) to 20 (lower priority) +; Note: - It will only work if the FPM master process is launched as root +; - The pool processes will inherit the master process priority +; unless it specified otherwise +; Default Value: no set +; process.priority = -19 + +; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user +; or group is differrent than the master process user. It allows to create process +; core dump and ptrace the process for the pool user. +; Default Value: no +; process.dumpable = yes + +; 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. With this process management, there will be +; always at least 1 children. +; 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. +; ondemand - no children are created at startup. Children will be forked when +; new requests will connect. The following parameter are used: +; pm.max_children - the maximum number of children that +; can be alive at the same time. +; pm.process_idle_timeout - The number of seconds after which +; an idle process 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 when pm is set to 'dynamic' or 'ondemand'. +; 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. The below defaults are based on a server without much resources. Don't +; forget to tweak pm.* to fit your needs. +; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' +; Note: This value is mandatory. +pm.max_children = 5 + +; 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 = 2 + +; 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 = 1 + +; 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 = 3 + +; The number of seconds after which an idle process will be killed. +; Note: Used only when pm is set to 'ondemand' +; Default Value: 10s +;pm.process_idle_timeout = 10s; + +; 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. It shows the following informations: +; pool - the name of the pool; +; process manager - static, dynamic or ondemand; +; start time - the date and time FPM has started; +; start since - number of seconds since FPM has started; +; accepted conn - the number of request accepted by the pool; +; listen queue - the number of request in the queue of pending +; connections (see backlog in listen(2)); +; max listen queue - the maximum number of requests in the queue +; of pending connections since FPM has started; +; listen queue len - the size of the socket queue of pending connections; +; idle processes - the number of idle processes; +; active processes - the number of active processes; +; total processes - the number of idle + active processes; +; max active processes - the maximum number of active processes since FPM +; has started; +; max children reached - number of times, the process limit has been reached, +; when pm tries to start more children (works only for +; pm 'dynamic' and 'ondemand'); +; Value are updated in real time. +; Example output: +; pool: www +; process manager: static +; start time: 01/Jul/2011:17:53:49 +0200 +; start since: 62636 +; accepted conn: 190460 +; listen queue: 0 +; max listen queue: 1 +; listen queue len: 42 +; idle processes: 4 +; active processes: 11 +; total processes: 15 +; max active processes: 12 +; max children reached: 0 +; +; By default the status page output is formatted as text/plain. Passing either +; 'html', 'xml' or 'json' in the 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 +; http://www.foo.bar/status?xml +; +; By default the status page only outputs short status. Passing 'full' in the +; query string will also return status for each pool process. +; Example: +; http://www.foo.bar/status?full +; http://www.foo.bar/status?json&full +; http://www.foo.bar/status?html&full +; http://www.foo.bar/status?xml&full +; The Full status returns for each process: +; pid - the PID of the process; +; state - the state of the process (Idle, Running, ...); +; start time - the date and time the process has started; +; start since - the number of seconds since the process has started; +; requests - the number of requests the process has served; +; request duration - the duration in µs of the requests; +; request method - the request method (GET, POST, ...); +; request URI - the request URI with the query string; +; content length - the content length of the request (only with POST); +; user - the user (PHP_AUTH_USER) (or '-' if not set); +; script - the main script called (or '-' if not set); +; last request cpu - the %cpu the last request consumed +; it's always 0 if the process is not in Idle state +; because CPU calculation is done when the request +; processing has terminated; +; last request memory - the max amount of memory the last request consumed +; it's always 0 if the process is not in Idle state +; because memory calculation is done when the request +; processing has terminated; +; If the process is in Idle state, then informations are related to the +; last request the process has served. Otherwise informations are related to +; the current request being served. +; Example output: +; ************************ +; pid: 31330 +; state: Running +; start time: 01/Jul/2011:17:53:49 +0200 +; start since: 63087 +; requests: 12808 +; request duration: 1250261 +; request method: GET +; request URI: /test_mem.php?N=10000 +; content length: 0 +; user: - +; script: /home/fat/web/docs/php/test_mem.php +; last request cpu: 0.00 +; last request memory: 0 +; +; Note: There is a real-time FPM status monitoring sample web page available +; It's available in: /usr/share/php/7.0/fpm/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 = /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 access log file +; Default: not set +;access.log = log/$pool.access.log + +; The access log format. +; The following syntax is allowed +; %%: the '%' character +; %C: %CPU used by the request +; it can accept the following format: +; - %{user}C for user CPU only +; - %{system}C for system CPU only +; - %{total}C for user + system CPU (default) +; %d: time taken to serve the request +; it can accept the following format: +; - %{seconds}d (default) +; - %{miliseconds}d +; - %{mili}d +; - %{microseconds}d +; - %{micro}d +; %e: an environment variable (same as $_ENV or $_SERVER) +; it must be associated with embraces to specify the name of the env +; variable. Some exemples: +; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e +; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e +; %f: script filename +; %l: content-length of the request (for POST request only) +; %m: request method +; %M: peak of memory allocated by PHP +; it can accept the following format: +; - %{bytes}M (default) +; - %{kilobytes}M +; - %{kilo}M +; - %{megabytes}M +; - %{mega}M +; %n: pool name +; %o: output header +; it must be associated with embraces to specify the name of the header: +; - %{Content-Type}o +; - %{X-Powered-By}o +; - %{Transfert-Encoding}o +; - .... +; %p: PID of the child that serviced the request +; %P: PID of the parent of the child that serviced the request +; %q: the query string +; %Q: the '?' character if query string exists +; %r: the request URI (without the query string, see %q and %Q) +; %R: remote IP address +; %s: status (response code) +; %t: server time the request was received +; it can accept a strftime(3) format: +; %d/%b/%Y:%H:%M:%S %z (default) +; The strftime(3) format must be encapsuled in a %{}t tag +; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t +; %T: time the log has been written (the request has finished) +; it can accept a strftime(3) format: +; %d/%b/%Y:%H:%M:%S %z (default) +; The strftime(3) format must be encapsuled in a %{}t tag +; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t +; %u: remote user +; +; Default: "%R - %u %t \"%m %r\" %s" +;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" + +; The log file for slow requests +; Default Value: not set +; Note: slowlog is mandatory if request_slowlog_timeout is set +;slowlog = log/$pool.log.slow + +; 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 = 0 + +; 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 = 1d + +; Set open file descriptor rlimit. +; Default Value: system defined value +;rlimit_files = 1024 + +; 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 = __FINALPATH__ + +; 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 + +; Clear environment in FPM workers +; Prevents arbitrary environment variables from reaching FPM worker processes +; by clearing the environment in workers before env vars specified in this +; pool configuration are added. +; Setting to "no" will make all environment variables available to PHP code +; via getenv(), $_ENV and $_SERVER. +; Default Value: yes +;clear_env = no + +; Limits the extensions of the main script FPM will allow to parse. This can +; prevent configuration mistakes on the web server side. You should only limit +; FPM to .php extensions to prevent malicious users to use other extensions to +; execute php code. +; Note: set an empty value to allow all extensions. +; Default Value: .php +;security.limit_extensions = .php .php3 .php4 .php5 .php7 + +; 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_admin_value[upload_max_filesize] = 50M +; php_admin_value[post_max_size] = 50M +; php_admin_flag[mail.add_x_header] = Off + +; Other common parameters +; php_admin_value[max_execution_time] = 600 +; php_admin_value[max_input_time] = 300 +; php_admin_value[memory_limit] = 256M +; php_admin_flag[short_open_tag] = On + +; Additional php.ini defines, specific to this pool of workers. +php_value[upload_max_filesize] = 1G +php_value[post_max_size] = 1G +php_value[default_charset] = UTF-8 +php_value[always_populate_raw_post_data] = -1 \ No newline at end of file diff --git a/conf/phpsysinfo.ini b/conf/phpsysinfo.ini index 401f115..851cf54 100644 --- a/conf/phpsysinfo.ini +++ b/conf/phpsysinfo.ini @@ -4,7 +4,7 @@ ; @package PSI ; @author Michael Cramer ; @copyright 2009 phpSysInfo -; @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License +; @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License version 2, or (at your option) any later version ; @version SVN: $Id: phpsysinfo.ini.new 705 2012-11-11 00:33:29Z namiltd $ ; @link http://phpsysinfo.sourceforge.net @@ -47,22 +47,38 @@ ADD_PATHS=false ; ALLOWED=false +; List of sudo commands +; Example : SUDO_COMMANDS="iptables-save" //execute "sudo iptables-save" instead "iptables-save" +; SUDO_COMMANDS=false //no sudo commands +; +SUDO_COMMANDS=false + +; Order of data blocks +; Example : BLOCKS="vitals,hardware,memory,filesystem,network,voltage,current,temperature,fans,power,other,ups" or BLOCKS=true //default order +; BLOCKS=false //hide all blocks +; +BLOCKS=true + + ; Plugins that should be included in xml and output ; List of plugins should look like "plugin,plugin,plugin". See /plugins directory ; - PLUGINS="MDStatus,PS" //list of plugins ; - PLUGINS=false //no plugins ; included plugins: -; - MDStatus - show the raid status and whats currently going on -; - DMRaid - show the software raid status +; - Raid - show the software, fake, zpool or megaraid RAID status ; - PS - show a process tree of all running processes ; - PSStatus - show a graphical representation if a process is running or not ; - Quotas - show a table with all quotas that are active and there current state ; - SMART - show S.M.A.R.T. information from drives that support it -; - BAT - show battery state on a laptop -; - IPMIInfo - show IPMI status +; - BAT - show battery state on a laptop, tablet or phone ; - UpdateNotifier - show update notifications (only for Ubuntu server) ; - SNMPPInfo - show printers info via SNMP ; - Uprecords - show uprecords info +; - Iptables - show iptables rules list +; - PingTest - show Ping Test info +; - StableBit - show StableBit Scanner info (WinNT) +; - HyperV - show Hyper-V info (WinNT) +; - Docker - show docker stats ; PLUGINS=false @@ -78,12 +94,12 @@ PLUGINS=false ; static: static page (use metatag to reload page) ; bootstrap: use twitter bootstrap template ; -DEFAULT_DISPLAY_MODE="YNH_DISPLAY_MODE" +DEFAULT_DISPLAY_MODE="__DISPLAY_MODE__" ; Define the default language ; -DEFAULT_LANG="YNH_DEFAULT_LANGUAGE" +DEFAULT_LANG="__LANGUAGE__" ; Define the default template @@ -121,6 +137,11 @@ SHOW_CPUINFO_EXPANDED=false SHOW_MEMORY_INFOS_EXPANDED=false +; Hide loader for frontend "bootstrap" +; +HIDE_BOOTSTRAP_LOADER=false + + ; Define the interval for refreshing data in ms ; - 0 : disabled ; - 1000 : 1 second @@ -131,9 +152,10 @@ REFRESH=60000 ; Show a graph for current cpuload ; - true : displayed, but it's a performance hit (because we have to wait to get a value, 1 second) +; - "compact" : displayed like above but in compact mode ; - false : will not be displayed ; -LOAD_BAR=false +LOAD_BAR=true ; Display the virtual host name and address @@ -172,13 +194,32 @@ BYTE_FORMAT="auto_binary" TEMP_FORMAT="c" +; Show devices infos +; Example : SHOW_DEVICES_INFOS=true +; +SHOW_DEVICES_INFOS=true + + +; Show devices serial number +; Example : SHOW_DEVICES_SERIAL=true +; +SHOW_DEVICES_SERIAL=false + + +; Format in which datetime is displayed +; - "UTC" shown as UTC string +; - "locale" shown as Locale string +; +DATETIME_FORMAT="UTC" + + ; ******************************** ; SENSORS PARAMETERS ; ******************************** ; Define the motherboard monitoring program -; We support the following programs far +; We support the following programs so far ; - HDDtemp http://www.guzu.net/linux/hddtemp.php (Linux) ; - LMSensors http://www.lm-sensors.org/ (Linux) ; - Healthd http://healthd.thehousleys.net/ (FreeBSD) @@ -186,7 +227,7 @@ TEMP_FORMAT="c" ; - MBMon http://www.nt.phys.kyushu-u.ac.jp/shimizu/download/download.html (FreeBSD/Linux/NetBSD/OpenBSD) ; - MBM5 http://mbm.livewiredev.com/ (data from file data/MBM5.csv - WinNT) ; - Coretemp No addon tool neded (FreeBSD/Linux) -; - IPMI http://openipmi.sourceforge.net/ (Linux) +; - IPMItool http://ipmitool.sourceforge.net/ (Linux) ; - FreeIPMI http://www.gnu.org/software/freeipmi/ (FreeBSD/Linux/OpenBSD/SunOS) ; - IPMIutil http://ipmiutil.sourceforge.net/ (Darwin/FreeBSD/Linux/SunOS/WinNT) ; - K8Temp http://hur.st/k8temp/ (DragonFly/FreeBSD/NetBSD/OpenBSD) @@ -196,18 +237,26 @@ TEMP_FORMAT="c" ; - QTSsnmp SNMP service enabled and snmp-utils package installed: opkg install snmp-utils (QNAP - QTS Linux) ; - Hwmon No addon tool neded (Linux) ; - SpeedFan http://www.almico.com/speedfan.php (required tool packaged in: tools/speedfan/SpeedFanGet_bin.zip) (WinNT) +; - Thinkpad No addon tool neded (Lenovo Thinkpad - Linux) ; ; Example: If you want to use lmsensors : SENSOR_PROGRAM="LMSensors" -; If you want to use lmsensors and IPMI: SENSOR_PROGRAM="LMSensors,IPMI" +; If you want to use lmsensors and IPMItool: SENSOR_PROGRAM="LMSensors,IPMItool" ; SENSOR_PROGRAM=false + ; Show events of sensors ; - true : show events ; - false : do not show events ; SENSOR_EVENTS=true + +; Sort sensors list +; +SORT_SENSORS_LIST=false + + ; Some sensors programs contain an additional configuration in the relevant sections [sensor_...] @@ -250,6 +299,32 @@ SHOW_INODES=true HIDE_MOUNTS="" +; Filesystem usage warning threshold in percent +; - 0 : disabled +; - 90 : 90% +; Default is 90% +; +FS_USAGE_THRESHOLD=90 + + +; Ignore usage and usage threshold for filesystem types +; Example : IGNORE_THRESHOLD_FS_TYPES="iso9660, squashfs, devfs, devtmpfs, lxfs, udf, UDF, CDFS" +; +IGNORE_THRESHOLD_FS_TYPES="iso9660, squashfs, devfs, devtmpfs, lxfs, udf, UDF, CDFS" + + +; Ignore usage of mounts +; Example : IGNORE_USAGE="/root,/mnt/c" +; +IGNORE_USAGE="" + + +; Ignore free space size of mounts +; Example : IGNORE_FREE="/zfs/space,/zfs/data" +; +IGNORE_FREE="" + + ; Hide filesystem types ; Example : HIDE_FS_TYPES="tmpfs,devtmpfs,usbfs,bstfolder" ; @@ -263,14 +338,6 @@ HIDE_FS_TYPES="" HIDE_DISKS="" -; Filesystem usage warning threshold in percent -; - 0 : disabled -; - 90 : 90% -; Default is 90% -; -FS_USAGE_THRESHOLD=90 - - ; ******************************** ; NETWORK PARAMETERS ; ******************************** @@ -289,11 +356,29 @@ HIDE_NETWORK_INTERFACE="" SHOW_NETWORK_INFOS=true +; Hide MAC address in the infos +; +HIDE_NETWORK_MACADDR=false + + +; Sort network interfaces list +; +SORT_NETWORK_INTERFACES_LIST=false + + ; Show network infos expanded ; SHOW_NETWORK_INFOS_EXPANDED=false +; Show network active speed +; - true : display network active speed +; - "bps" : display network active speed in bits per second (b/s, Kb/s, etc...) +; - false : hide them +; +SHOW_NETWORK_ACTIVE_SPEED=false + + ; ******************************** ; UPS PARAMETERS ; ******************************** @@ -389,11 +474,12 @@ ACCESS="command" ; ACCESS="command" -[sensor_ipmi] -; IPMI motherboard monitoring program configuration +[sensor_ipmitool] +; IPMItool motherboard monitoring program configuration ; -; - ACCESS="command" //read data from 'ipmitool sensor' command -; - ACCESS="data" //read data from file data/ipmi.txt +; - ACCESS="command" //read data from 'ipmitool sensor -v' command +; //if access error execute first: chmod 666 /dev/ipmi0 +; - ACCESS="data" //read data from file data/ipmitool.txt ; ACCESS="command" @@ -409,6 +495,7 @@ ACCESS="command" ; IPMIutil motherboard monitoring program configuration ; ; - ACCESS="command" //read data from 'ipmiutil sensor -stw' command +; //if access error execute first: chmod 666 /dev/ipmi0 ; - ACCESS="data" //read data from file data/ipmiutil.txt ; ACCESS="command" @@ -439,67 +526,66 @@ ACCESS="command" ; BAT Plugin configuration ; define how to access the battery statistic data -; - "command" read data from /proc/acpi/battery/BAT0/info and /proc/acpi/battery/BAT0/state -; on newer kernel or on Android read files from /sys/class/power_supply/ - on Darwin read data from 'ioreg -w0 -l -n AppleSmartBattery -r' command - on FreeBSD read data from 'acpiconf -i batt' command - on OpenBSD read data from 'sysctl hw.sensors.acpibat0' command +; - "command" on Linux and Android read data from /proc/acpi/battery/BAT0/info and /proc/acpi/battery/BAT0/state +; or on newer kernel from /sys/class/power_supply/ +; or from 'upower -d' command (if UPOWER is true) +; on Android read data from /sys/class/power_supply/ +; on Darwin read data from 'ioreg -w0 -l -n AppleSmartBattery -r' command +; on FreeBSD read data from 'acpiconf -i batt' command +; on OpenBSD read data from 'sysctl hw.sensors.acpibat0' command ; - "data" (a file must be available in the data directory of the phpsysinfo installation ; with the filename "bat_info.txt" and "bat_state.txt"; content is the output ; from "cat /proc/acpi/battery/BAT0/info" and "cat /proc/acpi/battery/BAT0/state") ; ACCESS="command" -; define the battery device (no matter for WinNT, FreeBSD, Darwin and some Android and Linux) +; on Lunux try executing 'upower -d' command +; +UPOWER=false + +; Show battery serial number ; -DEVICE="BAT0" +SHOW_SERIAL=false -[ipmiinfo] -; ipmiinfo Plugin configuration +[raid] +; Raid Plugin configuration -; define how to access the IPMI statistic data -; - "command" ipmitool command is run everytime the block gets refreshed or build -; if access error execute first: chmod 666 /dev/ipmi0 +; define how to access the raid statistic data +; - "command" - mdstat: file "/proc/mdstat" is read (on Linux only) +; - dmraid: command "dmraid -s -vv 2>&1" is run (on Linux only) +; If access error try execute first: chmod 4755 /sbin/dmraid +; This method is not recommended for safety reasons! +; - megactl: command "megactl" (on Linux only) +; downloaded from http://sourceforge.net/projects/megactl/ or http://github.com/hmage/megactl +; If permission error try execute first: chmod 4755 /usr/sbin/megactl +; - megasasctl: command "megasasctl" (on Linux only) +; downloaded from http://sourceforge.net/projects/megactl/ or http://github.com/hmage/megactl +; If permission error try execute first: chmod 4755 /usr/sbin/megasasctl +; - graid: command "graid list" is run (on FreeBSD only) +; - zpool: command "zpool status" is run +; - idrac: command "snmpwalk -Ona -c public -v 1 -r 0 -t 3 {device} .1.3.6.1.4.1.674.10892.5.5.1.20" is run +; - "php-snmp"- idrac: execute php snmprealwalk function (php-snmp module must be installed) +; - for others the option is inactive (uses "command" instead) ; - "data" (a file must be available in the data directory of the phpsysinfo installation -; with the filename "ipmiinfo.txt"; content is the output from "ipmitool sensor") +; with the filename "raidmdstat.txt" or "raiddmraid.txt" or "raidmegactl.txt" +; or "raidmegasasctl.txt" or "raidgraid.txt" or "raidzpool.txt" or "raididrac{device_number}.txt") ; ACCESS="command" - -[mdstatus] -; MDStatus Plugin configuration - -; define how to access the mdstat statistic data -; - "file" /proc/mdstat is read -; - "data" (a file must be available in the data directory of the phpsysinfo installation -; with the filename "mdstat.txt"; content is the output from "cat /proc/mdstat") -; -ACCESS="file" +; define possible programs +PROGRAM="mdstat,dmraid,megactl,megasasctl,graid,zpool,idrac" ; Hide RAID devices -; Example : HIDE_RAID_DEVICES="md127" +; Example : HIDE_DEVICES="md127" ; -HIDE_RAID_DEVICES="" +HIDE_DEVICES="" - -[dmraid] -; DMRaid Plugin configuration - -; define how to access the dmraid statistic data -; - "command" dmraid command is run everytime the block gets refreshed or build -; if access error try execute first: chmod 4755 /sbin/dmraid -; This method is not recommended for safety reasons! -; - "data" (a file must be available in the data directory of the phpsysinfo installation -; with the filename "dmraid.txt"; content is generated by command "dmraid -s -vv >dmraid.txt 2>&1") ; -ACCESS="command" - -; Hide RAID devices -; Example : HIDE_RAID_DEVICES=".ddf1_disks" +; string contains a list of IDRAC devices that are checked +; Example : IDRAC_DEVICES="192.168.0.120" ; -HIDE_RAID_DEVICES="" - +IDRAC_DEVICES="" [ps] ; PS Plugin configuration @@ -512,9 +598,21 @@ HIDE_RAID_DEVICES="" ; ACCESS="command" +; Memory Usage info +; +MEMORY_USAGE=true + +; CPU Usage info +; +CPU_USAGE=true + ; Show kthreadd child list expanded ; -SHOW_KTHREADD_EXPANDED=true +SHOW_KTHREADD_EXPANDED=false + +; Show PID 1 child list expanded +; +SHOW_PID1CHILD_EXPANDED=false [psstatus] @@ -525,7 +623,7 @@ SHOW_KTHREADD_EXPANDED=true ; information is retrieved everytime through WMI ; - "data" a file must be available in the data directory of the phpsysinfo installation ; with the filename "psstatus.txt"; content is the output from -; for ps in "apache2" "mysqld" "sshd"; do echo $ps "|" `pidof -s $ps`; done +; for ps in "apache2" "mysqld" "sshd"; do echo $ps "|" `pidof -s -x "$ps"`; done ; ACCESS="command" @@ -560,10 +658,13 @@ ACCESS="command" ; - "command" smartctl command is run everytime the block gets refreshed or build ; if error: Smartctl open device: /dev/sda failed: Permission denied ; Not recommended method: -; execute: chmod 4755 /usr/sbin/smartctl +; execute: chmod 4755 /usr/sbin/smartctl +; Second method: +; try to set: SUDO_COMMANDS="smartctl" and add to file /etc/sudoers line: apache ALL = (ALL) NOPASSWD: /usr/sbin/smartctl ; - "data" (a file must be available in the data directory of the ; phpsysinfo installation with the filename "smart{disk_number}.txt"; ; content is the output from "smartctl --all device") +; - "wmi" information is retrieved everytime through WMI (WinNT only) ; ACCESS="command" @@ -595,9 +696,10 @@ IDS="005-RAW_VALUE,194-RAW_VALUE,4-RAW_VALUE,009-RAW_VALUE,012-RAW_VALUE,193-RAW ; - "data" a file must be available in the data directory of the ; phpsysinfo installation with the filename "snmppinfo{printer_number}.txt"; ; content is the output from: -; LANG=C LC_ALL=C snmpwalk -On -c public -v 1 {printer_address} .1.3.6.1.2.1.1.5 > snmppinfo{printer_number}.txt -; LANG=C LC_ALL=C snmpwalk -On -c public -v 1 {printer_address} .1.3.6.1.2.1.43.11.1.1 >> snmppinfo{printer_number}.txt -; LANG=C LC_ALL=C snmpwalk -On -c public -v 1 {printer_address} .1.3.6.1.2.1.43.18.1.1 >> snmppinfo{printer_number}.txt +; LANG=C LC_ALL=C snmpwalk -On -c public -v 1 -r 0 -t 3 {printer_address} .1.3.6.1.2.1.1.5 > snmppinfo{printer_number}.txt +; LANG=C LC_ALL=C snmpwalk -On -c public -v 1 -r 0 -t 3 {printer_address} .1.3.6.1.4.1.367.3.2.1.2.24.1.1 >> snmppinfo{printer_number}.txt +; LANG=C LC_ALL=C snmpwalk -On -c public -v 1 -r 0 -t 3 {printer_address} .1.3.6.1.2.1.43.11.1.1 >> snmppinfo{printer_number}.txt +; LANG=C LC_ALL=C snmpwalk -On -c public -v 1 -r 0 -t 3 {printer_address} .1.3.6.1.2.1.43.18.1.1 >> snmppinfo{printer_number}.txt ; ACCESS="php-snmp" @@ -611,6 +713,12 @@ DEVICES="192.168.0.5, 192.168.0.9" [updatenotifier] ; Update Notifier Plugin configuration +; define how to access the updatenotifier statistic data +; - "command" execute command /usr/lib/update-notifier/apt-check +; - "data" reads data from file defined in FILE parameter +; +ACCESS="data" + ; define the update info file format ; - true: Ubuntu Landscape format (file: /var/lib/update-notifier/updates-available) ; - false: universal format (format: A;B) @@ -619,10 +727,11 @@ DEVICES="192.168.0.5, 192.168.0.9" ; UBUNTU_LANDSCAPE_FORMAT=true -; define the update info file +; define the update info file. The default is: /var/lib/update-notifier/updates-available ; FILE="/var/lib/update-notifier/updates-available" + [uprecords] ; Uprecords Plugin configuration @@ -639,3 +748,76 @@ ACCESS="command" ; default is 10 ; MAX_ENTRIES = 10 + +; define the short mode (do not print extra statistics) +; default is false +; +SHORT_MODE = false + +; denote current system session by asterisk (* at the end) instead by the arrow (-> at the beginning) +; default is false +; +DENOTE_BY_ASTERISK = false + + +[iptables] +; Iptables Plugin configuration + +; define how to access the iptables rules data +; - "command" iptables-save command is run everytime the block gets refreshed or build +; if access error try to set: SUDO_COMMANDS="iptables-save" and add to file /etc/sudoers line: apache ALL = (ALL) NOPASSWD: /sbin/iptables-save +; - "data" (a file must be available in the data directory of the phpsysinfo installation with the filename "iptables.txt"; content is the output from "iptables-save") +; +ACCESS="command" + + +[pingtest] +; PingTest Plugin configuration + +; define how to access the psstatus statistic data +; - "command" ping command is run everytime the block gets refreshed or build +; - "data" (a file must be available in the data directory of the phpsysinfo installation +; with the filename "pingtest.txt") +; +ACCESS="command" + +;define the Addresses +; +; string contains a list of addresses that are checked +; Example : ADDRESSES="127.0.0.1,8.8.8.8" +; +ADDRESSES="" + +; Define ping timeout in seconds +; - 0 : default ping command timeout +; - 3 : 3 seconds +; Default is 2 seconds +; +TIMEOUT=2 + +[stablebit] +; StableBit Plugin configuration + +; Show or hide disks serial number +; +SHOW_SERIAL=false + +[hyperv] +; HyperV Plugin configuration + +; define how to access the ps statistic data +; - "command" information is retrieved through WMI +; - "data" (a file must be available in the data directory of the phpsysinfo installation +; with the filename "hyperv.txt") +; +ACCESS="command" + +[docker] +; Docker Plugin configuration + +; define how to access the docker statistic data +; - "command" docker command is run everytime the block gets refreshed or build +; - "data" (a file must be available in the data directory of the phpsysinfo installation +; with the filename "docker.txt"; content is the output from "docker stats --no-stream --format 'table {{.Name}}\t{{.CPUPerc}}\t{{.MemUsage}}\t{{.MemPerc}}\t{{.NetIO}}\t{{.BlockIO}}\t{{.PIDs}}'") +; +ACCESS="command" diff --git a/manifest.json b/manifest.json index fb385e1..32fad2d 100644 --- a/manifest.json +++ b/manifest.json @@ -1,24 +1,25 @@ { - "name": "PhpSysInfo", "id": "phpsysinfo", + "name": "PhpSysInfo", "packaging_format": 1, "description": { "en": "A customizable PHP script that displays information about your system nicely.", "fr": "Un script PHP paramétrable qui affiche des informations sur votre système." }, - "url": "http://phpsysinfo.github.io/phpsysinfo/", - "license": "free", + "version": "3.3.2~ynh2", + "url": "https://github.com/inrepublica/phpsysinfo_ynh/", + "license": "GPL-3.0-only", "maintainer": { "name": "inrepublica", "email": "duvalmickael@gmail.com" }, "requirements": { - "yunohost": ">= 2.4.0.6" + "yunohost": ">= 3.6.5" }, "multi_instance": false, "services": [ "nginx", - "php5-fpm" + "php7.0-fpm" ], "arguments": { "install" : [ @@ -43,12 +44,12 @@ }, { "name": "is_public", + "type": "boolean", "ask": { - "en": "Is it a public WordPress site?", + "en": "Is it a public website?", "fr": "Est-ce un site public ?" }, - "choices": ["Yes", "No"], - "default": "No" + "default": false }, { "name": "language", @@ -68,6 +69,7 @@ "choices": ["auto", "dynamic", "static", "bootstrap"], "default": "bootstrap" } + } ] } -} +} \ No newline at end of file diff --git a/scripts/_common.sh b/scripts/_common.sh new file mode 100644 index 0000000..cc1f786 --- /dev/null +++ b/scripts/_common.sh @@ -0,0 +1 @@ +#!/bin/bash \ No newline at end of file diff --git a/scripts/backup b/scripts/backup index 1868b73..83eb601 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,19 +1,56 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# See comments in install script -app=phpsysinfo +source ../settings/scripts/_common.sh +source /usr/share/yunohost/helpers -# Source YunoHost helpers -. /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= -# Retrieve app settings -domain=$(ynh_app_setting_get "$app" domain) +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors -# Backup sources & data -ynh_backup "/var/www/${app}" "sources" +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading installation settings..." -# Copy NGINX configuration -ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf" \ No newline at end of file +app=$YNH_APP_INSTANCE_NAME + +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +domain=$(ynh_app_setting_get --app=$app --key=domain) + +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP THE APP MAIN DIR +#================================================= +ynh_script_progression --message="Backing up the main app directory..." + +ynh_backup --src_path="$final_path" + +#================================================= +# BACKUP THE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Backing up nginx web server configuration..." + +ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" + +#================================================= +# BACKUP THE PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Backing up php-fpm configuration..." + +ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf" + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --last \ No newline at end of file diff --git a/scripts/change_url b/scripts/change_url new file mode 100644 index 0000000..3aeea70 --- /dev/null +++ b/scripts/change_url @@ -0,0 +1,92 @@ +#!/bin/bash + +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +old_domain=$YNH_APP_OLD_DOMAIN +old_path=$YNH_APP_OLD_PATH + +new_domain=$YNH_APP_NEW_DOMAIN +new_path=$YNH_APP_NEW_PATH + +app=$YNH_APP_INSTANCE_NAME + +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading installation settings..." + +# Needed for helper "ynh_add_nginx_config" +final_path=$(ynh_app_setting_get --app=$app --key=final_path) + +#================================================= +# CHECK WHICH PARTS SHOULD BE CHANGED +#================================================= + +change_domain=0 +if [ "$old_domain" != "$new_domain" ] +then + change_domain=1 +fi + +change_path=0 +if [ "$old_path" != "$new_path" ] +then + change_path=1 +fi + +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# MODIFY URL IN NGINX CONF +#================================================= +ynh_script_progression --message="Updating nginx web server configuration..." --weight=2 + +nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf + +# Change the path in the nginx config file +if [ $change_path -eq 1 ] +then + # Make a backup of the original nginx config file if modified + ynh_backup_if_checksum_is_different --file="$nginx_conf_path" + # Set global variables for nginx helper + domain="$old_domain" + path_url="$new_path" + # Create a dedicated nginx config + ynh_add_nginx_config +fi + +# Change the domain for nginx +if [ $change_domain -eq 1 ] +then + # Delete file checksum for the old conf file location + ynh_delete_file_checksum --file="$nginx_conf_path" + mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf + # Store file checksum for the new config file location + ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" +fi + +#================================================= +# GENERIC FINALISATION +#================================================= +# RELOAD NGINX +#================================================= +ynh_script_progression --message="Reloading nginx web server..." + +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Change of URL completed for $app" --last \ No newline at end of file diff --git a/scripts/install b/scripts/install index b47bb97..46d0a5f 100644 --- a/scripts/install +++ b/scripts/install @@ -1,69 +1,119 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Define app -app=phpsysinfo -version=3.2.5 -md5_source=08875b31a9a7a662473d8cbe866059e7 +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 + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= -# Retrieve arguments domain=$YNH_APP_ARG_DOMAIN -path=$YNH_APP_ARG_PATH +path_url=$YNH_APP_ARG_PATH is_public=$YNH_APP_ARG_IS_PUBLIC language=$YNH_APP_ARG_LANGUAGE display_mode=$YNH_APP_ARG_DISPLAY_MODE -# Source YunoHost helpers -. /usr/share/yunohost/helpers +app=$YNH_APP_INSTANCE_NAME +app_nb=$YNH_APP_INSTANCE_NUMBER -# Save app settings -ynh_app_setting_set "$app" domain "$domain" -ynh_app_setting_set "$app" path "$path" -ynh_app_setting_set "$app" is_public "$is_public" -ynh_app_setting_set "$app" language "$language" -ynh_app_setting_set "$app" display_mode "$display_mode" +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS +#================================================= +ynh_script_progression --message="Validating installation parameters..." --weight=2 -# Check domain/path availability -sudo yunohost app checkurl "${domain}${path}" -a "$app" \ - || ynh_die "Path not available: ${domain}${path}" - -# Download source, check md5, untar, copy it -sudo wget -q https://github.com/phpsysinfo/phpsysinfo/archive/v$version.tar.gz -O /tmp/phpsysinfo.tar.gz - -# Check md5 -md5_check=($(md5sum /tmp/phpsysinfo.tar.gz)) -if [ $md5_source != $md5_check ] -then - ynh_die "the download is corrupted (md5 different)" -fi - -# untar and copy it -sudo tar -xvf /tmp/phpsysinfo.tar.gz -C /tmp/ final_path=/var/www/$app -sudo mkdir -p $final_path -sudo cp -a /tmp/phpsysinfo-$version/. $final_path +test ! -e "$final_path" || ynh_die --message="This path already contains a folder" -# Modify Phpsysinfo configuration and copy it -sed -i "s@YNH_DEFAULT_LANGUAGE@$language@g" ../conf/phpsysinfo.ini -sed -i "s@YNH_DISPLAY_MODE@$display_mode@g" ../conf/phpsysinfo.ini -sudo cp ../conf/phpsysinfo.ini $final_path +# Register (book) web path +ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url -# Set permissions to phpsysinfo directory -sudo chown -R www-data: $final_path +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= +ynh_script_progression --message="Storing installation settings..." -# Modify Nginx configuration file and copy it to Nginx conf directory -sed -i "s@YNH_WWW_PATH@$path@g" ../conf/nginx.conf -sed -i "s@YNH_WWW_ALIAS@$final_path/@g" ../conf/nginx.conf -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +user=webapp${app_nb} +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=is_public --value=$is_public +ynh_app_setting_set --app=$app --key=language --value=$language +ynh_app_setting_set --app=$app --key=display_mode --value=$display_mode +ynh_app_setting_set --app=$app --key=user --value=$user +ynh_app_setting_set --app=$app --key=final_path --value=$final_path -# If app is public, add url to SSOWat conf as skipped_uris -if [ "$is_public" = "Yes" ]; +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring nginx web server..." --weight=2 + +# Create a dedicated nginx config +ynh_add_nginx_config + +#================================================= +# SPECIFIC SETUP +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= +ynh_script_progression --message="Setting up source files..." --weight=3 + +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" + +#================================================= +# MODIFY A CONFIG FILE +#================================================= + +ynh_replace_string --match_string="__DISPLAY_MODE__" --replace_string="$display_mode" --target_file=../conf/phpsysinfo.ini +ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file=../conf/phpsysinfo.ini + +# Copy files to the right place +cp -r ../conf/phpsysinfo.ini "$final_path" + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring php-fpm..." --weight=2 + +# Create a dedicated php-fpm config +ynh_replace_string --match_string="__USER__" --replace_string="$user" --target_file="../conf/php-fpm.conf" +ynh_add_fpm_config + +#================================================= +# GENERIC FINALIZATION +#================================================= +# SETUP SSOWAT +#================================================= +ynh_script_progression --message="Configuring SSOwat..." + +# Make app public if necessary +if [ $is_public -eq 1 ] then - # unprotected_uris allows SSO credentials to be passed anyway. - ynh_app_setting_set "$app" unprotected_uris "/" + ynh_app_setting_set --app=$app --key=skipped_uris --value="/" fi -# Restart services -sudo service nginx reload \ No newline at end of file +#================================================= +# RELOAD NGINX +#================================================= +ynh_script_progression --message="Reloading nginx web server..." + +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= \ No newline at end of file diff --git a/scripts/remove b/scripts/remove index f84322a..7243194 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,19 +1,62 @@ #!/bin/bash -# Define app -app=phpsysinfo +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Source YunoHost helpers -. /usr/share/yunohost/helpers +source _common.sh +source /usr/share/yunohost/helpers -# Retrieve app settings -domain=$(ynh_app_setting_get "$app" domain) +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading installation settings..." --weight=2 -# Remove sources -sudo rm -rf /var/www/$app +app=$YNH_APP_INSTANCE_NAME -# Remove configuration files -sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf +domain=$(ynh_app_setting_get --app=$app --key=domain) +user=$(ynh_app_setting_get --app=$app --key=user) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) -# Restart services -sudo service nginx reload \ No newline at end of file +#================================================= +# STANDARD REMOVE +#================================================= +# REMOVE APP MAIN DIR +#================================================= +ynh_script_progression --message="Removing app main directory..." + +# Remove the app directory securely +ynh_secure_remove --file="$final_path" + +#================================================= +# REMOVE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Removing nginx web server configuration..." --weight=2 + +# Remove the dedicated nginx config +ynh_remove_nginx_config + +#================================================= +# REMOVE PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Removing php-fpm configuration..." + +# Remove the dedicated php-fpm config +ynh_remove_fpm_config + +#================================================= +# GENERIC FINALIZATION +#================================================= +# REMOVE DEDICATED USER +#================================================= +ynh_script_progression --message="Removing the dedicated system user..." + +# Delete a system user +ynh_system_user_delete --username=$app + +#================================================= +# END OF SCRIPT +#================================================= +ynh_script_progression --message="Removal of $app completed" --last \ No newline at end of file diff --git a/scripts/restore b/scripts/restore index 3b25824..c0d9ef4 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,32 +1,76 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# See comments in install script -app=phpsysinfo +source ../settings/scripts/_common.sh +source /usr/share/yunohost/helpers -# Source YunoHost helpers -. /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= -# Retrieve old app settings -domain=$(ynh_app_setting_get "$app" domain) -path=$(ynh_app_setting_get "$app" path) +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors -# Check domain/path availability -sudo yunohost app checkurl "${domain}${path}" -a "$app" \ - || ynh_die "Path not available: ${domain}${path}" +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading settings..." --weight=2 -# Restore sources & data -final_path="/var/www/${app}" -sudo cp -a ./sources "$final_path" +app=$YNH_APP_INSTANCE_NAME -# Restore permissions to app files -# you may need to make some file and/or directory writeable by www-data (nginx user) -sudo chown -R root:root "$final_path" +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +user=$(ynh_app_setting_get --app=$app --key=user) -# Restore NGINX configuration -sudo cp -a ./nginx.conf "/etc/nginx/conf.d/${domain}.d/${app}.conf" +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= +ynh_script_progression --message="Validating restoration parameters..." --weight=2 -# Restart webserver -sudo service nginx reload \ No newline at end of file +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 " + +#================================================= +# STANDARD RESTORATION STEPS +#================================================= +# RESTORE THE NGINX CONFIGURATION +#================================================= + +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" + +#================================================= +# RESTORE THE APP MAIN DIR +#================================================= +ynh_script_progression --message="Restoring the app main directory..." + +ynh_restore_file --origin_path="$final_path" + +#================================================= +# RESTORE THE PHP-FPM CONFIGURATION +#================================================= + +ynh_restore_file --origin_path="/etc/php/7.0/fpm/pool.d/$app.conf" + +#================================================= +# GENERIC FINALIZATION +#================================================= +# RELOAD NGINX AND PHP-FPM +#================================================= +ynh_script_progression --message="Reloading nginx web server and php-fpm..." + +ynh_systemd_action --service_name=php7.0-fpm --action=reload +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Restoration completed for $app" --last \ No newline at end of file diff --git a/scripts/upgrade b/scripts/upgrade index e570bdd..ee7d7e4 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,55 +1,161 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Define app -app=phpsysinfo -version=3.2.5 -md5_source=08875b31a9a7a662473d8cbe866059e7 +source _common.sh +source /usr/share/yunohost/helpers -# Source YunoHost helpers -. /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading installation settings..." --weight=2 -# Retrieve app settings -domain=$(ynh_app_setting_get "$app" domain) -path=$(ynh_app_setting_get "$app" path) -is_public=$(ynh_app_setting_get "$app" is_public) -language=$(ynh_app_setting_get "$app" language) -display_mode=$(ynh_app_setting_get "$app" display_mode) +app=$YNH_APP_INSTANCE_NAME -# Download source, check md5, untar, copy it -sudo wget -q https://github.com/phpsysinfo/phpsysinfo/archive/v$version.tar.gz -O /tmp/phpsysinfo.tar.gz +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +is_public=$(ynh_app_setting_get --app=$app --key=is_public) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +language=$(ynh_app_setting_get --app=$app --key=language) +display_mode=$(ynh_app_setting_get --app=$app --key=display_mode) +user=$(ynh_app_setting_get --app=$app --key=user) -# Check md5 -md5_check=($(md5sum /tmp/phpsysinfo.tar.gz)) -if [ $md5_source != $md5_check ] -then - ynh_die "the download is corrupted (md5 different)" +#================================================= +# CHECK VERSION +#================================================= +upgrade_type=$(ynh_check_app_version_changed) + +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_script_progression --message="Ensuring downward compatibility..." + +# Fix is_public as a boolean value +if [ "$is_public" = "Yes" ]; then + ynh_app_setting_set --app=$app --key=is_public --value=1 + is_public=1 +elif [ "$is_public" = "No" ]; then + ynh_app_setting_set --app=$app --key=is_public --value=0 + is_public=0 fi -# untar and copy it -sudo tar -xvf /tmp/phpsysinfo.tar.gz -C /tmp/ -final_path=/var/www/$app -sudo mkdir -p $final_path -sudo cp -a /tmp/phpsysinfo-$version/. $final_path - -# Set permissions to app files -sudo chown -R root:root $final_path - -# Modify Nginx configuration file and copy it to Nginx conf directory -sed -i "s@YNH_WWW_PATH@$path@g" ../conf/nginx.conf -sed -i "s@YNH_WWW_ALIAS@$final_path/@g" ../conf/nginx.conf -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf - -# If app is public, add url to SSOWat conf as skipped_uris -if [ "$is_public" = "Yes" ]; -then - # See install script - ynh_app_setting_set "$app" unprotected_uris "/" - # Remove old settings - ynh_app_setting_delete "$app" skipped_uris +# If final_path doesn't exist, create it +if [ -z "$final_path" ]; then + final_path=/var/www/$app + ynh_app_setting_set --app=$app --key=final_path --value=$final_path fi -# Restart services -sudo service nginx reload \ No newline at end of file +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=3 + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# CHECK THE PATH +#================================================= + +# Normalize the URL path syntax +path_url=$(ynh_normalize_url_path --path_url=$path_url) + +#================================================= +# STANDARD UPGRADE STEPS +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= + +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Upgrading source files..." --weight=6 + + # Download, check integrity, uncompress and patch the source from app.src + ynh_setup_source --dest_dir="$final_path" + + # Clear cache + ynh_secure_remove --file="$final_path/var/cache" + mkdir "$final_path/var/cache" +fi + +#================================================= +# NGINX CONFIGURATION +#================================================= + +modified_config=$(ynh_backup_if_checksum_is_different --file="/etc/nginx/conf.d/$domain.d/$app.conf") +# Replace nginx config only if it wasn't modified. +if [ -z "$modified_config" ] +then + ynh_script_progression --message="Upgrading nginx web server configuration..." --weight=2 + + # Create a dedicated nginx config + ynh_add_nginx_config +fi + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + +modified_config=$(ynh_backup_if_checksum_is_different --file="/etc/php/7.0/fpm/pool.d/$app.conf") +# Replace nginx config only if it wasn't modified. +if [ -z "$modified_config" ] +then + ynh_script_progression --message="Upgrading php-fpm configuration..." --weight=2 + + # Create a dedicated php-fpm config + ynh_replace_string --match_string="__USER__" --replace_string="$user" --target_file="../conf/php-fpm.conf" + ynh_add_fpm_config +fi + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# CONFIGURE PHPSYSINFO +#================================================= +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Reconfiguring Phpsysinfo..." --weight=11 + + ynh_replace_string --match_string="__DISPLAY_MODE__" --replace_string="$display_mode" --target_file=../conf/phpsysinfo.ini + ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file=../conf/phpsysinfo.ini + + # Copy files to the right place + cp -r ../conf/phpsysinfo.ini "$final_path" +fi + + +#================================================= +# GENERIC FINALIZATION +#================================================= +# SETUP SSOWAT +#================================================= +ynh_script_progression --message="Upgrading SSOwat configuration..." + +# Make app public if necessary +if [ $is_public -eq 1 ] +then + ynh_app_setting_set --app=$app --key=skipped_uris --value="/" +fi + +#================================================= +# RELOAD NGINX +#================================================= +ynh_script_progression --message="Reloading nginx web server..." + +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Upgrade of $app completed" --last \ No newline at end of file