YunoHost-Apps/ttrss_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ttrss_ynh.git synced 2024-10-01 13:34:46 +02:00
Code Issues Activity Actions

Update 17.4 & refactoring

Browse source
This commit is contained in:
Maniack Crudelis 2017-08-27 14:42:28 +02:00
parent 605cb92120
commit 481513180a
15 changed files with 1203 additions and 400 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
check_process
View file

@ -1,5 +1,4 @@
;; Nom du test ;; Nom du test
auto_remove=1
; Manifest ; Manifest
domain="domain.tld" (DOMAIN) domain="domain.tld" (DOMAIN)
path="/path" (PATH) path="/path" (PATH)
@ -13,22 +12,22 @@
upgrade=1 upgrade=1
backup_restore=1 backup_restore=1
multi_instance=1 multi_instance=1
wrong_user=1
wrong_path=1
incorrect_path=1 incorrect_path=1
corrupt_source=0
fail_download_source=0
port_already_use=0 port_already_use=0
final_path_already_use=0 change_url=0
;;; Levels ;;; Levels
Level 1=auto Level 1=auto
Level 2=auto Level 2=auto
Level 3=auto Level 3=auto
# ttrss semble prendre en charge ldap, mais je ne trouve pas sa prise en charge. # Plugin auth_remote
Level 4=0 Level 4=1
Level 5=auto # https://github.com/YunoHost-Apps/ttrss_ynh/issues/35
Level 5=1
Level 6=auto Level 6=auto
Level 7=auto Level 7=auto
Level 8=0 Level 8=0
Level 9=0 Level 9=0
Level 10=0 Level 10=0
;;; Options
Email=
Notification=none

6
conf/app.src Normal file
View file

@ -0,0 +1,6 @@
SOURCE_URL=https://git.tt-rss.org/git/tt-rss/archive/17.4.tar.gz
SOURCE_SUM=6800f75a59877fab3833eb8c8cd354add89410d8564f98752c499cb72cf24a6e
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_FILENAME=

336
conf/config.php
View file

