From 6ed5b79d45edaf81f411695692ac837583647d47 Mon Sep 17 00:00:00 2001 From: Kayou Date: Sat, 23 Feb 2019 00:46:33 +0100 Subject: [PATCH] Complete refactor of the install script --- check_process | 14 +- conf/{nginx_wifiadmin.conf => nginx.conf} | 15 +- conf/php-fpm.conf | 431 ++++++++++++++++++++++ conf/phpfpm_wifiadmin.conf | 202 ---------- conf/ynh-hotspot | 4 +- manifest.json | 6 +- scripts/install | 224 ++++++----- sources/config.php | 4 +- 8 files changed, 562 insertions(+), 338 deletions(-) rename conf/{nginx_wifiadmin.conf => nginx.conf} (80%) create mode 100644 conf/php-fpm.conf delete mode 100644 conf/phpfpm_wifiadmin.conf diff --git a/check_process b/check_process index e4d73ff..b4206d2 100644 --- a/check_process +++ b/check_process @@ -1,5 +1,4 @@ ;; Test complet - auto_remove=1 ; Manifest domain="domain.tld" (DOMAIN) path="/path" (PATH) @@ -11,18 +10,15 @@ setup_sub_dir=1 setup_root=1 setup_nourl=0 - setup_private=0 - setup_public=0 + setup_private=1 + setup_public=1 upgrade=1 + upgrade=1 from_commit=CommitHash backup_restore=1 multi_instance=0 - wrong_user=0 - wrong_path=1 incorrect_path=1 - corrupt_source=0 - fail_download_source=0 port_already_use=0 - final_path_already_use=0 + change_url=1 ;;; Levels Level 1=auto Level 2=auto @@ -33,4 +29,4 @@ Level 7=auto Level 8=0 Level 9=0 - Level 10=0 + Level 10=0 diff --git a/conf/nginx_wifiadmin.conf b/conf/nginx.conf similarity index 80% rename from conf/nginx_wifiadmin.conf rename to conf/nginx.conf index 72e1b62..afdf94f 100644 --- a/conf/nginx_wifiadmin.conf +++ b/conf/nginx.conf @@ -15,20 +15,28 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -location { - alias ; +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; +location __PATH__/ { + # Path to source + alias __FINALPATH__/ ; + + # Force usage of https if ($scheme = http) { rewrite ^ https://$server_name$request_uri? permanent; } + # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file client_max_body_size 10G; + index index.php; + try_files $uri $uri/ index.php; location ~ [^/]\.php(/|$) { fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm-.sock; + fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock; + fastcgi_index index.php; include fastcgi_params; fastcgi_read_timeout 600; @@ -37,5 +45,6 @@ location { fastcgi_param SCRIPT_FILENAME $request_filename; } + # Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; } diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf new file mode 100644 index 0000000..0c3da6c --- /dev/null +++ b/conf/php-fpm.conf @@ -0,0 +1,431 @@ +; 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_value[upload_max_filesize] = 10G +php_value[post_max_size] = 10G +; php_admin_flag[mail.add_x_header] = Off + +; Other common parameters +php_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 + diff --git a/conf/phpfpm_wifiadmin.conf b/conf/phpfpm_wifiadmin.conf deleted file mode 100644 index 7c85433..0000000 --- a/conf/phpfpm_wifiadmin.conf +++ /dev/null @@ -1,202 +0,0 @@ -; Wifi Hotspot app for YunoHost -; Copyright (C) 2015 Julien Vaubourg -; Contribute at https://github.com/labriqueinternet/hotspot_ynh -; -; This program is free software: you can redistribute it and/or modify -; it under the terms of the GNU Affero General Public License as published by -; the Free Software Foundation, either version 3 of the License, or -; (at your option) any later version. -; -; This program is distributed in the hope that it will be useful, -; but WITHOUT ANY WARRANTY; without even the implied warranty of -; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -; GNU Affero General Public License for more details. -; -; You should have received a copy of the GNU Affero General Public License -; along with this program. If not, see . - -; Start a new pool named ''. -; the variable $pool can we used in any directive and will be replaced by the -; pool name ('www' here) -[] - -; 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/php5-fpm-.sock - -; 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 = -group = - -; 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 - -; 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 = 600s - -; 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 log file for slow requests -; Default Value: not set -; Note: slowlog is mandatory if request_slowlog_timeout is set -slowlog = /var/log/nginx/.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 - -; Chdir to this directory at the start. -; Note: relative path can be used. -; Default Value: current directory or / when chroot -chdir = - -; 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 = no - -; 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) - -php_value[max_execution_time] = 600 -php_value[upload_max_filesize] = 10G -php_value[post_max_size] = 10G diff --git a/conf/ynh-hotspot b/conf/ynh-hotspot index f6c6283..06ca730 100644 --- a/conf/ynh-hotspot +++ b/conf/ynh-hotspot @@ -275,10 +275,10 @@ devfromid() { if [ "$1" != restart ]; then - # Restart php5-fpm at the first start (it needs to be restarted after the slapd start) + # Restart php7.0-fpm at the first start (it needs to be restarted after the slapd start) if [ ! -e /tmp/.ynh-hotspot-boot ]; then touch /tmp/.ynh-hotspot-boot - systemctl restart php5-fpm + systemctl restart php7.0-fpm fi # Variables diff --git a/manifest.json b/manifest.json index 3d84e2e..c22caff 100644 --- a/manifest.json +++ b/manifest.json @@ -15,12 +15,12 @@ "url": "http://julien.vaubourg.com" }, "requirements": { - "yunohost": ">= 2.2.0", - "moulinette": ">= 2.4.0" + "yunohost": ">= 3.4" }, "multi_instance": false, "services": [ - "php5-fpm" + "nginx", + "php7.0-fpm" ], "arguments": { "install" : [ diff --git a/scripts/install b/scripts/install index 197d14a..66a3662 100644 --- a/scripts/install +++ b/scripts/install @@ -45,7 +45,6 @@ wifi_passphrase=$YNH_APP_ARG_WIFI_PASSPHRASE firmware_nonfree=$YNH_APP_ARG_FIRMWARE_NONFREE app=$YNH_APP_INSTANCE_NAME -sysuser="${app}" # the service name must match the service template files service_name='ynh-hotspot' @@ -53,22 +52,61 @@ service_name='ynh-hotspot' #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= +ynh_print_info "Validating installation parameters..." # Check destination directory final_path="/var/www/$app" test ! -e "$final_path" || ynh_die "This path already contains a folder" # Normalize the url path syntax -path_url=$(ynh_normalize_url_path "$path_url") +path_url=$(ynh_normalize_url_path $path_url) -# Check web path availability -ynh_webpath_available "$domain" "$path_url" # Register (book) web path -ynh_webpath_register "$app" "$domain" "$path_url" +ynh_webpath_register $app $domain $path_url + +# Check arguments +if [[ -z $wifi_ssid || -z $wifi_passphrase ]]; then + ynh_die "Your Wifi Hotspot needs a name and a password" +fi + +# Check passphrase length +wifi_passphrase_length="$(echo -n "${wifi_passphrase}" | wc -c)" +if [[ $wifi_passphrase_length -lt 8 || $wifi_passphrase_length -gt 63 ]]; then + ynh_die "Your password must from 8 to 63 characters (WPA2 passphrase)" +fi + +# Check no special characters are present in the passphrase +if [[ $wifi_passphrase =~ [^[:print:]] ]]; then + ynh_die "Only printable ASCII characters are permitted in your password (WPA2 passphrase)" +fi + +#================================================= +# RUN PREREQUISITES +#================================================= + +source ./prerequisites + +if [[ ! -v ip6_net ]]; then # if ip6_net not set + ip6_net=none + ip6_addr=none + + if [[ -e /tmp/.ynh-vpnclient-started ]]; then + vpnclient_ip6_net=$(yunohost app setting vpnclient ip6_net 2>&1) + vpnclient_ip6_addr=$(yunohost app setting vpnclient ip6_addr 2>&1) + + if [[ $vpnclient_ip6_net =~ :: && $vpnclient_ip6_addr =~ :: ]]; then + ip6_net=${vpnclient_ip6_net} + ip6_addr=${vpnclient_ip6_addr} + fi + fi +fi + +wifi_device=$(sudo bash ../conf/iw_devices | awk -F\| '{ print $1 }') #================================================= # STORE SETTINGS FROM MANIFEST #================================================= +ynh_print_info "Storing installation settings..." ynh_app_setting_set "$app" domain "$domain" ynh_app_setting_set "$app" final_path "$final_path" @@ -76,8 +114,41 @@ ynh_app_setting_set "$app" wifi_ssid "$wifi_ssid" ynh_app_setting_set "$app" wifi_passphrase "$wifi_passphrase" ynh_app_setting_set "$app" firmware_nonfree "$firmware_nonfree" +ynh_app_setting_set $app multissid 1 +ynh_app_setting_set $app wifi_ssid "${wifi_ssid}" +ynh_app_setting_set $app wifi_secure 1 +ynh_app_setting_set $app wifi_passphrase "${wifi_passphrase}" +ynh_app_setting_set $app wifi_device "${wifi_device}" +ynh_app_setting_set $app wifi_channel 6 +ynh_app_setting_set $app ip6_addr "${ip6_addr}" +ynh_app_setting_set $app ip6_firewall 1 +ynh_app_setting_set $app ip6_net "${ip6_net}" +ynh_app_setting_set $app ip6_dns0 2001:913::8 +ynh_app_setting_set $app ip6_dns1 2001:910:800::12 +ynh_app_setting_set $app ip4_dns0 80.67.188.188 +ynh_app_setting_set $app ip4_dns1 80.67.169.12 +ynh_app_setting_set $app ip4_nat_prefix 10.0.242 +ynh_app_setting_set $app vpnclient no +ynh_app_setting_set $app service_name $service_name + +if [[ -z $wifi_device ]]; then + ynh_app_setting_set $app service_enabled 0 + wifi_device=none +else + ynh_app_setting_set $app service_enabled 1 +fi + #================================================= # STANDARD MODIFICATIONS +#================================================= +# FIND AND OPEN A PORT +#================================================= +ynh_print_info "Configuring firewall..." + +# Update firewall for DHCP +ynh_exec_warn_less yunohost firewall allow --no-upnp --ipv6 UDP 547 +ynh_exec_warn_less yunohost firewall allow --no-upnp UDP 67 + #================================================= # INSTALL NONFREE FIRWARE IF REQUESTED #================================================= @@ -109,101 +180,37 @@ ynh_package_update #================================================= # INSTALL DEPENDENCIES #================================================= +ynh_print_info "Installing dependencies..." ynh_install_app_dependencies "$pkg_dependencies" "$packages" #================================================= -# SPECIFIC SETUP -#================================================= -# RUN PREREQUISITES +# NGINX CONFIGURATION #================================================= +ynh_print_info "Configuring nginx web server..." -source ./prerequisites - -#================================================= -# CHECK PARAMETERS -#================================================= - -# Check arguments -if [[ -z $wifi_ssid || -z $wifi_passphrase ]]; then - ynh_die "Your Wifi Hotspot needs a name and a password" -fi - -# Check passphrase length -wifi_passphrase_length="$(echo -n "${wifi_passphrase}" | wc -c)" -if [[ $wifi_passphrase_length -lt 8 || $wifi_passphrase_length -gt 63 ]]; then - ynh_die "Your password must from 8 to 63 characters (WPA2 passphrase)" -fi - -# Check no special characters are present in the passphrase -if [[ $wifi_passphrase =~ [^[:print:]] ]]; then - ynh_die "Only printable ASCII characters are permitted in your password (WPA2 passphrase)" -fi - -#================================================= -# CHECK PARAMETERS -#================================================= - -if [[ ! -v ip6_net ]]; then # if ip6_net not set - ip6_net=none - ip6_addr=none - - if [[ -e /tmp/.ynh-vpnclient-started ]]; then - vpnclient_ip6_net=$(yunohost app setting vpnclient ip6_net 2>&1) - vpnclient_ip6_addr=$(yunohost app setting vpnclient ip6_addr 2>&1) - - if [[ $vpnclient_ip6_net =~ :: && $vpnclient_ip6_addr =~ :: ]]; then - ip6_net=${vpnclient_ip6_net} - ip6_addr=${vpnclient_ip6_addr} - fi - fi -fi - -wifi_device=$(sudo bash ../conf/iw_devices | awk -F\| '{ print $1 }') - -# Save arguments - -if [[ -z $wifi_device ]]; then - ynh_app_setting_set $app service_enabled 0 - wifi_device=none -else - ynh_app_setting_set $app service_enabled 1 -fi - -#================================================= -# SAVE SETTINGS -#================================================= - -ynh_app_setting_set $app multissid 1 -ynh_app_setting_set $app wifi_ssid "${wifi_ssid}" -ynh_app_setting_set $app wifi_secure 1 -ynh_app_setting_set $app wifi_passphrase "${wifi_passphrase}" -ynh_app_setting_set $app wifi_device "${wifi_device}" -ynh_app_setting_set $app wifi_channel 6 -ynh_app_setting_set $app ip6_addr "${ip6_addr}" -ynh_app_setting_set $app ip6_firewall 1 -ynh_app_setting_set $app ip6_net "${ip6_net}" -ynh_app_setting_set $app ip6_dns0 2001:913::8 -ynh_app_setting_set $app ip6_dns1 2001:910:800::12 -ynh_app_setting_set $app ip4_dns0 80.67.188.188 -ynh_app_setting_set $app ip4_dns1 80.67.169.12 -ynh_app_setting_set $app ip4_nat_prefix 10.0.242 -ynh_app_setting_set $app vpnclient no -ynh_app_setting_set $app service_name $service_name +# Create a dedicated nginx config +ynh_add_nginx_config #================================================= # CREATE DEDICATED USER #================================================= +ynh_print_info "Configuring system user..." -# Ensure the app has its own system user -if ! ynh_system_user_exists ${sysuser} -then - ynh_system_user_create ${sysuser} -fi +# Create a system user +ynh_system_user_create $app # Ensure the system user has enough sudo permissions install -b -o root -g root -m 0440 ../conf/sudoers.conf /etc/sudoers.d/${app}_ynh -ynh_replace_string "__HOTSPOT_SYSUSER__" "${sysuser}" /etc/sudoers.d/${app}_ynh +ynh_replace_string "__HOTSPOT_SYSUSER__" "${app}" /etc/sudoers.d/${app}_ynh + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= +ynh_print_info "Configuring php-fpm..." + +# Create a dedicated php-fpm config +ynh_add_fpm_config #================================================= # INSTALL CUSTOM SCRIPTS @@ -219,74 +226,57 @@ install -o root -g root -m 0755 ../conf/ipv6_compressed /usr/local/bin/ # COPY CONFIGS #================================================= -mkdir -pm 0755 /var/log/nginx/ mkdir -pm 0755 /etc/dnsmasq.dhcpd/ chown root: /etc/dnsmasq.dhcpd/ install -b -o root -g root -m 0644 ../conf/hostapd.conf.tpl? /etc/hostapd/ install -b -o root -g root -m 0644 ../conf/dnsmasq_dhcpdv6.conf.tpl /etc/dnsmasq.dhcpd/dhcpdv6.conf.tpl install -b -o root -g root -m 0644 ../conf/dnsmasq_dhcpdv4.conf.tpl /etc/dnsmasq.dhcpd/dhcpdv4.conf.tpl -install -b -o root -g root -m 0644 ../conf/nginx_wifiadmin.conf "/etc/nginx/conf.d/${domain}.d/wifiadmin.conf" -install -b -o root -g root -m 0644 ../conf/phpfpm_wifiadmin.conf /etc/php5/fpm/pool.d/wifiadmin.conf + +# Copy init script +install -o root -g root -m 0755 ../conf/$service_name /usr/local/bin/ #================================================= # COPY WEB SOURCES #================================================= -mkdir -pm 0755 /var/www/wifiadmin/ -cp -a ../sources/* /var/www/wifiadmin/ +mkdir -pm 0755 ${final_path}/ +cp -a ../sources/* ${final_path}/ -chown -R root: /var/www/wifiadmin/ -chmod -R 0644 /var/www/wifiadmin/* -find /var/www/wifiadmin/ -type d -exec chmod +x {} \; +chown -R root: ${final_path}/ +chmod -R 0644 ${final_path}/* +find ${final_path}/ -type d -exec chmod +x {} \; #================================================= # FIX CONFIGS #================================================= ## hostapd -sed 's|^DAEMON_CONF=$|&/etc/hostapd/hostapd.conf|' -i /etc/init.d/hostapd - -## nginx -sed "s||${path_url}|g" -i "/etc/nginx/conf.d/${domain}.d/wifiadmin.conf" -sed 's||/var/www/wifiadmin/|g' -i "/etc/nginx/conf.d/${domain}.d/wifiadmin.conf" -sed 's||wifiadmin|g' -i "/etc/nginx/conf.d/${domain}.d/wifiadmin.conf" - -## php-fpm -sed "s||wifiadmin|g" -i /etc/php5/fpm/pool.d/wifiadmin.conf -sed "s||${sysuser}|g" -i /etc/php5/fpm/pool.d/wifiadmin.conf -sed "s||${sysuser}|g" -i /etc/php5/fpm/pool.d/wifiadmin.conf -sed "s||/var/www/wifiadmin/|g" -i /etc/php5/fpm/pool.d/wifiadmin.conf +ynh_replace_string "^DAEMON_CONF=$" "&/etc/hostapd/hostapd.conf" /etc/init.d/hostapd # Fix sources -sed "s||${path_url}|g" -i /var/www/wifiadmin/config.php - -# Copy init script -install -o root -g root -m 0755 ../conf/$service_name /usr/local/bin/ +ynh_replace_string "__PATH__" "${path_url}" "$final_path/config.php" #================================================= # SETUP SYSTEMD #================================================= +ynh_print_info "Configuring a systemd service..." # Create a dedicated systemd config ynh_add_systemd_config $service_name -# Update firewall for DHCP -yunohost firewall allow --no-upnp --ipv6 UDP 547 -yunohost firewall allow --no-upnp UDP 67 - # Set default inits # The boot order of these services are important, so they are disabled by default # and the ynh-hotspot service handles them. systemctl disable hostapd systemctl stop hostapd -systemctl enable php5-fpm -systemctl restart php5-fpm #================================================= -# RELOAD NGINX +# RELOAD NGINX AND PHP-FPM #================================================= +ynh_print_info "Reloading nginx web server..." +systemctl reload php7.0-fpm systemctl reload nginx # Remove IPv6 address set if there is a VPN installed diff --git a/sources/config.php b/sources/config.php index 6546292..9858e14 100644 --- a/sources/config.php +++ b/sources/config.php @@ -22,11 +22,11 @@ function configure() { option('env', ENV_PRODUCTION); option('debug', false); - option('base_uri', '/'); + option('base_uri', '__PATH__/'); layout('layout.html.php'); - define('PUBLIC_DIR', '/public'); + define('PUBLIC_DIR', '__PATH__/public'); } // Before routing