From 0d4f8fd17b6ffd58c1edf86496346baf658db31b Mon Sep 17 00:00:00 2001 From: magikcypress Date: Wed, 11 Nov 2015 18:03:16 +0100 Subject: [PATCH] Grav for YunoHost --- README.md | 7 ++ conf/nginx.conf | 37 +++++++ conf/php-fpm.conf | 243 ++++++++++++++++++++++++++++++++++++++++++++++ manifest.json | 44 +++++++++ scripts/install | 53 ++++++++++ scripts/remove | 10 ++ scripts/upgrade | 31 ++++++ sources | 1 + 8 files changed, 426 insertions(+) create mode 100644 README.md create mode 100644 conf/nginx.conf create mode 100644 conf/php-fpm.conf create mode 100644 manifest.json create mode 100644 scripts/install create mode 100644 scripts/remove create mode 100644 scripts/upgrade create mode 160000 sources diff --git a/README.md b/README.md new file mode 100644 index 0000000..f74a5e6 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# GRAV_ynh + +## Grav for YunoHost + +### Configuration + +1. Start url https://domaine.tld/grav \ No newline at end of file diff --git a/conf/nginx.conf b/conf/nginx.conf new file mode 100644 index 0000000..3934e32 --- /dev/null +++ b/conf/nginx.conf @@ -0,0 +1,37 @@ +location PATHTOCHANGE { + index index.php; + + alias ALIASTOCHANGE; + + error_page 500 502 503 504 /50x.html; + location = PATHTOCHANGE/50x.html { + root html; + } + + location PATHTOCHANGE { + if (!-e $request_filename){ rewrite ^(.*)$ PATHTOCHANGE/$2 last; } + try_files $uri $uri/ /index.php?$args; + } + + location ~ \.php$ { + # Choose either a socket or TCP/IP address + fastcgi_pass unix:/var/run/php5-fpm.sock; + # fastcgi_pass 127.0.0.1:9000; + + fastcgi_split_path_info ^(.+\.php)(/.+)$; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param SCRIPT_FILENAME $request_filename; + } + + ## Begin - Security + # deny all direct access for these folders + location ~* /(.git|cache|bin|logs|backups)/.*$ { return 403; } + # deny running scripts inside core system folders + location ~* /(system|vendor)/.*\.(txt|xml|md|html|yaml|php|pl|py|cgi|twig|sh|bat)$ { return 403; } + # deny running scripts inside user folder + location ~* /user/.*\.(txt|md|yaml|php|pl|py|cgi|twig|sh|bat)$ { return 403; } + # deny access to specific files in the root folder + location ~ /(LICENSE|composer.lock|composer.json|nginx.conf|web.config|htaccess.txt|\.htaccess) { return 403; } + ## End - Security +} diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf new file mode 100644 index 0000000..affcbe5 --- /dev/null +++ b/conf/php-fpm.conf @@ -0,0 +1,243 @@ +; Start a new pool named 'www'. +; the variable $pool can we used in any directive and will be replaced by the +; pool name ('www' here) +[NAMETOCHANGE] + +; Per pool prefix +; It only applies on the following directives: +; - 'slowlog' +; - 'listen' (unixsocket) +; - 'chroot' +; - 'chdir' +; - 'php_values' +; - 'php_admin_values' +; When not set, the global prefix (or /usr) applies instead. +; Note: This directive can also be relative to the global prefix. +; Default Value: none +;prefix = /path/to/pools/$pool + +; The address on which to accept FastCGI requests. +; Valid syntaxes are: +; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific address on +; a specific port; +; 'port' - to listen on a TCP socket to all addresses on a +; specific port; +; '/path/to/unix/socket' - to listen on a unix socket. +; Note: This value is mandatory. +listen = /var/run/php5-fpm-NAMETOCHANGE.sock + +; Set listen(2) backlog. A value of '-1' means unlimited. +; Default Value: 128 (-1 on FreeBSD and OpenBSD) +;listen.backlog = -1 + +; List of ipv4 addresses of FastCGI clients which are allowed to connect. +; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original +; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address +; must be separated by a comma. If this value is left blank, connections will be +; accepted from any ip address. +; Default Value: any +;listen.allowed_clients = 127.0.0.1 + +; Set permissions for unix socket, if one is used. In Linux, read/write +; permissions must be set in order to allow connections from a web server. Many +; BSD-derived systems allow connections regardless of permissions. +; Default Values: user and group are set as the running user +; mode is set to 0666 +listen.owner = www-data +listen.group = www-data +listen.mode = 0600 + +; Unix user/group of processes +; Note: The user is mandatory. If the group is not set, the default user's group +; will be used. +user = www-data +group = www-data + +; Choose how the process manager will control the number of child processes. +; Possible Values: +; static - a fixed number (pm.max_children) of child processes; +; dynamic - the number of child processes are set dynamically based on the +; following directives: +; pm.max_children - the maximum number of children that can +; be alive at the same time. +; pm.start_servers - the number of children created on startup. +; pm.min_spare_servers - the minimum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is less than this +; number then some children will be created. +; pm.max_spare_servers - the maximum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is greater than this +; number then some children will be killed. +; Note: This value is mandatory. +pm = dynamic + +; The number of child processes to be created when pm is set to 'static' and the +; maximum number of child processes to be created when pm is set to 'dynamic'. +; This value sets the limit on the number of simultaneous requests that will be +; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. +; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP +; CGI. +; Note: Used when pm is set to either 'static' or 'dynamic' +; Note: This value is mandatory. +pm.max_children = 6 + +; The number of child processes created on startup. +; Note: Used only when pm is set to 'dynamic' +; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 +pm.start_servers = 3 + +; The desired minimum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +pm.min_spare_servers = 3 + +; The desired maximum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +pm.max_spare_servers = 5 + +; The number of requests each child process should execute before respawning. +; This can be useful to work around memory leaks in 3rd party libraries. For +; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. +; Default Value: 0 +pm.max_requests = 500 + +; The URI to view the FPM status page. If this value is not set, no URI will be +; recognized as a status page. By default, the status page shows the following +; information: +; accepted conn - the number of request accepted by the pool; +; pool - the name of the pool; +; process manager - static or dynamic; +; idle processes - the number of idle processes; +; active processes - the number of active processes; +; total processes - the number of idle + active processes. +; max children reached - number of times, the process limit has been reached, +; when pm tries to start more children (works only for +; pm 'dynamic') +; The values of 'idle processes', 'active processes' and 'total processes' are +; updated each second. The value of 'accepted conn' is updated in real time. +; Example output: +; accepted conn: 12073 +; pool: www +; process manager: static +; idle processes: 35 +; active processes: 65 +; total processes: 100 +; max children reached: 1 +; By default the status page output is formatted as text/plain. Passing either +; 'html' or 'json' as a query string will return the corresponding output +; syntax. Example: +; http://www.foo.bar/status +; http://www.foo.bar/status?json +; http://www.foo.bar/status?html +; Note: The value must start with a leading slash (/). The value can be +; anything, but it may not be a good idea to use the .php extension or it +; may conflict with a real PHP file. +; Default Value: not set +pm.status_path = /fpm-status + +; The ping URI to call the monitoring page of FPM. If this value is not set, no +; URI will be recognized as a ping page. This could be used to test from outside +; that FPM is alive and responding, or to +; - create a graph of FPM availability (rrd or such); +; - remove a server from a group if it is not responding (load balancing); +; - trigger alerts for the operating team (24/7). +; Note: The value must start with a leading slash (/). The value can be +; anything, but it may not be a good idea to use the .php extension or it +; may conflict with a real PHP file. +; Default Value: not set +ping.path = /ping + +; This directive may be used to customize the response of a ping request. The +; response is formatted as text/plain with a 200 response code. +; Default Value: pong +;ping.response = pong + +; The timeout for serving a single request after which the worker process will +; be killed. This option should be used when the 'max_execution_time' ini option +; does not stop script execution for some reason. A value of '0' means 'off'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +request_terminate_timeout = 120s + +; The timeout for serving a single request after which a PHP backtrace will be +; dumped to the 'slowlog' file. A value of '0s' means 'off'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +request_slowlog_timeout = 5s + +; The log file for slow requests +; Default Value: not set +; Note: slowlog is mandatory if request_slowlog_timeout is set +slowlog = /var/log/nginx/NAMETOCHANGE.slow.log + +; Set open file descriptor rlimit. +; Default Value: system defined value +rlimit_files = 4096 + +; Set max core size rlimit. +; Possible Values: 'unlimited' or an integer greater or equal to 0 +; Default Value: system defined value +rlimit_core = 0 + +; Chroot to this directory at the start. This value must be defined as an +; absolute path. When this value is not set, chroot is not used. +; Note: you can prefix with '$prefix' to chroot to the pool prefix or one +; of its subdirectories. If the pool prefix is not set, the global prefix +; will be used instead. +; Note: chrooting is a great security feature and should be used whenever +; possible. However, all PHP paths will be relative to the chroot +; (error_log, sessions.save_path, ...). +; Default Value: not set +;chroot = + +; Chdir to this directory at the start. +; Note: relative path can be used. +; Default Value: current directory or / when chroot +chdir = /var/www/NAMETOCHANGE + +; Redirect worker stdout and stderr into main error log. If not set, stdout and +; stderr will be redirected to /dev/null according to FastCGI specs. +; Note: on highloaded environement, this can cause some delay in the page +; process time (several ms). +; Default Value: no +catch_workers_output = yes + +; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from +; the current environment. +; Default Value: clean env +;env[HOSTNAME] = $HOSTNAME +;env[PATH] = /usr/local/bin:/usr/bin:/bin +;env[TMP] = /tmp +;env[TMPDIR] = /tmp +;env[TEMP] = /tmp + +; Additional php.ini defines, specific to this pool of workers. These settings +; overwrite the values previously defined in the php.ini. The directives are the +; same as the PHP SAPI: +; php_value/php_flag - you can set classic ini defines which can +; be overwritten from PHP call 'ini_set'. +; php_admin_value/php_admin_flag - these directives won't be overwritten by +; PHP call 'ini_set' +; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. + +; Defining 'extension' will load the corresponding shared extension from +; extension_dir. Defining 'disable_functions' or 'disable_classes' will not +; overwrite previously defined php.ini values, but will append the new value +; instead. + +; Note: path INI options can be relative and will be expanded with the prefix +; (pool, global or /usr) + +; Default Value: nothing is defined by default except the values in php.ini and +; specified at startup with the -d argument +;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com +;php_flag[display_errors] = off +;php_admin_value[error_log] = /var/log/fpm-php.www.log +;php_admin_flag[log_errors] = on +;php_admin_value[memory_limit] = 32M + +php_value[upload_max_filesize] = 10G +php_value[post_max_size] = 10G +php_value[mail.add_x_header] = Off \ No newline at end of file diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..2c504a5 --- /dev/null +++ b/manifest.json @@ -0,0 +1,44 @@ +{ + "name": "Grav", + "id": "grav", + "description": { + "en": "Grav - Grav is a modern open source flat-file CMS", + "fr": "Grav - Grav is a modern open source flat-file CMS" + }, + "license": "GPL-3", + "developer": { + "name": "cyp", + "email": "cyp@rouquin.me", + "url": "http://rouquin.me" + }, + "url": "http://www.getgrav.org/", + "multi_instance": "true", + "arguments": { + "install" : [ + { + "name": "domain", + "ask": { + "en": "Choose a domain for SPIP" + }, + "example": "domain.org" + }, + { + "name": "path", + "ask": { + "en": "Choose a path for Grav" + }, + "example": "/grav", + "default": "/grav" + }, + { + "name": "admin", + "type": "user", + "ask": { + "en": "Choose the Grav administrator (must be an existing YunoHost user)", + "fr": "Administrateur du site (doit être un utilisateur YunoHost existant)" + }, + "example": "homer" + } + ] + } +} \ No newline at end of file diff --git a/scripts/install b/scripts/install new file mode 100644 index 0000000..37c5813 --- /dev/null +++ b/scripts/install @@ -0,0 +1,53 @@ +#!/bin/bash + +# Retrieve arguments +domain=$1 +path=$2 +admin_grav=$3 + +# Check if admin exists +sudo yunohost user list --json | grep -q "\"username\": \"$admin_grav\"" +if [[ ! $? -eq 0 ]]; then + echo "Wrong admin" + exit 1 +fi +sudo yunohost app setting grav admin -v $admin_grav + +# Check domain/path availability +sudo yunohost app checkurl $domain$path -a grav +if [[ ! $? -eq 0 ]]; then + exit 1 +fi + +# Generate random DES key & password +db_pwd=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d '[A-Za-z0-9]' | sed -n 's/\(.\{24\}\).*/\1/p') + +# Use 'grav' as database name and user +db_user=grav + +# Copy files to the right place +final_path=/var/www/grav +sudo mkdir -p $final_path +sudo cp -a ../sources/* $final_path + +# Set permissions to roundcube directory +sudo chown -R www-data: $final_path + +# Modify Nginx configuration file and copy it to Nginx conf directory +sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf +sed -i "s@ALIASTOCHANGE@$final_path@g" ../conf/nginx.conf +sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/grav.conf + +sed -i "s@NAMETOCHANGE@grav@g" ../conf/php-fpm.conf +finalphpconf=/etc/php5/fpm/pool.d/grav.conf +sudo cp ../conf/php-fpm.conf $finalphpconf +sudo chown root: $finalphpconf +sudo chmod 644 $finalphpconf +sudo cd $final_path +sudo bin/grav install + +# Reload Nginx and regenerate SSOwat conf +sudo service php5-fpm restart +sudo service nginx reload +sudo yunohost app setting grav skipped_uris -v "/" +sudo yunohost app ssowatconf \ No newline at end of file diff --git a/scripts/remove b/scripts/remove new file mode 100644 index 0000000..77cd60d --- /dev/null +++ b/scripts/remove @@ -0,0 +1,10 @@ +#!/bin/bash + +domain=$(sudo yunohost app setting grav domain) + +sudo rm -rf /var/www/grav +sudo rm -f /etc/nginx/conf.d/$domain.d/grav.conf +sudo rm -f /etc/php5/fpm/pool.d/grav.conf + +sudo service php5-fpm restart +sudo service nginx reload \ No newline at end of file diff --git a/scripts/upgrade b/scripts/upgrade new file mode 100644 index 0000000..12534ed --- /dev/null +++ b/scripts/upgrade @@ -0,0 +1,31 @@ +#!/bin/bash + +# Retrieve arguments +domain=$(sudo yunohost app setting grav domain) +path=$(sudo yunohost app setting grav path) +admin_grav=$(sudo yunohost app setting grav admin) +language=$(sudo yunohost app setting grav language) +is_public=$(sudo yunohost app setting grav is_public) + +final_path=/var/www/grav + +# Check if admin is not null +if [[ "$admin_grav" = "" || "$is_public" = "" || "$language" = "" ]]; then + echo "Unable to upgrade, please contact support" + exit 1 +fi + + +# Modify Nginx configuration file and copy it to Nginx conf directory +sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf* +sed -i "s@ALIASTOCHANGE@$final_path/@g" ../conf/nginx.conf* + +if [ $is_public = "Yes" ]; +then + sudo cp ../conf/nginx.conf-public /etc/nginx/conf.d/$domain.d/grav.conf +else + sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/grav.conf +fi + +# Reload Nginx +sudo service nginx reload diff --git a/sources b/sources new file mode 160000 index 0000000..d3097e4 --- /dev/null +++ b/sources @@ -0,0 +1 @@ +Subproject commit d3097e4fd00cc4ea3b0a8a16ff529358cb30cdbd