@ -1,207 +1,207 @@
<?php <?php
// ******************************************* // *******************************************
// *** Database configuration (important!) *** // *** Database configuration (important!) ***
// ******************************************* // *******************************************
define('DB_TYPE', "mysql"); // or mysql define('DB_TYPE', "mysql"); // or mysql
define('DB_HOST', "localhost"); define('DB_HOST', "localhost");
define('DB_USER', "yunouser"); define('DB_USER', "__DBNAME__");
define('DB_NAME', "yunobase"); define('DB_NAME', "__DBNAME__");
define('DB_PASS', "yunopass"); define('DB_PASS', "__DBPWD__");
//define('DB_PORT', '5432'); // when neeeded, PG-only define('DB_PORT', ''); // usually 5432 for PostgreSQL, 3306 for MySQL
define('MYSQL_CHARSET', 'UTF8'); define('MYSQL_CHARSET', 'UTF8');
// Connection charset for MySQL. If you have a legacy database and/or experience // Connection charset for MySQL. If you have a legacy database and/or experience
// garbage unicode characters with this option, try setting it to a blank string. // garbage unicode characters with this option, try setting it to a blank string.
// *********************************** // ***********************************
// *** Basic settings (important!) *** // *** Basic settings (important!) ***
// *********************************** // ***********************************
define('SELF_URL_PATH', 'yunopath'); define('SELF_URL_PATH', '__DOMAINPATH__');
// Full URL of your tt-rss installation. This should be set to the // Full URL of your tt-rss installation. This should be set to the
// location of tt-rss directory, e.g. http://example.org/tt-rss/ // location of tt-rss directory, e.g. http://example.org/tt-rss/
// You need to set this option correctly otherwise several features // You need to set this option correctly otherwise several features
// including PUSH, bookmarklets and browser integration will not work properly. // including PUSH, bookmarklets and browser integration will not work properly.
define('FEED_CRYPT_KEY', ''); define('FEED_CRYPT_KEY', '');
// WARNING: mcrypt is deprecated in php 7.1. This directive exists for backwards // WARNING: mcrypt is deprecated in php 7.1. This directive exists for backwards
// compatibility with existing installs, new passwords are NOT going to be encrypted. // compatibility with existing installs, new passwords are NOT going to be encrypted.
// Use update.php --decrypt-feeds to decrypt existing passwords in the database while // Use update.php --decrypt-feeds to decrypt existing passwords in the database while
// mcrypt is still available. // mcrypt is still available.
// Key used for encryption of passwords for password-protected feeds // Key used for encryption of passwords for password-protected feeds
// in the database. A string of 24 random characters. If left blank, encryption // in the database. A string of 24 random characters. If left blank, encryption
// is not used. Requires mcrypt functions. // is not used. Requires mcrypt functions.
// Warning: changing this key will make your stored feed passwords impossible // Warning: changing this key will make your stored feed passwords impossible
// to decrypt. // to decrypt.
define('SINGLE_USER_MODE', false);
// Operate in single user mode, disables all functionality related to
// multiple users and authentication. Enabling this assumes you have
// your tt-rss directory protected by other means (e.g. http auth).
define('SINGLE_USER_MODE', false); define('SIMPLE_UPDATE_MODE', false);
// Operate in single user mode, disables all functionality related to // Enables fallback update mode where tt-rss tries to update feeds in
// multiple users and authentication. Enabling this assumes you have // background while tt-rss is open in your browser.
// your tt-rss directory protected by other means (e.g. http auth). // If you don't have a lot of feeds and don't want to or can't run
// background processes while not running tt-rss, this method is generally
// viable to keep your feeds up to date.
// Still, there are more robust (and recommended) updating methods
// available, you can read about them here: http://tt-rss.org/wiki/UpdatingFeeds
define('SIMPLE_UPDATE_MODE', false); // *****************************
// Enables fallback update mode where tt-rss tries to update feeds in // *** Files and directories ***
// background while tt-rss is open in your browser. // *****************************
// If you don't have a lot of feeds and don't want to or can't run
// background processes while not running tt-rss, this method is generally
// viable to keep your feeds up to date.
// Still, there are more robust (and recommended) updating methods
// available, you can read about them here: http://tt-rss.org/wiki/UpdatingFeeds
// ***************************** define('PHP_EXECUTABLE', '/usr/bin/php');
// *** Files and directories *** // Path to PHP *COMMAND LINE* executable, used for various command-line tt-rss
// ***************************** // programs and update daemon. Do not try to use CGI binary here, it won't work.
// If you see HTTP headers being displayed while running tt-rss scripts,
// then most probably you are using the CGI binary. If you are unsure what to
// put in here, ask your hosting provider.
define('PHP_EXECUTABLE', '/usr/bin/php'); define('LOCK_DIRECTORY', 'lock');
// Path to PHP *COMMAND LINE* executable, used for various command-line tt-rss // Directory for lockfiles, must be writable to the user you run
// programs and update daemon. Do not try to use CGI binary here, it won't work. // daemon process or cronjobs under.
// If you see HTTP headers being displayed while running tt-rss scripts,
// then most probably you are using the CGI binary. If you are unsure what to
// put in here, ask your hosting provider.
define('LOCK_DIRECTORY', 'lock'); define('CACHE_DIR', 'cache');
// Directory for lockfiles, must be writable to the user you run // Local cache directory for RSS feed content.
// daemon process or cronjobs under.
define('CACHE_DIR', 'cache'); define('ICONS_DIR', "feed-icons");
// Local cache directory for RSS feed content. define('ICONS_URL', "feed-icons");
// Local and URL path to the directory, where feed favicons are stored.
// Unless you really know what you're doing, please keep those relative
// to tt-rss main directory.
define('ICONS_DIR', "feed-icons"); // **********************
define('ICONS_URL', "feed-icons"); // *** Authentication ***
// Local and URL path to the directory, where feed favicons are stored. // **********************
// Unless you really know what you're doing, please keep those relative
// to tt-rss main directory.
// ********************** // Please see PLUGINS below to configure various authentication modules.
// *** Authentication ***
// **********************
// Please see PLUGINS below to configure various authentication modules. define('AUTH_AUTO_CREATE', true);
// Allow authentication modules to auto-create users in tt-rss internal
// database when authenticated successfully.
define('AUTH_AUTO_CREATE', true); define('AUTH_AUTO_LOGIN', true);
// Allow authentication modules to auto-create users in tt-rss internal // Automatically login user on remote or other kind of externally supplied
// database when authenticated successfully. // authentication, otherwise redirect to login form as normal.
// If set to true, users won't be able to set application language
// and settings profile.
define('AUTH_AUTO_LOGIN', true); // *********************
// Automatically login user on remote or other kind of externally supplied // *** Feed settings ***
// authentication, otherwise redirect to login form as normal. // *********************
// If set to true, users won't be able to set application language
// and settings profile.
// ********************* define('FORCE_ARTICLE_PURGE', 0);
// *** Feed settings *** // When this option is not 0, users ability to control feed purging
// ********************* // intervals is disabled and all articles (which are not starred)
// older than this amount of days are purged.
define('FORCE_ARTICLE_PURGE', 0); // *** PubSubHubbub settings ***
// When this option is not 0, users ability to control feed purging
// intervals is disabled and all articles (which are not starred)
// older than this amount of days are purged.
// *** PubSubHubbub settings *** define('PUBSUBHUBBUB_HUB', '');
// URL to a PubSubHubbub-compatible hub server. If defined, "Published
// articles" generated feed would automatically become PUSH-enabled.
define('PUBSUBHUBBUB_HUB', ''); define('PUBSUBHUBBUB_ENABLED', false);
// URL to a PubSubHubbub-compatible hub server. If defined, "Published // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
// articles" generated feed would automatically become PUSH-enabled. // won't try to subscribe to PUSH feed updates.
define('PUBSUBHUBBUB_ENABLED', false); // ****************************
// Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss // *** Sphinx search plugin ***
// won't try to subscribe to PUSH feed updates. // ****************************
// **************************** define('SPHINX_SERVER', 'localhost:9312');
// *** Sphinx search plugin *** // Hostname:port combination for the Sphinx server.
// ****************************
define('SPHINX_SERVER', 'localhost:9312'); define('SPHINX_INDEX', 'ttrss, delta');
// Hostname:port combination for the Sphinx server. // Index name in Sphinx configuration. You can specify multiple indexes
// as a comma-separated string.
// Example configuration files are available on tt-rss wiki.
define('SPHINX_INDEX', 'ttrss, delta'); // ***********************************
// Index name in Sphinx configuration. You can specify multiple indexes // *** Self-registrations by users ***
// as a comma-separated string. // ***********************************
// Example configuration files are available on tt-rss wiki.
// *********************************** define('ENABLE_REGISTRATION', false);
// *** Self-registrations by users *** // Allow users to register themselves. Please be aware that allowing
// *********************************** // random people to access your tt-rss installation is a security risk
// and potentially might lead to data loss or server exploit. Disabled
// by default.
define('ENABLE_REGISTRATION', false); define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
// Allow users to register themselves. Please be aware that allowing // Email address to send new user notifications to.
// random people to access your tt-rss installation is a security risk
// and potentially might lead to data loss or server exploit. Disabled
// by default.
define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom'); define('REG_MAX_USERS', 10);
// Email address to send new user notifications to. // Maximum amount of users which will be allowed to register on this
// system. 0 - no limit.
define('REG_MAX_USERS', 10); // **********************************
// Maximum amount of users which will be allowed to register on this // *** Cookies and login sessions ***
// system. 0 - no limit. // **********************************
define('SESSION_COOKIE_LIFETIME', 86400);
// Default lifetime of a session (e.g. login) cookie. In seconds,
// 0 means cookie will be deleted when browser closes.
// ********************************** // *********************************
// *** Cookies and login sessions *** // *** Email and digest settings ***
// ********************************** // *********************************
define('SESSION_COOKIE_LIFETIME', 86400); define('SMTP_FROM_NAME', 'Tiny Tiny RSS');
// Default lifetime of a session (e.g. login) cookie. In seconds, define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom');
// 0 means cookie will be deleted when browser closes. // Name, address and subject for sending outgoing mail. This applies
// to password reset notifications, digest emails and any other mail.
// ********************************* define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
// *** Email and digest settings *** // Subject line for email digests
// *********************************
define('SMTP_FROM_NAME', 'Tiny Tiny RSS'); define('SMTP_SERVER', '');
define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom'); // Hostname:port combination to send outgoing mail (i.e. localhost:25).
// Name, address and subject for sending outgoing mail. This applies // Blank - use system MTA.
// to password reset notifications, digest emails and any other mail.
define('SMTP_LOGIN', '');
define('SMTP_PASSWORD', '');
// These two options enable SMTP authentication when sending
// outgoing mail. Only used with SMTP_SERVER.
define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours'); define('SMTP_SECURE', '');
// Subject line for email digests // Used to select a secure SMTP connection. Allowed values: ssl, tls,
// or empty.
// ***************************************
// *** Other settings (less important) ***
// ***************************************
define('SMTP_SERVER', ''); define('CHECK_FOR_UPDATES', true);
// Hostname:port combination to send outgoing mail (i.e. localhost:25). // Check for updates automatically if running Git version
// Blank - use system MTA.
define('ENABLE_GZIP_OUTPUT', false);
// Selectively gzip output to improve wire performance. This requires
// PHP Zlib extension on the server.
// Enabling this can break tt-rss in several httpd/php configurations,
// if you experience weird errors and tt-rss failing to start, blank pages
// after login, or content encoding errors, disable it.
define('SMTP_LOGIN', ''); define('PLUGINS', 'auth_remote, auth_internal, note');
define('SMTP_PASSWORD', ''); // Comma-separated list of plugins to load automatically for all users.
// These two options enable SMTP authentication when sending // System plugins have to be specified here. Please enable at least one
// outgoing mail. Only used with SMTP_SERVER. // authentication plugin here (auth_*).
// Users may enable other user plugins from Preferences/Plugins but may not
// disable plugins specified in this list.
// Disabling auth_internal in this list would automatically disable
// reset password link on the login form.
define('LOG_DESTINATION', 'sql');
// Log destination to use. Possible values: sql (uses internal logging
// you can read in Preferences -> System), syslog - logs to system log.
// Setting this to blank uses PHP logging (usually to http server
// error.log).
define('SMTP_SECURE', ''); define('CONFIG_VERSION', 26);
// Used to select a secure SMTP connection. Allowed values: ssl, tls, // Expected config version. Please update this option in config.php
// or empty. // if necessary (after migrating all new options from this file).
// *************************************** // vim:ft=php
// *** Other settings (less important) ***
// ***************************************
define('CHECK_FOR_UPDATES', true);
// Check for updates automatically if running Git version
define('ENABLE_GZIP_OUTPUT', false);
// Selectively gzip output to improve wire performance. This requires
// PHP Zlib extension on the server.
// Enabling this can break tt-rss in several httpd/php configurations,
// if you experience weird errors and tt-rss failing to start, blank pages
// after login, or content encoding errors, disable it.
define('PLUGINS', 'auth_remote, auth_internal, note');
// Comma-separated list of plugins to load automatically for all users.
// System plugins have to be specified here. Please enable at least one
// authentication plugin here (auth_*).
// Users may enable other user plugins from Preferences/Plugins but may not
// disable plugins specified in this list.
// Disabling auth_internal in this list would automatically disable
// reset password link on the login form.
define('LOG_DESTINATION', 'sql');
// Log destination to use. Possible values: sql (uses internal logging
// you can read in Preferences -> System), syslog - logs to system log.
// Setting this to blank uses PHP logging (usually to http server
// error.log).
define('CONFIG_VERSION', 26);
// Expected config version. Please update this option in config.php
// if necessary (after migrating all new options from this file).
// vim:ft=php

