From 9963c0d7e619ef5c238ad4b012686da30b3f6816 Mon Sep 17 00:00:00 2001 From: ljf Date: Sun, 27 May 2018 19:56:20 +0200 Subject: [PATCH 1/8] [fix] Indicate the License correctly --- manifest.json | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/manifest.json b/manifest.json index df065a7..71cd8fe 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Joomla! is an award-winning content management system." }, "url": "https://www.joomla.org", - "license": "free", + "license": "GPL-2.0-only", "version": "3.8.7", "maintainer": { "name": "Anmol Sharma", @@ -43,7 +43,7 @@ { "name": "username", "ask": { - "en": "Admin unsername" + "en": "Admin username" }, "example": "john" }, @@ -59,8 +59,7 @@ "type": "password", "ask": { "en": "Password for the admin account (At least 6 characters long)" - }, - "example": "admin@example.com" + } }, { "name": "is_public", From d5b6bff5b82da0877a654390996e5873d25865d0 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 22 Jan 2022 20:55:44 +0100 Subject: [PATCH 2/8] Apply example_ynh --- README.md | 2 +- check_process | 38 ++-- conf/app.src | 11 +- conf/configuration.php | 145 +++++++++++++ conf/install.php | 407 ------------------------------------ conf/nginx.conf | 71 +++---- conf/php-fpm.conf | 430 +++++++++++++++++++++++++++++++++++++++ doc/.gitkeep | 0 doc/DESCRIPTION.md | 1 + doc/DISCLAIMER.md | 13 ++ doc/screenshots/.gitkeep | 0 manifest.json | 55 ++--- scripts/_common.sh | 119 ++--------- scripts/backup | 56 ++--- scripts/change_url | 135 ++++++++++++ scripts/install | 165 ++++++++------- scripts/remove | 65 +++++- scripts/restore | 112 ++++++---- scripts/upgrade | 128 ++++++++---- 19 files changed, 1161 insertions(+), 792 deletions(-) create mode 100644 conf/configuration.php delete mode 100644 conf/install.php create mode 100644 conf/php-fpm.conf create mode 100644 doc/.gitkeep create mode 100644 doc/DESCRIPTION.md create mode 100644 doc/DISCLAIMER.md create mode 100644 doc/screenshots/.gitkeep create mode 100644 scripts/change_url diff --git a/README.md b/README.md index e8b2525..991ebbe 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Joomla_ynh [![Install Joomla with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=joomla) -Joomla! is an award-winning content management system https://www.joomla.org/
Version: 3.8.7

+Joomla! is an award-winning content management system https://www.joomla.org/
Version: 4.0.6

Why Joomla?

Hundreds of developers have been improving Joomla! since the first version was released in 2005. This immense effort has made Joomla! very popular, easy to use, stable and secure. See for more details:https://www.joomla.org/3/