6
conf/nginx.conf
View file

@ -1,5 +1,5 @@
location PATHTOCHANGE { location __PATH__ {
alias ALIASTOCHANGE ; alias __FINALPATH__/ ;
if ($scheme = http) { if ($scheme = http) {
rewrite ^ https://$server_name$request_uri? permanent; rewrite ^ https://$server_name$request_uri? permanent;
} }
@ -7,7 +7,7 @@ location PATHTOCHANGE {
try_files $uri $uri/ index.php; try_files $uri $uri/ index.php;
location ~ [^/]\.php(/|$) { location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$; fastcgi_split_path_info ^(.+?\.php)(/.*)$;
fastcgi_pass unix:/var/run/php5-fpm.sock; fastcgi_pass unix:/var/run/php5-fpm-__NAME__.sock;
fastcgi_index index.php; fastcgi_index index.php;
include fastcgi_params; include fastcgi_params;
fastcgi_param REMOTE_USER $remote_user; fastcgi_param REMOTE_USER $remote_user;

392
conf/php-fpm.conf Normal file
View file

@ -0,0 +1,392 @@
; 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
; 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 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 = 128
; 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
; 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
; 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
; priority = -19
; 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 = 10
; 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: ${prefix}/share/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: ouput 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)
; %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)
; %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 = /var/log/nginx/__NAMETOCHANGE__.slow.log
; 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 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
; 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
; exectute php code.
; Note: set an empty value to allow all extensions.
; Default Value: .php
;security.limit_extensions = .php .php3 .php4 .php5
; 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

10
conf/php-fpm.ini Normal file
View file

@ -0,0 +1,10 @@
# Common values to change to increase file upload limit
; upload_max_filesize = 50M
; post_max_size = 50M
; mail.add_x_header = Off
# Other common parameters
; max_execution_time = 600
; max_input_time = 300
; memory_limit = 256M
; short_open_tag = On

11
manifest.json
View file

@ -2,20 +2,21 @@
"name": "Tiny Tiny RSS", "name": "Tiny Tiny RSS",
"id": "ttrss", "id": "ttrss",
"packaging_format": 1, "packaging_format": 1,
"requirements": {
"yunohost": ">> 2.3.12.1"
},
"description": { "description": {
"en": "A PHP and Ajax feed reader", "en": "A PHP and Ajax feed reader",
"fr": "Un lecteur de flux en PHP et Ajax" "fr": "Un lecteur de flux en PHP et Ajax"
}, },
"url": "http://tt-rss.org", "url": "http://tt-rss.org",
"version": "17.1", "license": "GPL-3",
"version": "17.4",
"maintainer": { "maintainer": {
"name": "titoko", "name": "titoko",
"email": "titoko@titoko.fr" "email": "titoko@titoko.fr"
}, },
"multi_instance": "true", "requirements": {
"yunohost": ">= 2.6.4"
},
"multi_instance": true,
"services": [ "services": [
"nginx", "nginx",
"php5-fpm", "php5-fpm",

166
scripts/_common.sh
View file

@ -1,32 +1,144 @@
# =============================================================================
# YUNOHOST 2.7 FORTHCOMING HELPERS
# =============================================================================
# Create a dedicated nginx config
# #
# Common variables # This will use a template in ../conf/nginx.conf
# __PATH__ by $path_url
# __DOMAIN__ by $domain
# __PORT__ by $port
# __NAME__ by $app
# __FINALPATH__ by $final_path
# #
# usage: ynh_add_nginx_config
ynh_add_nginx_config () {
finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf"
ynh_backup_if_checksum_is_different "$finalnginxconf"
sudo cp ../conf/nginx.conf "$finalnginxconf"
APPNAME="ttrss" # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
# Substitute in a nginx config file only if the variable is not empty
if test -n "${path_url:-}"; then
ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf"
fi
if test -n "${domain:-}"; then
ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf"
fi
if test -n "${port:-}"; then
ynh_replace_string "__PORT__" "$port" "$finalnginxconf"
fi
if test -n "${app:-}"; then
ynh_replace_string "__NAME__" "$app" "$finalnginxconf"
fi
if test -n "${final_path:-}"; then
ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf"
fi
ynh_store_file_checksum "$finalnginxconf"
# ttrss version, use latest commit found here: https://tt-rss.org/fox/tt-rss/commits/master sudo systemctl reload nginx
VERSION="09628e1b1a" }
# Remote URL to fetch ttrss tarball # Remove the dedicated nginx config
TTRSS_BINARY_URL="https://git.tt-rss.org/git/tt-rss/archive/${VERSION}.zip" #
# usage: ynh_remove_nginx_config
# ynh_remove_nginx_config () {
# Common helpers ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf"
# sudo systemctl reload nginx
}
# Download and extract ttrss binary to the given directory
# usage: extract_ttrss DESTDIR # Create a dedicated php-fpm config
extract_ttrss() { #
local DESTDIR=$1 # usage: ynh_add_fpm_config
local TMPDIR=$(mktemp -d) ynh_add_fpm_config () {
finalphpconf="/etc/php5/fpm/pool.d/$app.conf"
# retrieve and extract ttrss tarball ynh_backup_if_checksum_is_different "$finalphpconf"
ttrss_tarball="/tmp/ttrss.zip" sudo cp ../conf/php-fpm.conf "$finalphpconf"
rm -f "$ttrss_tarball" ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf"
wget -q -O "$ttrss_tarball" "$TTRSS_BINARY_URL" \ ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf"
|| ynh_die "Unable to download ttrss tarball" ynh_replace_string "__USER__" "$app" "$finalphpconf"
unzip -q "$ttrss_tarball" -d "$TMPDIR" \ sudo chown root: "$finalphpconf"
|| ynh_die "Unable to extract ttrss tarball" ynh_store_file_checksum "$finalphpconf"
sudo rsync -a "$TMPDIR"/tt-rss*/* "$DESTDIR"
rm -rf "$ttrss_tarball" "$TMPDIR" if [ -e "../conf/php-fpm.ini" ]
then
finalphpini="/etc/php5/fpm/conf.d/20-$app.ini"
ynh_backup_if_checksum_is_different "$finalphpini"
sudo cp ../conf/php-fpm.ini "$finalphpini"
sudo chown root: "$finalphpini"
ynh_store_file_checksum "$finalphpini"
fi
sudo systemctl reload php5-fpm
}
# Remove the dedicated php-fpm config
#
# usage: ynh_remove_fpm_config
ynh_remove_fpm_config () {
ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf"
ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" 2>&1
sudo systemctl reload php5-fpm
}
# Restore a previous backup if the upgrade process failed
#
# usage:
# ynh_backup_before_upgrade
# ynh_clean_setup () {
# ynh_restore_upgradebackup
# }
# ynh_abort_if_errors
#
ynh_restore_upgradebackup () {
echo "Upgrade failed." >&2
app_bck=${app//_/-} # Replace all '_' by '-'
# Check if an existing backup can be found before removing and restoring the application.
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number
then
# Remove the application then restore it
sudo yunohost app remove $app
# Restore the backup
sudo yunohost backup restore --ignore-system $app_bck-pre-upgrade$backup_number --apps $app --force
ynh_die "The app was restored to the way it was before the failed upgrade."
fi
}
# Make a backup in case of failed upgrade
#
# usage:
# ynh_backup_before_upgrade
# ynh_clean_setup () {
# ynh_restore_upgradebackup
# }
# ynh_abort_if_errors
#
ynh_backup_before_upgrade () {
backup_number=1
old_backup_number=2
app_bck=${app//_/-} # Replace all '_' by '-'
# Check if a backup already exists with the prefix 1
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1
then
# Prefix becomes 2 to preserve the previous backup
backup_number=2
old_backup_number=1
fi
# Create backup
sudo yunohost backup create --ignore-system --apps $app --name $app_bck-pre-upgrade$backup_number
if [ "$?" -eq 0 ]
then
# If the backup succeeded, remove the previous backup
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number
then
# Remove the previous backup only if it exists
sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number > /dev/null
fi
else
ynh_die "Backup failed, the upgrade process was aborted."
fi
} }

84
scripts/backup
View file

@ -1,35 +1,67 @@
#!/bin/bash #!/bin/bash
# causes the shell to exit if any subcommand or pipeline returns a non-zero status #=================================================
set -e # GENERIC START
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
# Source YNH helpers # Exit on command errors and treat access to unset variables as an error
. /usr/share/yunohost/helpers set -eu
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
if [ ! -e _common.sh ]; then
# Get the _common.sh file if it's not in the current directory
cp ../settings/scripts/_common.sh ./_common.sh
chmod a+rx _common.sh
fi
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
# This is a multi-instance app, meaning it can be installed several times independently
# The id of the app as stated in the manifest is available as $YNH_APP_ID
# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
# The app instance name is available as $YNH_APP_INSTANCE_NAME
# - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
# - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
# - ynhexample__{N} for the subsequent installations, with N=3,4, ...
# The app instance name is probably what you are interested the most, since this is
# guaranteed to be unique. This is a good unique identifier to define installation path,
# db names, ...
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
domain=$(sudo yunohost app setting $app domain) final_path=$(ynh_app_setting_get $app final_path)
path=$(sudo yunohost app setting $app path) domain=$(ynh_app_setting_get $app domain)
db_name=$(ynh_app_setting_get $app db_name)
# Copy the app files #=================================================
final_path="/var/www/$app" # STANDARD BACKUP STEPS
ynh_backup "$final_path" "./www" #=================================================
# BACKUP THE APP MAIN DIR
#=================================================
# Copy the conf files ynh_backup "$final_path" "${YNH_APP_BACKUP_DIR}$final_path"
sudo mkdir -p ./conf
ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "./conf/nginx.conf"
ynh_backup "/etc/cron.d/$app" "./conf/cron"
# Backup db #=================================================
root_pwd=$(sudo cat /etc/yunohost/mysql) # BACKUP THE NGINX CONFIGURATION
sudo su -c "mysqldump -u root -p$root_pwd --no-create-db $app > ./db.sql" #=================================================
ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "${YNH_APP_BACKUP_DIR}/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# BACKUP THE PHP-FPM CONFIGURATION
#=================================================
ynh_backup "/etc/php5/fpm/pool.d/$app.conf" "${YNH_APP_BACKUP_DIR}/etc/php5/fpm/pool.d/$app.conf"
ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini" "${YNH_APP_BACKUP_DIR}/etc/php5/fpm/conf.d/20-$app.ini"
#=================================================
# BACKUP THE MYSQL DATABASE
#=================================================
ynh_mysql_dump_db "$db_name" > db.sql
#=================================================
# SPECIFIC BACKUP
#=================================================
# BACKUP THE CRON FILE
#=================================================
ynh_backup "/etc/cron.d/$app" "${YNH_APP_BACKUP_DIR}/etc/cron.d/$app"

192
scripts/install
View file

@ -1,85 +1,147 @@
#!/bin/bash #!/bin/bash
# causes the shell to exit if any subcommand or pipeline returns a non-zero status #=================================================
set -e # GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Load common variables source _common.sh
source ./_common.sh
# Source app helpers
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
# Retrieve arguments #=================================================
domain=$1 # MANAGE SCRIPT FAILURE
path=$2 #=================================================
app=${!#}
# Check domain/path availability # Exit if an error occurs during the execution of the script
sudo yunohost app checkurl $domain$path -a $app ynh_abort_if_errors
if [[ ! $? -eq 0 ]]; then
exit 1
fi
# Generate random DES key & password #=================================================
deskey=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d 'A-Za-z0-9' | sed -n 's/\(.\{24\}\).*/\1/p') # RETRIEVE ARGUMENTS FROM THE MANIFEST
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') #=================================================
domain=$YNH_APP_ARG_DOMAIN
path_url=$YNH_APP_ARG_PATH
app=$YNH_APP_INSTANCE_NAME
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
# Copy files to the right place
final_path=/var/www/$app final_path=/var/www/$app
sudo mkdir -p $final_path test ! -e "$final_path" || ynh_die "This path already contains a folder"
extract_ttrss $final_path
sudo cp ../conf/config.php $final_path/
sudo cp ../conf/*.patch /tmp/
sudo patch -d $final_path -p0 < /tmp/update.patch
sudo patch -d $final_path/plugins/auth_remote/ -p0 < /tmp/init.patch
# Use 'ttrss' as database name and user # Normalize the url path syntax
db_user=$app path_url=$(ynh_normalize_url_path $path_url)
# Initialize database and store mysql password for upgrade # Check web path availability
sudo yunohost app initdb $db_user -p $db_pwd -s $(readlink -e $final_path/schema/ttrss_schema_mysql.sql) ynh_webpath_available $domain $path_url
sudo yunohost app setting $app mysqlpwd -v $db_pwd # Register (book) web path
ynh_webpath_register $app $domain $path_url
#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
ynh_app_setting_set $app domain $domain
ynh_app_setting_set $app path $path_url
#=================================================
# STANDARD MODIFICATIONS
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_install_app_dependencies php5-cli
#=================================================
# CREATE A MYSQL DATABASE
#=================================================
db_name=$(ynh_sanitize_dbid $app)
ynh_app_setting_set $app db_name $db_name
ynh_mysql_setup_db $db_name $db_name
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_app_setting_set $app final_path $final_path
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source "$final_path"
#=================================================
# NGINX CONFIGURATION
#=================================================
# Create a dedicated nginx config
ynh_add_nginx_config
#=================================================
# CREATE DEDICATED USER
#=================================================
# Create a system user
ynh_system_user_create $app
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
# Create a dedicated php-fpm config
ynh_add_fpm_config
#=================================================
# SPECIFIC SETUP
#=================================================
# CONFIGURE TTRSS
#=================================================
cp ../conf/config.php "$final_path/config.php"
# Change variables in ttrss configuration # Change variables in ttrss configuration
sudo sed -i "s/yunouser/$db_user/g" $final_path/config.php ynh_replace_string "__DBNAME__" "$db_name" "$final_path/config.php"
sudo sed -i "s/yunopass/$db_pwd/g" $final_path/config.php ynh_replace_string "__DBPWD__" "$db_pwd" "$final_path/config.php"
sudo sed -i "s/yunobase/$db_user/g" $final_path/config.php ynh_replace_string "__DOMAINPATH__" "https://$domain$path_url" "$final_path/config.php"
sudo sed -i "s,yunopath,https://$domain$path,g" $final_path/config.php
echo "*/30 * * * * www-data cd $final_path && /usr/bin/php $final_path/update.php --feeds >/dev/null 2>&1" > /tmp/cronttrss
sudo mv /tmp/cronttrss /etc/cron.d/$app
sudo chown root /etc/cron.d/$app
sudo apt-get install php5-cli -y
#add folder # Recalculate and store the config file checksum into the app settings
for i in export images upload js ynh_store_file_checksum "$final_path/config.php"
do
if [ ! -d $final_path/cache/$i ];
then
sudo mkdir $final_path/cache/$i
fi
sudo chmod -R 777 $final_path/cache/$i
done
for i in feed-icons lock #=================================================
do # ADD A CRON FILE
if [ ! -d $final_path/$i ]; #=================================================
then
sudo mkdir $final_path/$i
fi
sudo chmod -R 777 $final_path/$i
done
# Set permissions to ttrss directory echo "*/30 * * * * $app cd $final_path && /usr/bin/php $final_path/update.php --feeds >/dev/null 2>&1" \
sudo chown -R www-data: $final_path > /etc/cron.d/$app
# Modify Nginx configuration file and copy it to Nginx conf directory #=================================================
sudo sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf # SECURE FILES AND DIRECTORIES
sudo sed -i "s@ALIASTOCHANGE@$final_path/@g" ../conf/nginx.conf #=================================================
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
# Reload Nginx and regenerate SSOwat conf # Set permissions to app files
sudo service nginx reload chown -R root: $final_path
chown -R $app $final_path/{cache,feed-icons,lock}
# Update database schema #=================================================
sudo sudo -u www-data php ${final_path}/update.php --update-schema # INITIALIZE DATABASE
#=================================================
sudo yunohost app setting $app skipped_uris -v "/public.php,/api" ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" \
< "$final_path/schema/ttrss_schema_mysql.sql"
sudo -u $app php ${final_path}/update.php --update-schema
#=================================================
# GENERIC FINALIZATION
#=================================================
# SETUP SSOWAT
#=================================================
ynh_app_setting_set $app skipped_uris "/public.php,/api"
#=================================================
# RELOAD NGINX
#=================================================
systemctl reload nginx

80
scripts/remove
View file

@ -1,15 +1,75 @@
#!/bin/bash #!/bin/bash
app=${!#} #=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
db_user=$app source _common.sh
db_name=$app source /usr/share/yunohost/helpers
root_pwd=$(sudo cat /etc/yunohost/mysql)
domain=$(sudo yunohost app setting $app domain)
mysql -u root -p$root_pwd -e "DROP DATABASE $db_name ; DROP USER $db_user@localhost ;" #=================================================
sudo rm -rf /var/www/$app # LOAD SETTINGS
sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf #=================================================
sudo rm -f /etc/cron.d/$app
sudo service nginx reload app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get $app domain)
db_name=$(ynh_app_setting_get $app db_name)
final_path=$(ynh_app_setting_get $app final_path)
#=================================================
# STANDARD REMOVE
#=================================================
# REMOVE DEPENDENCIES
#=================================================
# Remove metapackage and its dependencies
ynh_remove_app_dependencies
#=================================================
# REMOVE THE MYSQL DATABASE
#=================================================
# Remove a database if it exists, along with the associated user
ynh_mysql_remove_db $db_name $db_name
#=================================================
# REMOVE APP MAIN DIR
#=================================================
# Remove the app directory securely
ynh_secure_remove "$final_path"
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
# Remove the dedicated nginx config
ynh_remove_nginx_config
#=================================================
# REMOVE PHP-FPM CONFIGURATION
#=================================================
# Remove the dedicated php-fpm config
ynh_remove_fpm_config
#=================================================
# SPECIFIC REMOVE
#=================================================
# REMOVE THE CRON FILE
#=================================================
# Remove a cron file
ynh_secure_remove "/etc/cron.d/$app"
#=================================================
# GENERIC FINALIZATION
#=================================================
# REMOVE DEDICATED USER
#=================================================
# Delete a system user
ynh_system_user_delete $app

149
scripts/restore
View file

@ -1,69 +1,110 @@
#!/bin/bash #!/bin/bash
# causes the shell to exit if any subcommand or pipeline returns a non-zero status #=================================================
set -e # GENERIC START
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
# The parameter $1 is the backup directory location dedicated to the app # Exit on command errors and treat access to unset variables as an error
backup_dir=$1 set -eu
# The last parameter is the id of the app instance #=================================================
app=${!#} # IMPORT GENERIC HELPERS
#=================================================
# Get old parameter of the app if [ ! -e _common.sh ]; then
domain=$(sudo yunohost app setting $app domain) # Get the _common.sh file if it's not in the current directory
path=$(sudo yunohost app setting $app path) cp ../settings/scripts/_common.sh ./_common.sh
chmod a+rx _common.sh
# Check domain/path availability
sudo yunohost app checkurl $domain$path -a $app
if [[ ! $? -eq 0 ]]; then
echo "There is already an app on this URL : $domain$path" | sudo tee /dev/stderr
exit 1
fi fi
source _common.sh
source /usr/share/yunohost/helpers
# Restore sources & data #=================================================
final_path=/var/www/$app # LOAD SETTINGS
#=================================================
if [ -d $final_path ]; then app=$YNH_APP_INSTANCE_NAME
echo "There is already a directory: $final_path " | sudo tee /dev/stderr
exit 1
fi
sudo cp -a ./www "$final_path"
# Dependences domain=$(ynh_app_setting_get $app domain)
sudo apt-get install php5-cli -y path_url=$(ynh_app_setting_get $app path)
final_path=$(ynh_app_setting_get $app final_path)
db_name=$(ynh_app_setting_get $app db_name)
db_pwd=$(sudo yunohost app setting $app mysqlpwd) #=================================================
db_user=$app # CHECK IF THE APP CAN BE RESTORED
sudo yunohost app initdb $db_user -p $db_pwd #=================================================
sudo su -c "mysql -u $db_user -p$db_pwd $app < ./db.sql"
sudo rm -f "./db.sql"
sudo sed -i -e "s/'DB_USER', *\"[^\"]*\"/'DB_USER', \"$app\"/g" $final_path/config.php
sudo sed -i -e "s/'DB_NAME', *\"[^\"]*\"/'DB_NAME', \"$app\"/g" $final_path/config.php
# Set permissions ynh_webpath_available $domain $path_url \
sudo chown -R www-data:www-data $final_path || ynh_die "Path not available: ${domain}${path_url}"
for i in export images upload js test ! -d $final_path \
do || ynh_die "There is already a directory: $final_path "
sudo chmod -R 777 $final_path/cache/$i
done
for i in feed-icons lock #=================================================
do # STANDARD RESTORATION STEPS
sudo chmod -R 777 $final_path/$i #=================================================
done # RESTORE THE NGINX CONFIGURATION
#=================================================
# Restore conf files ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
conf=/etc/nginx/conf.d/$domain.d/$app.conf
if [ -f $conf ]; then
echo "There is already a nginx conf file at this path: $conf " | sudo tee /dev/stderr
exit 1
fi
sudo cp -a "./conf/nginx.conf" $conf
sudo mv "./conf/cron" /etc/cron.d/$app
sudo chown root /etc/cron.d/$app
# Reload Nginx #=================================================
sudo service nginx reload # RESTORE THE APP MAIN DIR
#=================================================
# Set ssowat config ynh_restore_file "$final_path"
sudo yunohost app setting $app skipped_uris -v "/public.php,/api"
#=================================================
# RESTORE THE MYSQL DATABASE
#=================================================
db_pwd=$(ynh_app_setting_get $app mysqlpwd)
ynh_mysql_setup_db $db_name $db_name $db_pwd
ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
# Create the dedicated user (if not existing)
ynh_system_user_create $app
#=================================================
# RESTORE USER RIGHTS
#=================================================
# Set permissions to app files
chown -R root: $final_path
chown -R $app $final_path/{cache,feed-icons,lock}
#=================================================
# RESTORE THE PHP-FPM CONFIGURATION
#=================================================
ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf"
ynh_restore_file "/etc/php5/fpm/conf.d/20-$app.ini"
#=================================================
# SPECIFIC RESTORATION
#=================================================
# REINSTALL DEPENDENCIES
#=================================================
# Define and install dependencies
ynh_install_app_dependencies php5-cli
#=================================================
# RESTORE THE CRON FILE
#=================================================
ynh_restore_file "/etc/cron.d/$app"
#=================================================
# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX AND PHP-FPM
#=================================================
systemctl reload php5-fpm
systemctl reload nginx

146
scripts/upgrade
View file

@ -1,44 +1,132 @@
#!/bin/bash #!/bin/bash
# causes the shell to exit if any subcommand or pipeline returns a non-zero status #=================================================
set -e # GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Load common variables source _common.sh
source ./_common.sh source /usr/share/yunohost/helpers
app=${!#} #=================================================
# LOAD SETTINGS
#=================================================
domain=$(sudo yunohost app setting $app domain) app=$YNH_APP_INSTANCE_NAME
path=$(sudo yunohost app setting $app path)
db_user=$app domain=$(ynh_app_setting_get $app domain)
db_pwd=$(sudo yunohost app setting $app mysqlpwd) path_url=$(ynh_app_setting_get $app path)
final_path=$(ynh_app_setting_get $app final_path)
db_name=$(ynh_app_setting_get $app db_name)
final_path=/var/www/$app #=================================================
sudo mkdir -p $final_path # ENSURE DOWNWARD COMPATIBILITY
#=================================================
extract_ttrss $final_path if [ -z $final_path ]; then # If final_path doesn't exist, create it
final_path="/var/www/$app"
ynh_app_setting_set $app final_path $final_path
fi
sudo cp ../conf/config.php $final_path/ if [ -z $db_name ]; then # If db_name doesn't exist, create it
sudo cp ../conf/*.patch /tmp/ db_name=$(ynh_sanitize_dbid $app)
sudo patch -d $final_path -p0 < /tmp/update.patch ynh_app_setting_set $app db_name $db_name
sudo patch -d $final_path/plugins/auth_remote/ -p0 < /tmp/init.patch fi
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_backup_before_upgrade # Backup the current version of the app
ynh_clean_setup () {
ynh_restore_upgradebackup # restore it if the upgrade fails
}
ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée.
#=================================================
# CHECK THE PATH
#=================================================
# Normalize the URL path syntax
path_url=$(ynh_normalize_url_path $path_url)
#=================================================
# STANDARD UPGRADE STEPS
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source "$final_path"
#=================================================
# NGINX CONFIGURATION
#=================================================
# Create a dedicated nginx config
ynh_add_nginx_config
#=================================================
# CREATE DEDICATED USER
#=================================================
# Create a system user
ynh_system_user_create $app
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
# Create a dedicated php-fpm config
ynh_add_fpm_config
#=================================================
# SPECIFIC UPGRADE
#=================================================
# CONFIGURE TTRSS
#=================================================
# Verify the checksum and backup the file if it's different
ynh_backup_if_checksum_is_different "$final_path/config.php"
cp ../conf/config.php "$final_path/config.php"
# Change variables in ttrss configuration # Change variables in ttrss configuration
sudo sed -i "s/yunouser/$db_user/g" $final_path/config.php ynh_replace_string "__DBNAME__" "$db_name" "$final_path/config.php"
sudo sed -i "s/yunopass/$db_pwd/g" $final_path/config.php db_pwd=$(ynh_app_setting_get $app mysqlpwd)
sudo sed -i "s/yunobase/$db_user/g" $final_path/config.php ynh_replace_string "__DBPWD__" "$db_pwd" "$final_path/config.php"
sudo sed -i "s,yunopath,https://$domain$path,g" $final_path/config.php ynh_replace_string "__DOMAINPATH__" "https://$domain$path_url" "$final_path/config.php"
sudo chown -R www-data: $final_path # Recalculate and store the config file checksum into the app settings
ynh_store_file_checksum "$final_path/config.php"
# Modify Nginx configuration file and copy it to Nginx conf directory #=================================================
sudo sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf # UPGRADE THE CRON FILE
sudo sed -i "s@ALIASTOCHANGE@$final_path/@g" ../conf/nginx.conf #=================================================
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
sudo service nginx reload echo "*/30 * * * * $app cd $final_path && /usr/bin/php $final_path/update.php --feeds >/dev/null 2>&1" \
sudo yunohost app setting $app skipped_uris -v "/public.php,/api" > /etc/cron.d/$app
# Update database schema #=================================================
sudo sudo -u www-data php ${final_path}/update.php --update-schema # UPGRADE DATABASE
#=================================================
chown -R $app: $final_path
sudo -u $app php ${final_path}/update.php --update-schema
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================
# Set permissions to app files
chown -R root: $final_path
chown -R $app $final_path/{cache,feed-icons,lock}
#=================================================
# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX
#=================================================
systemctl reload nginx

4
conf/init.patch → sources/patches/app-init.patch
View file

@ -1,5 +1,5 @@
*** init.php 2015-01-22 17:56:31.641845090 +0100 *** /plugins/auth_remote/init.php 2015-01-22 17:56:31.641845090 +0100
--- init.php.1 2015-02-20 09:23:16.515269911 +0100 --- /plugins/auth_remote/init.php.1 2015-02-20 09:23:16.515269911 +0100
*************** ***************
*** 69,74 **** *** 69,74 ****
--- 69,84 ---- --- 69,84 ----

4
conf/update.patch → sources/patches/app-update.patch
View file

@ -1,5 +1,5 @@
*** update.php 2015-02-20 09:41:40.231462387 +0100 *** /update.php 2015-02-20 09:41:40.231462387 +0100
--- update.php.1 2015-02-20 09:42:07.911466665 +0100 --- /update.php.1 2015-02-20 09:42:07.911466665 +0100
*************** ***************
*** 311,318 **** *** 311,318 ****
_debug("WARNING: please backup your database before continuing."); _debug("WARNING: please backup your database before continuing.");