diff --git a/check_process b/check_process index 1f96418..3274e10 100644 --- a/check_process +++ b/check_process @@ -1,15 +1,10 @@ -;; Nom du test -# Commentaire ignoré +;; Test complet ; Manifest - domain="domain.tld" (DOMAIN) - path="/path" (PATH) - username="john" - email="john@domain.tld" - password="password" -# is_public="Yes" (PUBLIC|public=Yes|private=No) - is_public=1 (PUBLIC|public=1|private=0) - - + domain="domain.tld" + path="/path" + admin="john" + is_public=1 + password="1Strong-Password" ; Checks pkg_linter=1 setup_sub_dir=1 @@ -18,22 +13,15 @@ setup_private=1 setup_public=1 upgrade=1 + # upgrade=1 from_commit=CommitHash backup_restore=1 multi_instance=1 - incorrect_path=1 - port_already_use=0 (66) - change_url=0 -;;; Levels - Level 1=auto - Level 2=auto - Level 3=auto - Level 4=0 - Level 5=auto - Level 6=0 - Level 7=auto - Level 8=0 - Level 9=0 - Level 10=0 + port_already_use=0 + change_url=1 ;;; Options Email=anmol@datamol.org Notification= +Notification=none +;;; Upgrade options + ; commit=CommitHash + name=Name and date of the commit. diff --git a/conf/app.src b/conf/app.src index cf6c6a8..116315a 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,6 +1,7 @@ -SOURCE_URL=https://downloads.joomla.org/cms/joomla3/3-8-7/Joomla_3-8-7-Stable-Full_Package.zip?format=zip -SOURCE_SUM=54e4154fd7b4ea3bc948b74c84afd733 -SOURCE_SUM_PRG=md5sum -SOURCE_FORMAT=zip +SOURCE_URL=https://github.com/joomla/joomla-cms/releases/download/4.0.6/Joomla_4.0.6-Stable-Full_Package.tar.gz +SOURCE_SUM=b9c638f47d75cc1f51846d0aeec43763bef4acb94d21fbdc4510cf67834cc314 +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=Joomla_3-8-7-Stable-Full_Package +SOURCE_FILENAME= +SOURCE_EXTRACT=true diff --git a/conf/configuration.php b/conf/configuration.php new file mode 100644 index 0000000..5d7cd2b --- /dev/null +++ b/conf/configuration.php @@ -0,0 +1,145 @@ + + * @license GNU General Public License version 2 or later; see LICENSE.txt + * + * ------------------------------------------------------------------------- + * THIS SHOULD ONLY BE USED AS A LAST RESORT WHEN THE WEB INSTALLER FAILS + * + * If you are installing Joomla! manually ie not using the web browser installer + * then rename this file to configuration.php eg + * + * UNIX -> mv configuration.php-dist configuration.php + * Windows -> rename configuration.php-dist configuration.php + * + * Now edit this file and configure the parameters for your site and + * database. + * + * Finally move this file to the root folder of your Joomla installation eg + * + * UNIX -> mv configuration.php ../ + * Windows -> copy configuration.php ../ + * + */ +class JConfig +{ + /* Site Settings */ + public $offline = false; + public $offline_message = 'This site is down for maintenance.
Please check back again soon.'; + public $display_offline_message = 1; + public $offline_image = ''; + public $sitename = 'Joomla!'; // Name of Joomla site + public $editor = 'tinymce'; + public $captcha = 0; + public $list_limit = 20; + public $access = 1; + public $frontediting = 1; + + /* Database Settings */ + public $dbtype = 'mysqli'; // Normally mysqli + public $host = 'localhost'; // This is normally set to localhost + public $user = '__DB_USER__'; // Database username + public $password = '__DB_PWD__'; // Database password + public $db = '__DB_NAME__'; // Database name + public $dbprefix = ''; // Any random string ending with _ + public $dbencryption = 0; + public $dbsslverifyservercert = false; + public $dbsslkey = ''; + public $dbsslcert = ''; + public $dbsslca = ''; + public $dbsslcipher = ''; + + /* Server Settings */ + public $secret = ''; // Use something very secure. For example on linux the following command `cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w ${1:-16} | head -n 1` + public $gzip = false; + public $error_reporting = 'default'; + public $helpurl = 'https://help.joomla.org/proxy?keyref=Help{major}{minor}:{keyref}&lang={langcode}'; + public $tmp_path = '/tmp'; // This path needs to be writable by Joomla! + public $log_path = '/var/log/__APP__'; // This path needs to be writable by Joomla! + public $live_site = ''; // Optional, full URL to Joomla install. + public $force_ssl = 0; // Force areas of the site to be SSL ONLY. 0 = None, 1 = Administrator, 2 = Both Site and Administrator + + /* Locale Settings */ + public $offset = 'UTC'; + + /* Session settings */ + public $lifetime = 15; // Session time + public $session_handler = 'database'; + public $shared_session = false; + public $session_memcached_server_host = 'localhost'; + public $session_memcached_server_port = 11211; + public $session_redis_server_host = 'localhost'; + public $session_redis_server_port = 6379; + public $session_redis_server_db = 0; + + + /* Mail Settings */ + public $mailonline = true; + public $mailer = 'mail'; + public $mailfrom = ''; + public $fromname = ''; + public $massmailoff = false; + public $replyto = ''; + public $replytoname = ''; + public $sendmail = '/usr/sbin/sendmail'; + public $smtpauth = false; + public $smtpuser = ''; + public $smtppass = ''; + public $smtphost = 'localhost'; + public $smtpsecure = 'none'; + public $smtpport = 25; + + /* Cache Settings */ + public $caching = 0; + public $cachetime = 15; + public $cache_handler = 'file'; + public $cache_platformprefix = false; + public $memcached_persist = true; + public $memcached_compress = false; + public $memcached_server_host = 'localhost'; + public $memcached_server_port = 11211; + public $redis_persist = true; + public $redis_server_host = 'localhost'; + public $redis_server_port = 6379; + public $redis_server_auth = ''; + public $redis_server_db = 0; + + /* Proxy Settings */ + public $proxy_enable = false; + public $proxy_host = ''; + public $proxy_port = ''; + public $proxy_user = ''; + public $proxy_pass = ''; + + /* Debug Settings */ + public $debug = true; + public $debug_lang = false; + public $debug_lang_const = true; + + /* Meta Settings */ + public $MetaDesc = 'Joomla! - the dynamic portal engine and content management system'; + public $MetaAuthor = true; + public $MetaVersion = false; + public $MetaRights = ''; + public $robots = ''; + public $sitename_pagetitles = 0; + + /* SEO Settings */ + public $sef = true; + public $sef_rewrite = false; + public $sef_suffix = false; + public $unicodeslugs = false; + + /* Feed Settings */ + public $feed_limit = 10; + public $feed_email = 'none'; + + /* Cookie Settings */ + public $cookie_domain = ''; + public $cookie_path = ''; + + /* Miscellaneous Settings */ + public $asset_id = 1; +} diff --git a/conf/install.php b/conf/install.php deleted file mode 100644 index a07e0e8..0000000 --- a/conf/install.php +++ /dev/null @@ -1,407 +0,0 @@ - array( - 'getopt' => 'help', - 'description' => 'Display help', - ), - 'admin_email' => array( - 'getopt' => 'admin-email:', - 'description' => 'Admin user\'s email', - 'required' => true, - ), - 'admin_password' => array( - 'getopt' => 'admin-pass:', - 'description' => 'Admin user\'s password', - 'required' => true, - ), - 'admin_user' => array( - 'getopt' => 'admin-user:', - 'description' => 'Admin user\'s username', - 'default' => 'admin', - ), - 'db_host' => array( - 'getopt' => 'db-host:', - 'description' => 'Hostname (or hostname:port)', - 'default' => 'localhost', - ), - 'db_name' => array( - 'getopt' => 'db-name:', - 'description' => 'Database name', - 'required' => true, - ), - 'db_old' => array( - 'getopt' => 'db-old:', - 'description' => 'Policy to use with old DB [remove,backup]]', - 'default' => 'remove', - ), - 'db_pass' => array( - 'getopt' => 'db-pass:', - 'description' => 'Database password', - 'required' => true, - ), - 'db_prefix' => array( - 'getopt' => 'db-prefix:', - 'description' => 'Table prefix', - 'factory' => function () { - // FIXME: Duplicated from installation/model/fields/prefix.php - $size = 5; - $prefix = ''; - $chars = range('a', 'z'); - $numbers = range(0, 9); - // We want the fist character to be a random letter: - shuffle($chars); - $prefix .= $chars[0]; - // Next we combine the numbers and characters to get the other characters: - $symbols = array_merge($numbers, $chars); - shuffle($symbols); - for ($i = 0, $j = $size - 1; $i < $j; ++$i) - { - $prefix .= $symbols[$i]; - } - // Add in the underscore: - $prefix .= '_'; - return $prefix; - }, - ), - 'db_type' => array( - 'getopt' => 'db-type:', - 'description' => 'Database type [mysql,mysqli,postgresql,sqlsrv,sqlazure]', - 'default' => 'mysqli', - ), - 'db_user' => array( - 'getopt' => 'db-user:', - 'description' => 'Database user', - 'required' => true, - ), - 'helpurl' => array( - 'getopt' => 'help-url:', - 'description' => 'Help URL', - 'default' => 'http://help.joomla.org/proxy/index.php?option=com_help&keyref=Help{major}{minor}:{keyref}', - ), - // FIXME: Not clear if this is useful. Seems to be "the language of the installation application" - // and not "the language of the installed CMS" - 'language' => array( - 'getopt' => 'lang:', - 'description' => 'Language', - 'default' => 'en-US', - ), - 'site_metadesc' => array( - 'getopt' => 'desc:', - 'description' => 'Site description', - 'default' => '' - ), - 'site_name' => array( - 'getopt' => 'name:', - 'description' => 'Site name', - 'default' => 'Joomla' - ), - 'site_offline' => array( - 'getopt' => 'offline', - 'description' => 'Set site as offline', - 'default' => 0, - ), - 'sample_file' => array( - 'getopt' => 'sample:', - 'description' => 'Sample SQL file (sample_blog.sql,sample_brochure.sql,...)', - 'default' => '', - ), - 'summary_email' => array( - 'getopt' => 'email', - 'description' => 'Send email notification', - 'default' => 0, - ), - ); - // Installer internally has an option "admin_password2", but it - // doesn't seem to be necessary. - foreach (array_keys($optionsMetadata) as $key) - { - if (!isset($optionsMetadata[$key]['syntax'])) - { - if (preg_match('/:$/', $optionsMetadata[$key]['getopt'])) - { - $optionsMetadata[$key]['syntax'] = '--' . rtrim($optionsMetadata[$key]['getopt'], ':') . '="..."'; - } - else - { - $optionsMetadata[$key]['syntax'] = '--' . $optionsMetadata[$key]['getopt']; - } - } - } - return $optionsMetadata; - } - /** - * Entry point for the script - * - * @return void - * - * @since 2.5 - */ - public function doExecute() - { - JFactory::getApplication('CliInstaller'); - // Parse options - $options = $this->parseOptions(); - if (array_key_exists('help', $options)) - { - $this->displayUsage(); - $this->close(0); - } - $errors = $this->validateOptions($options); - if (!empty($errors)) - { - foreach ($errors as $error) - { - $this->enqueueMessage($error, 'fatal'); - } - $this->displayUsage(); - $this->close(1); - } - // Attempt to initialise the database. - $db = new InstallationModelDatabase; - if (!$db->createDatabase($options)) - { - $this->fatal("Error executing createDatabase"); - } - // FIXME InstallationModelDatabase relies on session manipulation which doesn't work well in cli - // $session = JFactory::getSession(); - // $options = $session->get('setup.options', NULL); - $options['db_created'] = 1; - $options['db_select'] = 1; - if ($options['db_old'] == 'backup') - { - if (!$db->handleOldDatabase($options)) - { - $this->fatal("Error executing handleOldDatabase"); - } - } - if (!$db->createTables($options)) - { - $this->fatal("Error executing createTables"); - } - // Attempt to setup the configuration. - $configuration = new InstallationModelConfiguration; - if (!$configuration->setup($options)) - { - $this->fatal("Error executing setup"); - } - // Attempt to create the database tables. - if ($options['sample_file']) - { - if (!$db->installSampleData($options)) - { - $this->fatal("Error executing installSampleData"); - } - } - $this->out('Done'); - } - /** - * Display help text - * - * @return void - */ - public function displayUsage() - { - $this->out("Install Joomla"); - $this->out("usage: php install.php [options]"); - foreach ($this->getOptionsMetadata() as $spec) - { - $syntax = sprintf("%-25s", $spec['syntax']); - if (isset($spec['description'])) - { - $syntax .= $spec['description']; - } - if (isset($spec['required']) && $spec['required']) - { - $syntax .= ' (required)'; - } - if (isset($spec['default'])) - { - $syntax .= " (default: {$spec['default']})"; - } - if (isset($spec['factory'])) - { - $syntax .= " (default: auto-generated)"; - } - $this->out(" " . $syntax); - } - } - /** - * Validate the inputs - * - * @param array $options parsed input values - * - * @return array of error messages - */ - public function validateOptions($options) - { - $optionsMetadata = $this->getOptionsMetadata(); - $errors = array(); - foreach ($optionsMetadata as $key => $spec) - { - if (!isset($options[$key]) && isset($spec['required']) && $spec['required']) - { - $errors[] = "Missing required option: {$spec['syntax']}"; - } - } - return $errors; - } - /** - * Parse all options from the command-line - * - * @return array - */ - public function parseOptions() - { - global $argv; - if (count($argv) <= 1) - { - return array('help' => 1); - } - $optionsMetadata = $this->getOptionsMetadata(); - $longopts = array(); - foreach ($optionsMetadata as $key => $spec) - { - $longopts[] = $spec['getopt']; - } - $rawOptions = getopt("", $longopts); - $options = array(); - foreach ($optionsMetadata as $key => $spec) - { - $rawKey = rtrim($spec['getopt'], ':'); - if (isset($rawOptions[$rawKey])) - { - if (preg_match('/:$/', $spec['getopt'])) - { - $options[$key] = $rawOptions[$rawKey]; - } - else - { - $options[$key] = 1; - } - } - elseif (isset($spec['factory'])) - { - $options[$key] = call_user_func($spec['factory']); - } - elseif (isset($spec['default'])) - { - $options[$key] = $spec['default']; - } - } - return $options; - } - /** - * Enqueue a system message. - * - * @param string $msg The message to enqueue. - * @param string $type The message type. Default is message. - * - * @return void - * - * @since 3.2 - */ - public function enqueueMessage($msg, $type = 'message') - { - $this->out("[$type] $msg"); - } - /** - * Trigger a fatal error - * - * @param string $msg The message to enqueue. - * - * @return void - */ - public function fatal($msg) - { - $this->enqueueMessage($msg, 'fatal'); - $this->close(1); - } - /** - * FIXME: Duplicated from ./installation/application/web.php - */ - public function getLocaliseAdmin($db = false) - { - // Read the files in the admin area - $path = JLanguage::getLanguagePath(JPATH_ADMINISTRATOR); - $langfiles['admin'] = JFolder::folders($path); - // Read the files in the site area - $path = JLanguage::getLanguagePath(JPATH_SITE); - $langfiles['site'] = JFolder::folders($path); - if ($db) - { - $langfiles_disk = $langfiles; - $langfiles = array(); - $langfiles['admin'] = array(); - $langfiles['site'] = array(); - $query = $db->getQuery(true) - ->select($db->quoteName(array('element', 'client_id'))) - ->from($db->quoteName('#__extensions')) - ->where($db->quoteName('type') . ' = ' . $db->quote('language')); - $db->setQuery($query); - $langs = $db->loadObjectList(); - foreach ($langs as $lang) - { - switch ($lang->client_id) - { - // Site - case 0: - if (in_array($lang->element, $langfiles_disk['site'])) - { - $langfiles['site'][] = $lang->element; - } - break; - // Administrator - case 1: - if (in_array($lang->element, $langfiles_disk['admin'])) - { - $langfiles['admin'][] = $lang->element; - } - break; - } - } - } - return $langfiles; - } -} -JApplicationCli::getInstance('JApplicationCliInstaller')->execute(); diff --git a/conf/nginx.conf b/conf/nginx.conf index c3ea210..01fd5c2 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,41 +1,44 @@ -location __PATH__ { - alias __FINALPATH__/; +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; +location __PATH__/ { - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } + # Path to source + alias __FINALPATH__/ ; - # Default indexes and catch-all - index index.html index.php; - try_files $uri $uri/ __PATH__/index.php?$args; + index index.php; - # Prevent useless logs - location = __PATH__/favicon.ico { - log_not_found off; - access_log off; - } - location = __PATH__/robots.txt { - allow all; - log_not_found off; - access_log off; - } + # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file + #client_max_body_size 50M; - # Deny access to hidden files and directories - location ~ ^__PATH__/(.+/|)\.(?!well-known\/) { - deny all; - } + try_files $uri $uri/ __PATH__/index.php?$args index.php; - # Execute and serve PHP files - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } + # Prevent useless logs + location = __PATH__/favicon.ico { + log_not_found off; + access_log off; + } + location = __PATH__/robots.txt { + allow all; + log_not_found off; + access_log off; + } - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; + # Deny access to hidden files and directories + location ~ ^__PATH__/(.+/|)\.(?!well-known\/) { + deny all; + } + + # Execute and serve PHP files + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; + + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } + + # 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..ab1a471 --- /dev/null +++ b/conf/php-fpm.conf @@ -0,0 +1,430 @@ +; 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/php__PHPVERSION__-fpm-__NAMETOCHANGE__.sock + +; Set listen(2) backlog. +; Default Value: 511 (-1 on FreeBSD and OpenBSD) +;listen.backlog = 511 + +; Set permissions for unix socket, if one is used. In Linux, read/write +; permissions must be set in order to allow connections from a web server. Many +; BSD-derived systems allow connections regardless of permissions. +; Default Values: user and group are set as the running user +; mode is set to 0660 +listen.owner = www-data +listen.group = www-data +;listen.mode = 0660 +; When POSIX Access Control Lists are supported you can set them using +; these options, value is a comma separated list of user/group names. +; When set, listen.owner and listen.group are ignored +;listen.acl_users = +;listen.acl_groups = + +; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect. +; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original +; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address +; must be separated by a comma. If this value is left blank, connections will be +; accepted from any ip address. +; Default Value: any +;listen.allowed_clients = 127.0.0.1 + +; Specify the nice(2) priority to apply to the pool processes (only if set) +; The value can vary from -19 (highest priority) to 20 (lower priority) +; Note: - It will only work if the FPM master process is launched as root +; - The pool processes will inherit the master process priority +; unless it specified otherwise +; Default Value: no set +; process.priority = -19 + +; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user +; or group is differrent than the master process user. It allows to create process +; core dump and ptrace the process for the pool user. +; Default Value: no +; process.dumpable = yes + +; Choose how the process manager will control the number of child processes. +; Possible Values: +; static - a fixed number (pm.max_children) of child processes; +; dynamic - the number of child processes are set dynamically based on the +; following directives. With this process management, there will be +; always at least 1 children. +; pm.max_children - the maximum number of children that can +; be alive at the same time. +; pm.start_servers - the number of children created on startup. +; pm.min_spare_servers - the minimum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is less than this +; number then some children will be created. +; pm.max_spare_servers - the maximum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is greater than this +; number then some children will be killed. +; ondemand - no children are created at startup. Children will be forked when +; new requests will connect. The following parameter are used: +; pm.max_children - the maximum number of children that +; can be alive at the same time. +; pm.process_idle_timeout - The number of seconds after which +; an idle process will be killed. +; Note: This value is mandatory. +pm = dynamic + +; The number of child processes to be created when pm is set to 'static' and the +; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. +; This value sets the limit on the number of simultaneous requests that will be +; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. +; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP +; CGI. The below defaults are based on a server without much resources. Don't +; forget to tweak pm.* to fit your needs. +; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' +; Note: This value is mandatory. +pm.max_children = 5 + +; The number of child processes created on startup. +; Note: Used only when pm is set to 'dynamic' +; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 +pm.start_servers = 2 + +; The desired minimum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +pm.min_spare_servers = 1 + +; The desired maximum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +pm.max_spare_servers = 3 + +; The number of seconds after which an idle process will be killed. +; Note: Used only when pm is set to 'ondemand' +; Default Value: 10s +;pm.process_idle_timeout = 10s; + +; The number of requests each child process should execute before respawning. +; This can be useful to work around memory leaks in 3rd party libraries. For +; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. +; Default Value: 0 +;pm.max_requests = 500 + +; The URI to view the FPM status page. If this value is not set, no URI will be +; recognized as a status page. It shows the following informations: +; pool - the name of the pool; +; process manager - static, dynamic or ondemand; +; start time - the date and time FPM has started; +; start since - number of seconds since FPM has started; +; accepted conn - the number of request accepted by the pool; +; listen queue - the number of request in the queue of pending +; connections (see backlog in listen(2)); +; max listen queue - the maximum number of requests in the queue +; of pending connections since FPM has started; +; listen queue len - the size of the socket queue of pending connections; +; idle processes - the number of idle processes; +; active processes - the number of active processes; +; total processes - the number of idle + active processes; +; max active processes - the maximum number of active processes since FPM +; has started; +; max children reached - number of times, the process limit has been reached, +; when pm tries to start more children (works only for +; pm 'dynamic' and 'ondemand'); +; Value are updated in real time. +; Example output: +; pool: www +; process manager: static +; start time: 01/Jul/2011:17:53:49 +0200 +; start since: 62636 +; accepted conn: 190460 +; listen queue: 0 +; max listen queue: 1 +; listen queue len: 42 +; idle processes: 4 +; active processes: 11 +; total processes: 15 +; max active processes: 12 +; max children reached: 0 +; +; By default the status page output is formatted as text/plain. Passing either +; 'html', 'xml' or 'json' in the query string will return the corresponding +; output syntax. Example: +; http://www.foo.bar/status +; http://www.foo.bar/status?json +; http://www.foo.bar/status?html +; http://www.foo.bar/status?xml +; +; By default the status page only outputs short status. Passing 'full' in the +; query string will also return status for each pool process. +; Example: +; http://www.foo.bar/status?full +; http://www.foo.bar/status?json&full +; http://www.foo.bar/status?html&full +; http://www.foo.bar/status?xml&full +; The Full status returns for each process: +; pid - the PID of the process; +; state - the state of the process (Idle, Running, ...); +; start time - the date and time the process has started; +; start since - the number of seconds since the process has started; +; requests - the number of requests the process has served; +; request duration - the duration in µs of the requests; +; request method - the request method (GET, POST, ...); +; request URI - the request URI with the query string; +; content length - the content length of the request (only with POST); +; user - the user (PHP_AUTH_USER) (or '-' if not set); +; script - the main script called (or '-' if not set); +; last request cpu - the %cpu the last request consumed +; it's always 0 if the process is not in Idle state +; because CPU calculation is done when the request +; processing has terminated; +; last request memory - the max amount of memory the last request consumed +; it's always 0 if the process is not in Idle state +; because memory calculation is done when the request +; processing has terminated; +; If the process is in Idle state, then informations are related to the +; last request the process has served. Otherwise informations are related to +; the current request being served. +; Example output: +; ************************ +; pid: 31330 +; state: Running +; start time: 01/Jul/2011:17:53:49 +0200 +; start since: 63087 +; requests: 12808 +; request duration: 1250261 +; request method: GET +; request URI: /test_mem.php?N=10000 +; content length: 0 +; user: - +; script: /home/fat/web/docs/php/test_mem.php +; last request cpu: 0.00 +; last request memory: 0 +; +; Note: There is a real-time FPM status monitoring sample web page available +; It's available in: /usr/share/php/7.0/fpm/status.html +; +; Note: The value must start with a leading slash (/). The value can be +; anything, but it may not be a good idea to use the .php extension or it +; may conflict with a real PHP file. +; Default Value: not set +;pm.status_path = /status + +; The ping URI to call the monitoring page of FPM. If this value is not set, no +; URI will be recognized as a ping page. This could be used to test from outside +; that FPM is alive and responding, or to +; - create a graph of FPM availability (rrd or such); +; - remove a server from a group if it is not responding (load balancing); +; - trigger alerts for the operating team (24/7). +; Note: The value must start with a leading slash (/). The value can be +; anything, but it may not be a good idea to use the .php extension or it +; may conflict with a real PHP file. +; Default Value: not set +;ping.path = /ping + +; This directive may be used to customize the response of a ping request. The +; response is formatted as text/plain with a 200 response code. +; Default Value: pong +;ping.response = pong + +; The access log file +; Default: not set +;access.log = log/$pool.access.log + +; The access log format. +; The following syntax is allowed +; %%: the '%' character +; %C: %CPU used by the request +; it can accept the following format: +; - %{user}C for user CPU only +; - %{system}C for system CPU only +; - %{total}C for user + system CPU (default) +; %d: time taken to serve the request +; it can accept the following format: +; - %{seconds}d (default) +; - %{miliseconds}d +; - %{mili}d +; - %{microseconds}d +; - %{micro}d +; %e: an environment variable (same as $_ENV or $_SERVER) +; it must be associated with embraces to specify the name of the env +; variable. Some exemples: +; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e +; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e +; %f: script filename +; %l: content-length of the request (for POST request only) +; %m: request method +; %M: peak of memory allocated by PHP +; it can accept the following format: +; - %{bytes}M (default) +; - %{kilobytes}M +; - %{kilo}M +; - %{megabytes}M +; - %{mega}M +; %n: pool name +; %o: output header +; it must be associated with embraces to specify the name of the header: +; - %{Content-Type}o +; - %{X-Powered-By}o +; - %{Transfert-Encoding}o +; - .... +; %p: PID of the child that serviced the request +; %P: PID of the parent of the child that serviced the request +; %q: the query string +; %Q: the '?' character if query string exists +; %r: the request URI (without the query string, see %q and %Q) +; %R: remote IP address +; %s: status (response code) +; %t: server time the request was received +; it can accept a strftime(3) format: +; %d/%b/%Y:%H:%M:%S %z (default) +; The strftime(3) format must be encapsuled in a %{}t tag +; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t +; %T: time the log has been written (the request has finished) +; it can accept a strftime(3) format: +; %d/%b/%Y:%H:%M:%S %z (default) +; The strftime(3) format must be encapsuled in a %{}t tag +; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t +; %u: remote user +; +; Default: "%R - %u %t \"%m %r\" %s" +;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" + +; The log file for slow requests +; Default Value: not set +; Note: slowlog is mandatory if request_slowlog_timeout is set +;slowlog = log/$pool.log.slow + +; The timeout for serving a single request after which a PHP backtrace will be +; dumped to the 'slowlog' file. A value of '0s' means 'off'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +;request_slowlog_timeout = 0 + +; The timeout for serving a single request after which the worker process will +; be killed. This option should be used when the 'max_execution_time' ini option +; does not stop script execution for some reason. A value of '0' means 'off'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +request_terminate_timeout = 1d + +; Set open file descriptor rlimit. +; Default Value: system defined value +;rlimit_files = 1024 + +; Set max core size rlimit. +; Possible Values: 'unlimited' or an integer greater or equal to 0 +; Default Value: system defined value +;rlimit_core = 0 + +; Chroot to this directory at the start. This value must be defined as an +; absolute path. When this value is not set, chroot is not used. +; Note: you can prefix with '$prefix' to chroot to the pool prefix or one +; of its subdirectories. If the pool prefix is not set, the global prefix +; will be used instead. +; Note: chrooting is a great security feature and should be used whenever +; possible. However, all PHP paths will be relative to the chroot +; (error_log, sessions.save_path, ...). +; Default Value: not set +;chroot = + +; Chdir to this directory at the start. +; Note: relative path can be used. +; Default Value: current directory or / when chroot +chdir = __FINALPATH__ + +; Redirect worker stdout and stderr into main error log. If not set, stdout and +; stderr will be redirected to /dev/null according to FastCGI specs. +; Note: on highloaded environement, this can cause some delay in the page +; process time (several ms). +; Default Value: no +;catch_workers_output = yes + +; Clear environment in FPM workers +; Prevents arbitrary environment variables from reaching FPM worker processes +; by clearing the environment in workers before env vars specified in this +; pool configuration are added. +; Setting to "no" will make all environment variables available to PHP code +; via getenv(), $_ENV and $_SERVER. +; Default Value: yes +;clear_env = no + +; Limits the extensions of the main script FPM will allow to parse. This can +; prevent configuration mistakes on the web server side. You should only limit +; FPM to .php extensions to prevent malicious users to use other extensions to +; execute php code. +; Note: set an empty value to allow all extensions. +; Default Value: .php +;security.limit_extensions = .php .php3 .php4 .php5 .php7 + +; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from +; the current environment. +; Default Value: clean env +;env[HOSTNAME] = $HOSTNAME +;env[PATH] = /usr/local/bin:/usr/bin:/bin +;env[TMP] = /tmp +;env[TMPDIR] = /tmp +;env[TEMP] = /tmp + +; Additional php.ini defines, specific to this pool of workers. These settings +; overwrite the values previously defined in the php.ini. The directives are the +; same as the PHP SAPI: +; php_value/php_flag - you can set classic ini defines which can +; be overwritten from PHP call 'ini_set'. +; php_admin_value/php_admin_flag - these directives won't be overwritten by +; PHP call 'ini_set' +; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. + +; Defining 'extension' will load the corresponding shared extension from +; extension_dir. Defining 'disable_functions' or 'disable_classes' will not +; overwrite previously defined php.ini values, but will append the new value +; instead. + +; Note: path INI options can be relative and will be expanded with the prefix +; (pool, global or /usr) + +; Default Value: nothing is defined by default except the values in php.ini and +; specified at startup with the -d argument +;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com +;php_flag[display_errors] = off +;php_admin_value[error_log] = /var/log/fpm-php.www.log +;php_admin_flag[log_errors] = on +;php_admin_value[memory_limit] = 32M + +; Common values to change to increase file upload limit +; php_admin_value[upload_max_filesize] = 50M +; php_admin_value[post_max_size] = 50M +; php_admin_flag[mail.add_x_header] = Off + +; Other common parameters +; php_admin_value[max_execution_time] = 600 +; php_admin_value[max_input_time] = 300 +; php_admin_value[memory_limit] = 256M +; php_admin_flag[short_open_tag] = On diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..c0325e1 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +Joomla! is a free and open-source content management system (CMS) for publishing web content. Over the years Joomla! has won several awards. It is built on a model–view–controller web application framework that can be used independently of the CMS that allows you to build powerful online applications. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..a1fd2a0 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,13 @@ +# Ldap configuration (For now you have to configure it youeself) +Enable ldap Extension
+Enter the following feilds:
+**Host:** localhost
+**Port**:389
+**LdapV3:** Yes
+**Authorisation Method:** Bind and search
+**Base DN:** dc=yunohost,dc=org
+**uid:** uid=[search]
+**User's DN:** ou=users,dc=yunohost,dc=org
+**Map Full Name:** displayname
+**Map Email:** mail
+**Map User ID:** uid
diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/manifest.json b/manifest.json index 71cd8fe..2d9f807 100644 --- a/manifest.json +++ b/manifest.json @@ -5,70 +5,55 @@ "description": { "en": "Joomla! is an award-winning content management system." }, + "version": "4.0.6~ynh1", "url": "https://www.joomla.org", + "upstream": { + "license": "GPL-2.0-only", + "website": "https://www.joomla.org/", + "admindoc": "https://docs.joomla.org/", + "code": "https://github.com/joomla/joomla-cms" + }, "license": "GPL-2.0-only", - "version": "3.8.7", "maintainer": { "name": "Anmol Sharma", "email": "anmol@datamol.org" }, "requirements": { - "yunohost": ">> 2.5.6" + "yunohost": ">= 4.3.0" }, "multi_instance": true, "services": [ "nginx", - "php5-fpm", + "php7.3-fpm", "mysql" ], "arguments": { - "install" : [ + "install": [ { "name": "domain", - "type": "domain", - "ask": { - "en": "Choose a domain name for Joomla" - }, - "example": "example.com" + "type": "domain" }, { "name": "path", "type": "path", - "ask": { - "en": "Choose a path for Joomla" - }, "example": "/example", "default": "/joomla" }, { - "name": "username", - "ask": { - "en": "Admin username" - }, - "example": "john" - }, - { - "name": "email", - "ask": { - "en": "Admin email" - }, - "example": "admin@example.com" - }, - { - "name": "password", - "type": "password", - "ask": { - "en": "Password for the admin account (At least 6 characters long)" - } + "name": "admin", + "type": "user" }, { "name": "is_public", "type": "boolean", - "ask": { - "en": "Is it a public application?" - - }, "default": true + }, + { + "name": "password", + "type": "password", + "help": { + "en": "Password must be longer than 8 characters." + } } ] } diff --git a/scripts/_common.sh b/scripts/_common.sh index 1e42df9..ecd263f 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,111 +1,20 @@ #!/bin/bash -# ============================================================================= -# YUNOHOST 2.7 FORTHCOMING HELPERS -# ============================================================================= +#================================================= +# COMMON VARIABLES +#================================================= -# Create a dedicated nginx config -# -# usage: ynh_add_nginx_config -ynh_add_nginx_config () { - finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" +# dependencies used by the app +pkg_dependencies="" - sudo cp ../conf/nginx.conf "$finalnginxconf" +#================================================= +# PERSONAL HELPERS +#================================================= - # 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 +#================================================= +# EXPERIMENTAL HELPERS +#================================================= - sudo systemctl reload nginx -} - -# Remove the dedicated nginx config -# -# usage: ynh_remove_nginx_config -ynh_remove_nginx_config () { - ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo systemctl reload nginx -} - -# Create a dedicated php-fpm config -# -# usage: ynh_add_fpm_config -ynh_add_fpm_config () { - finalphpconf="/etc/php5/fpm/pool.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalphpconf" 1 - sudo cp ../conf/php-fpm.conf "$finalphpconf" - ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf" - ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf" - ynh_replace_string "__USER__" "$app" "$finalphpconf" - sudo chown root: "$finalphpconf" - ynh_store_file_checksum "$finalphpconf" - - if [ -e "../conf/php-fpm.ini" ] - then - finalphpini="/etc/php5/fpm/conf.d/20-$app.ini" - ynh_compare_checksum_config "$finalphpini" 1 - sudo cp ../conf/php-fpm.ini "$finalphpini" - sudo chown root: "$finalphpini" - ynh_store_checksum_config "$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 -} - -# Create a dedicated systemd config -# -# usage: ynh_add_systemd_config -ynh_add_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - ynh_compare_checksum_config "$finalsystemdconf" 1 - sudo cp ../conf/systemd.service "$finalsystemdconf" - - # 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 "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__APP__" "$app" "$finalsystemdconf" - fi - ynh_store_checksum_config "$finalsystemdconf" - - sudo chown root: "$finalsystemdconf" - sudo systemctl enable $app - sudo systemctl daemon-reload -} - -# Remove the dedicated systemd config -# -# usage: ynh_remove_systemd_config -ynh_remove_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - if [ -e "$finalsystemdconf" ]; then - sudo systemctl stop $app - sudo systemctl disable $app - ynh_secure_remove "$finalsystemdconf" - fi -} +#================================================= +# FUTURE OFFICIAL HELPERS +#================================================= diff --git a/scripts/backup b/scripts/backup index a62e166..e1d1a34 100644 --- a/scripts/backup +++ b/scripts/backup @@ -2,58 +2,66 @@ #================================================= # GENERIC START -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit on command errors and treat access to unset variables as an error -set -eu - #================================================= # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Get the _common.sh file if it's not in the current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh -fi -source _common.sh +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts +source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -final_path=$(ynh_app_setting_get $app final_path) -domain=$(ynh_app_setting_get $app domain) -db_name=$(ynh_app_setting_get $app db_name) -db_pwd=$(ynh_app_setting_get $app mysqlpwd) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +domain=$(ynh_app_setting_get --app=$app --key=domain) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= -# STANDARD BACKUP STEPS +# DECLARE DATA AND CONF FILES TO BACKUP +#================================================= +ynh_print_info --message="Declaring files to be backed up..." + #================================================= # BACKUP THE APP MAIN DIR #================================================= -ynh_backup "$final_path" "$final_path" +ynh_backup --src_path="$final_path" #================================================= # BACKUP THE NGINX CONFIGURATION #================================================= -ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "/etc/nginx/conf.d/$domain.d/$app.conf" - - +ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= -# BACKUP THE MYSQL DATABASE +# BACKUP THE PHP-FPM CONFIGURATION #================================================= -ynh_mysql_dump_db "$db_name" > db.sql +ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= # SPECIFIC BACKUP #================================================= +# BACKUP LOGROTATE +#================================================= + +ynh_backup --src_path="/etc/logrotate.d/$app" + +#================================================= +# BACKUP THE MYSQL DATABASE +#================================================= +ynh_print_info --message="Backing up the MySQL database..." + +ynh_mysql_dump_db --database="$db_name" > db.sql + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url new file mode 100644 index 0000000..ec27e05 --- /dev/null +++ b/scripts/change_url @@ -0,0 +1,135 @@ +#!/bin/bash + +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +old_domain=$YNH_APP_OLD_DOMAIN +old_path=$YNH_APP_OLD_PATH + +new_domain=$YNH_APP_NEW_DOMAIN +new_path=$YNH_APP_NEW_PATH + +app=$YNH_APP_INSTANCE_NAME + +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading installation settings..." + +# Needed for helper "ynh_add_nginx_config" +final_path=$(ynh_app_setting_get --app=$app --key=final_path) + +# Add settings here as needed by your application +#db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#db_user=$db_name +#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) + +#================================================= +# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. + ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" + + # Restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# CHECK WHICH PARTS SHOULD BE CHANGED +#================================================= + +change_domain=0 +if [ "$old_domain" != "$new_domain" ] +then + change_domain=1 +fi + +change_path=0 +if [ "$old_path" != "$new_path" ] +then + change_path=1 +fi + +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# STOP SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Stopping a systemd service..." + +ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" + +#================================================= +# MODIFY URL IN NGINX CONF +#================================================= +ynh_script_progression --message="Updating NGINX web server configuration..." + +nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf + +# Change the path in the NGINX config file +if [ $change_path -eq 1 ] +then + # Make a backup of the original NGINX config file if modified + ynh_backup_if_checksum_is_different --file="$nginx_conf_path" + # Set global variables for NGINX helper + domain="$old_domain" + path_url="$new_path" + # Create a dedicated NGINX config + ynh_add_nginx_config +fi + +# Change the domain for NGINX +if [ $change_domain -eq 1 ] +then + # Delete file checksum for the old conf file location + ynh_delete_file_checksum --file="$nginx_conf_path" + mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf + # Store file checksum for the new config file location + ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" +fi + +#================================================= +# SPECIFIC MODIFICATIONS +#================================================= +# ... +#================================================= + +#================================================= +# GENERIC FINALISATION +#================================================= +# START SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Starting a systemd service..." + +# Start a systemd service +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" + +#================================================= +# RELOAD NGINX +#================================================= +ynh_script_progression --message="Reloading NGINX web server..." + +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Change of URL completed for $app" diff --git a/scripts/install b/scripts/install index 8cd7863..52df8e4 100644 --- a/scripts/install +++ b/scripts/install @@ -22,141 +22,156 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH -admin_username=$YNH_APP_ARG_USERNAME -admin_email=$YNH_APP_ARG_EMAIL -admin_password=$YNH_APP_ARG_PASSWORD +admin=$YNH_APP_ARG_ADMIN +admin_email=$(ynh_user_get_info $admin 'mail') is_public=$YNH_APP_ARG_IS_PUBLIC +password=$YNH_APP_ARG_PASSWORD - - -# 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 subsequeadmin_email=$YNH_APP_ARG_EMAILnt 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 #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= - -# Normalize the url path syntax -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_script_progression --message="Validating installation parameters..." final_path=/var/www/$app -test ! -e "$final_path" || ynh_die "This path already contains a folder" +test ! -e "$final_path" || ynh_die --message="This path already contains a folder" -# Check password strength -[[ ${#admin_password} -gt 6 ]] || ynh_die \ -"The password is too weak, it must be longer than 6 characters" +# Register (book) web path +ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url #================================================= # STORE SETTINGS FROM MANIFEST #================================================= +ynh_script_progression --message="Storing installation settings..." -ynh_app_setting_set $app domain $domain -ynh_app_setting_set $app path $path_url -ynh_app_setting_set $app is_public $is_public - - +ynh_app_setting_set --app=$app --key=domain --value=$domain +ynh_app_setting_set --app=$app --key=path --value=$path_url +ynh_app_setting_set --app=$app --key=admin --value=$admin #================================================= # STANDARD MODIFICATIONS #================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing dependencies..." + +ynh_install_app_dependencies $pkg_dependencies + +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Configuring system user..." + +# Create a system user +ynh_system_user_create --username=$app --home_dir=$final_path + #================================================= # CREATE A MYSQL DATABASE #================================================= -# If your app uses a MySQL database, you can use these lines to bootstrap -# a database, an associated user and save the password in app settings - -db_name=$(ynh_sanitize_dbid $app) -ynh_app_setting_set $app db_name $db_name -ynh_mysql_setup_db $db_name $db_name +ynh_script_progression --message="Creating a MySQL database..." +db_name=$(ynh_sanitize_dbid --db_name=$app) +db_user=$db_name +ynh_app_setting_set --app=$app --key=db_name --value=$db_name +ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name +db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Setting up source files..." -ynh_app_setting_set $app final_path $final_path +ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source "$final_path" +ynh_setup_source --dest_dir="$final_path" +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= # NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Configuring NGINX web server..." -# Create a dedicated nginx config +# Create a dedicated NGINX config ynh_add_nginx_config +#================================================= +# PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring PHP-FPM..." + +# Create a dedicated PHP-FPM config +ynh_add_fpm_config #================================================= # SPECIFIC SETUP #================================================= +# ADD A CONFIGURATION #================================================= -# COPYING THE CUSTOM INSTALL SCRIPT AND INPUTING THE ARGUMENTS -#================================================= -sudo cp -a ../conf/install.php $final_path/cli/. -php $final_path/cli/install.php \ ---db-user=$db_name \ ---db-name=$db_name \ ---db-pass=$db_pwd \ ---admin-user=$admin_username \ ---admin-pass=$admin_password \ ---admin-email=$admin_email +ynh_script_progression --message="Adding a configuration file..." +ynh_add_config --template="../conf/configuration.php" --destination="$final_path/configuration.php" + +chmod 400 "$final_path/configuration.php" +chown $app:$app "$final_path/configuration.php" + +#================================================= +# SETUP DATABASE +#================================================= +ynh_script_progression --message="Setuping database..." + +ynh_replace_string --match_string="#__" --replace_string="" --target_file="$final_path/installation/sql/mysql/base.sql" +ynh_replace_string --match_string="#__" --replace_string="" --target_file="$final_path/installation/sql/mysql/extensions.sql" +ynh_replace_string --match_string="#__" --replace_string="" --target_file="$final_path/installation/sql/mysql/supports.sql" + +ynh_mysql_execute_file_as_root --file="$final_path/installation/sql/mysql/base.sql" --database=$db_name +ynh_mysql_execute_file_as_root --file="$final_path/installation/sql/mysql/extensions.sql" --database=$db_name +ynh_mysql_execute_file_as_root --file="$final_path/installation/sql/mysql/supports.sql" --database=$db_name + +JUSERID=$[ ( $RANDOM % 100 ) + 1 ] +JPASS="$(echo -n "$password" | md5sum | awk '{ print $1 }' )" +ynh_mysql_execute_as_root --database=$db_name --sql="INSERT INTO \`users\` (\`id\`, \`name\`, \`username\`, \`email\`, \`password\`, \`block\`, \`sendEmail\`, \`registerDate\`, \`lastvisitDate\`, \`activation\`, \`params\`, \`lastResetTime\`, \`resetCount\`, \`otpKey\`, \`otep\`, \`requireReset\`) VALUES ('${JUSERID}', 'Me', '${admin}', '${admin_email}', '${JPASS}', '0', '0', '0000-00-00 00:00:00.000000', '0000-00-00 00:00:00.000000', '', '', '0000-00-00 00:00:00.000000', '0', '', '', '0');" +ynh_mysql_execute_as_root --database=$db_name --sql="INSERT INTO \`user_usergroup_map\` (\`user_id\`, \`group_id\`) VALUES ('${JUSERID}', '8');" +JUSERINC=$((JUSERID+1)) +ynh_mysql_execute_as_root --database=$db_name --sql="ALTER TABLE \`users\` auto_increment = ${JUSERINC};" + +ynh_secure_remove --file="$final_path/installation" #================================================= # GENERIC FINALIZATION #================================================= -# SECURE FILES AND DIRECTORIES +# SETUP LOGROTATE #================================================= +ynh_script_progression --message="Configuring log rotation..." -# Remove the installation folder in the root folder(required by joomla after install) -sudo rm -R $final_path/installation - -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -# Set permissions to app files (requires 774 for folder permissions) -#**********NEEDED TO BE CHECKED********* -sudo find $final_path -type f | xargs chmod 774 -sudo find $final_path -type d | xargs chmod 774 - -#Give root folder www-data ownership -sudo chown -R www-data: $final_path - +# Use logrotate to manage application logfile(s) +ynh_use_logrotate #================================================= # SETUP SSOWAT #================================================= +ynh_script_progression --message="Configuring permissions..." -if [ $is_public -eq 0 ] -then # Remove the public access - ynh_app_setting_delete $app skipped_uris -fi # Make app public if necessary if [ $is_public -eq 1 ] then - # unprotected_uris allows SSO credentials to be passed anyway. - ynh_app_setting_set $app unprotected_uris "/" + # Everyone can access the app. + # The "main" permission is automatically created before the install script. + ynh_permission_update --permission="main" --add="visitors" fi - #================================================= # RELOAD NGINX #================================================= +ynh_script_progression --message="Reloading NGINX web server..." -sudo systemctl reload nginx +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Installation of $app completed" diff --git a/scripts/remove b/scripts/remove index c8dbd8f..bd797e8 100644 --- a/scripts/remove +++ b/scripts/remove @@ -12,34 +12,87 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get $app domain) - -db_name=$(ynh_app_setting_get $app db_name) +domain=$(ynh_app_setting_get --app=$app --key=domain) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +db_user=$db_name +final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= # STANDARD REMOVE #================================================= +# REMOVE LOGROTATE CONFIGURATION +#================================================= +ynh_script_progression --message="Removing logrotate configuration..." + +# Remove the app-specific logrotate config +ynh_remove_logrotate #================================================= # REMOVE THE MYSQL DATABASE #================================================= +ynh_script_progression --message="Removing the MySQL database..." # Remove a database if it exists, along with the associated user -ynh_mysql_remove_db $db_name $db_name +ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name #================================================= # REMOVE APP MAIN DIR #================================================= +ynh_script_progression --message="Removing app main directory..." # Remove the app directory securely -ynh_secure_remove "/var/www/$app" +ynh_secure_remove --file="$final_path" #================================================= # REMOVE NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Removing NGINX web server configuration..." -# Remove the dedicated nginx config +# Remove the dedicated NGINX config ynh_remove_nginx_config + +#================================================= +# REMOVE PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Removing PHP-FPM configuration..." + +# Remove the dedicated PHP-FPM config +ynh_remove_fpm_config + +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_script_progression --message="Removing dependencies..." + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies + +#================================================= +# SPECIFIC REMOVE +#================================================= +# REMOVE VARIOUS FILES +#================================================= +ynh_script_progression --message="Removing various files..." + +# Remove the log files +ynh_secure_remove --file="/var/log/$app" + +#================================================= +# GENERIC FINALIZATION +#================================================= +# REMOVE DEDICATED USER +#================================================= +ynh_script_progression --message="Removing the dedicated system user..." + +# Delete a system user +ynh_system_user_delete --username=$app + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Removal of $app completed" diff --git a/scripts/restore b/scripts/restore index f0c81f4..9d7904a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -2,79 +2,109 @@ #================================================= # GENERIC START -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit on command errors and treat access to unset variables as an error -set -eu - #================================================= # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Get the _common.sh file if it's not in the current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh -fi -source _common.sh +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts +source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get $app domain) -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) +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +db_user=$db_name +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= +ynh_script_progression --message="Validating restoration parameters..." -sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ - || ynh_die "Path not available: ${domain}${path_url}" test ! -d $final_path \ - || ynh_die "There is already a directory: $final_path " + || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS #================================================= # RESTORE THE NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Restoring the NGINX web server configuration..." -ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" - -#================================================= -# RESTORE THE APP MAIN DIR -#================================================= - -ynh_restore_file "$final_path" - -# Set permissions to app files (requires 774 for folder permissions) -#**********NEEDED TO BE CHECKED********* -sudo find $final_path -type f | xargs chmod 774 -sudo find $final_path -type d | xargs chmod 774 -#================================================= -# 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 +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # RECREATE THE DEDICATED USER #================================================= +ynh_script_progression --message="Recreating the dedicated system user..." +# Create the dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir=$final_path +#================================================= +# RESTORE THE APP MAIN DIR +#================================================= +ynh_script_progression --message="Restoring the app main directory..." + +ynh_restore_file --origin_path="$final_path" + +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" + +#================================================= +# RESTORE THE PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the PHP-FPM configuration..." + +ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" + +#================================================= +# SPECIFIC RESTORATION +#================================================= +# REINSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Reinstalling dependencies..." + +# Define and install dependencies +ynh_install_app_dependencies $pkg_dependencies + +#================================================= +# RESTORE THE MYSQL DATABASE +#================================================= +ynh_script_progression --message="Restoring the MySQL database..." + +db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) +ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd +ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql + +#================================================= +# RESTORE THE LOGROTATE CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the logrotate configuration..." + +ynh_restore_file --origin_path="/etc/logrotate.d/$app" + +#================================================= +# GENERIC FINALIZATION #================================================= # RELOAD NGINX AND PHP-FPM #================================================= +ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." -sudo systemctl reload php5-fpm -sudo systemctl reload nginx +ynh_systemd_action --service_name=php$phpversion-fpm --action=reload +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Restoration completed for $app" diff --git a/scripts/upgrade b/scripts/upgrade index 766176f..be81890 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,66 +12,126 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get $app domain) -path_url=$(ynh_app_setting_get $app path) -is_public=$(ynh_app_setting_get $app is_public) -final_path=$(ynh_app_setting_get $app final_path) -db_name=$(ynh_app_setting_get $app db_name) +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +admin=$(ynh_app_setting_get --app=$app --key=admin) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#================================================= +# CHECK VERSION +#================================================= +ynh_script_progression --message="Checking version..." + +upgrade_type=$(ynh_check_app_version_changed) + +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # Restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# STANDARD UPGRADE STEPS #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= - -if [ "$is_public" = "Yes" ]; then - ynh_app_setting_set $app is_public 1 # Fix is_public as a boolean value - is_public=1 -elif [ "$is_public" = "No" ]; then - ynh_app_setting_set $app is_public 0 - is_public=0 -fi - -if [ -z $db_name ]; then # If db_name doesn't exist, create it - db_name=$(ynh_sanitize_dbid $app) - ynh_app_setting_set $app db_name $db_name -fi +ynh_script_progression --message="Ensuring downward compatibility..." #================================================= -# CHECK THE PATH +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Making sure dedicated system user exists..." + +# Create a dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir=$final_path + +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -# Normalize the URL path syntax -path_url=$(ynh_normalize_url_path $path_url) +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Upgrading source files..." + # Download, check integrity, uncompress and patch the source from app.src + ynh_setup_source --dest_dir="$final_path" +fi + +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= # NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Upgrading NGINX web server configuration..." -# Create a dedicated nginx config +# Create a dedicated NGINX config ynh_add_nginx_config +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." +ynh_install_app_dependencies $pkg_dependencies #================================================= -# SETUP SSOWAT +# PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Upgrading PHP-FPM configuration..." + +# Create a dedicated PHP-FPM config +ynh_add_fpm_config + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# ... #================================================= -if [ $is_public -eq 0 ] -then # Remove the public access - ynh_app_setting_delete $app skipped_uris -fi -# Make app public if necessary -if [ $is_public -eq 1 ] -then - # unprotected_uris allows SSO credentials to be passed anyway - ynh_app_setting_set $app unprotected_uris "/" -fi +#================================================= +# UPDATE A CONFIG FILE +#================================================= +ynh_script_progression --message="Updating a configuration file..." + +ynh_add_config --template="../conf/configuration.php" --destination="$final_path/configuration.php" + +chmod 400 "$final_path/configuration.php" +chown $app:$app "$final_path/configuration.php" + +#================================================= +# GENERIC FINALIZATION +#================================================= +# SETUP LOGROTATE +#================================================= +ynh_script_progression --message="Upgrading logrotate configuration..." + +# Use logrotate to manage app-specific logfile(s) +ynh_use_logrotate --non-append #================================================= # RELOAD NGINX #================================================= +ynh_script_progression --message="Reloading NGINX web server..." -sudo systemctl reload nginx +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Upgrade of $app completed" From e433c1cb8ae8b7357af6c6886ce0d81f07779f6a Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 22 Jan 2022 20:56:25 +0100 Subject: [PATCH 3/8] github actions --- .github/ISSUE_TEMPLATE.md | 55 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++ 2 files changed, 71 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2729a6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. + +--- + +**How to post a meaningful bug report** +1. *Read this whole template first.* +2. *Determine if you are on the right place:* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* + - *When in doubt, post here and we will figure it out together.* +3. *Delete the italic comments as you write over them below, and remove this guide.* +--- + +### Describe the bug + +*A clear and concise description of what the bug is.* + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* + +### Steps to reproduce + +- *If you performed a command from the CLI, the command itself is enough. For example:* + ```sh + sudo yunohost app install the_app + ``` +- *If you used the webadmin, please perform the equivalent command from the CLI first.* +- *If the error occurs in your browser, explain what you did:* + 1. *Go to '...'* + 2. *Click on '...'* + 3. *Scroll down to '...'* + 4. *See error* + +### Expected behavior + +*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* + +### Logs + +*When an operation fails, YunoHost provides a simple way to share the logs.* +- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* +- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* + +*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* + +*If applicable and useful, add screenshots to help explain your problem.* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) From 7e2d08508fe1bcdba583b5fcc509e30efca7271d Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jan 2022 12:58:04 +0100 Subject: [PATCH 4/8] Apply example_ynh --- README.md | 37 +++++++++---------------------------- scripts/backup | 10 ++++++++++ scripts/change_url | 15 --------------- scripts/restore | 10 ++++++++++ scripts/upgrade | 2 ++ 5 files changed, 31 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 991ebbe..2990885 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,11 @@ -# Joomla_ynh -[![Install Joomla with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=joomla) +# Joomla for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) +[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) + +> *This package allows you to install example quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* + +## Overview Joomla! is an award-winning content management system https://www.joomla.org/
Version: 4.0.6

- -

Why Joomla?

-

Hundreds of developers have been improving Joomla! since the first version was released in 2005. This immense effort has made Joomla! very popular, easy to use, stable and secure. See for more details:https://www.joomla.org/3/


- -Note:There is installer.php added for bypassing the web installation process. see https://github.com/joomla/joomla-cms/pull/2764 - -# Ldap configuration (For now you have to configure it youeself) -Enable ldap plugin
-Enter the following feilds:
-**Host:** localhost
-**Port**:389
-**LdapV3:** Yes
-**Authorisation Method:** Bind and search
-**Base DN:** dc=yunohost,dc=org
-**uid:** uid=[search]
-**User's DN:** ou=users,dc=yunohost,dc=org
-**Map Full Name:** displayname
-**Map Email:** mail
-**Map User ID:** uid
- -# To-do -- [X] Installation and remove script. -- [ ] Ldap integration. -- [ ] Make update script better for updation from sources. -- [X] Backup and restore script. -- [ ] Add php-fpm.ini and php-fpm.conf(for the red error message in admin panel). diff --git a/scripts/backup b/scripts/backup index e1d1a34..4cf0ae1 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,6 +10,16 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +ynh_clean_setup () { + true +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # LOAD SETTINGS #================================================= diff --git a/scripts/change_url b/scripts/change_url index ec27e05..213ce6c 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -69,13 +69,6 @@ fi #================================================= # STANDARD MODIFICATIONS -#================================================= -# STOP SYSTEMD SERVICE -#================================================= -ynh_script_progression --message="Stopping a systemd service..." - -ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" - #================================================= # MODIFY URL IN NGINX CONF #================================================= @@ -113,14 +106,6 @@ fi #================================================= # GENERIC FINALISATION -#================================================= -# START SYSTEMD SERVICE -#================================================= -ynh_script_progression --message="Starting a systemd service..." - -# Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" - #================================================= # RELOAD NGINX #================================================= diff --git a/scripts/restore b/scripts/restore index 9d7904a..112b5be 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,6 +10,16 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +ynh_clean_setup () { + true +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # LOAD SETTINGS #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index be81890..c9fb8b9 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -21,6 +21,8 @@ path_url=$(ynh_app_setting_get --app=$app --key=path) admin=$(ynh_app_setting_get --app=$app --key=admin) final_path=$(ynh_app_setting_get --app=$app --key=final_path) db_name=$(ynh_app_setting_get --app=$app --key=db_name) +db_user=$db_name +db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) #================================================= # CHECK VERSION From 1fec1bbd4ad8616f8844738b1db86df7304f119f Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jan 2022 15:45:16 +0100 Subject: [PATCH 5/8] Update manifest.json --- manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index 2d9f807..33d2a42 100644 --- a/manifest.json +++ b/manifest.json @@ -3,7 +3,7 @@ "id": "joomla", "packaging_format": 1, "description": { - "en": "Joomla! is an award-winning content management system." + "en": "A content management system." }, "version": "4.0.6~ynh1", "url": "https://www.joomla.org", From f3d0c2e0431eba7a94b5aecea9a18579a7e900d5 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jan 2022 15:48:40 +0100 Subject: [PATCH 6/8] Update DESCRIPTION.md --- doc/DESCRIPTION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index c0325e1..adc27ba 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1 +1 @@ -Joomla! is a free and open-source content management system (CMS) for publishing web content. Over the years Joomla! has won several awards. It is built on a model–view–controller web application framework that can be used independently of the CMS that allows you to build powerful online applications. +Joomla! is a free and open-source content management system (CMS) for publishing web content. Over the years Joomla! has won several awards. It is built on a model–view–controller web application framework that can be used independently of the CMS that allows you to build powerful online applications. From 44d13e354e5f255593c31ddc65ff5db6d4b9f422 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jan 2022 15:49:16 +0100 Subject: [PATCH 7/8] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2990885..ffb7457 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Joomla for YunoHost -[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Integration level](https://dash.yunohost.org/integration/joomla.svg)](https://dash.yunohost.org/appci/app/joomla) ![](https://ci-apps.yunohost.org/ci/badges/joomla.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/joomla.maintain.svg) +[![Install Joomla with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=joomla) -> *This package allows you to install example quickly and simply on a YunoHost server. +> *This package allows you to install Joomla quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview From a43744336cfe65a6098f1bafa5c57febb11cf6b7 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Sun, 23 Jan 2022 14:49:21 +0000 Subject: [PATCH 8/8] Auto-update README --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++-- README_fr.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 107 insertions(+), 2 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index ffb7457..5660c15 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,60 @@ + + # Joomla for YunoHost -[![Integration level](https://dash.yunohost.org/integration/joomla.svg)](https://dash.yunohost.org/appci/app/joomla) ![](https://ci-apps.yunohost.org/ci/badges/joomla.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/joomla.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/joomla.svg)](https://dash.yunohost.org/appci/app/joomla) ![](https://ci-apps.yunohost.org/ci/badges/joomla.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/joomla.maintain.svg) [![Install Joomla with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=joomla) +*[Lire ce readme en français.](./README_fr.md)* + > *This package allows you to install Joomla quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -Joomla! is an award-winning content management system https://www.joomla.org/
Version: 4.0.6

+Joomla! is a free and open-source content management system (CMS) for publishing web content. Over the years Joomla! has won several awards. It is built on a model–view–controller web application framework that can be used independently of the CMS that allows you to build powerful online applications. + + +**Shipped version:** 4.0.6~ynh1 + + + +## Disclaimers / important information + +# Ldap configuration (For now you have to configure it youeself) +Enable ldap Extension
+Enter the following feilds:
+**Host:** localhost
+**Port**:389
+**LdapV3:** Yes
+**Authorisation Method:** Bind and search
+**Base DN:** dc=yunohost,dc=org
+**uid:** uid=[search]
+**User's DN:** ou=users,dc=yunohost,dc=org
+**Map Full Name:** displayname
+**Map Email:** mail
+**Map User ID:** uid
+ +## Documentation and resources + +* Official app website: https://www.joomla.org/ +* Official admin documentation: https://docs.joomla.org/ +* Upstream app code repository: https://github.com/joomla/joomla-cms +* YunoHost documentation for this app: https://yunohost.org/app_joomla +* Report a bug: https://github.com/YunoHost-Apps/joomla_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/joomla_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/joomla_ynh/tree/testing --debug +or +sudo yunohost app upgrade joomla -u https://github.com/YunoHost-Apps/joomla_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..435f936 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,56 @@ +# Joomla pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/joomla.svg)](https://dash.yunohost.org/appci/app/joomla) ![](https://ci-apps.yunohost.org/ci/badges/joomla.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/joomla.maintain.svg) +[![Installer Joomla avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=joomla) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Joomla rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Joomla! is a free and open-source content management system (CMS) for publishing web content. Over the years Joomla! has won several awards. It is built on a model–view–controller web application framework that can be used independently of the CMS that allows you to build powerful online applications. + + +**Version incluse :** 4.0.6~ynh1 + + + +## Avertissements / informations importantes + +# Ldap configuration (For now you have to configure it youeself) +Enable ldap Extension
+Enter the following feilds:
+**Host:** localhost
+**Port**:389
+**LdapV3:** Yes
+**Authorisation Method:** Bind and search
+**Base DN:** dc=yunohost,dc=org
+**uid:** uid=[search]
+**User's DN:** ou=users,dc=yunohost,dc=org
+**Map Full Name:** displayname
+**Map Email:** mail
+**Map User ID:** uid
+ +## Documentations et ressources + +* Site officiel de l'app : https://www.joomla.org/ +* Documentation officielle de l'admin : https://docs.joomla.org/ +* Dépôt de code officiel de l'app : https://github.com/joomla/joomla-cms +* Documentation YunoHost pour cette app : https://yunohost.org/app_joomla +* Signaler un bug : https://github.com/YunoHost-Apps/joomla_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/joomla_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/joomla_ynh/tree/testing --debug +ou +sudo yunohost app upgrade joomla -u https://github.com/YunoHost-Apps/joomla_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file