Joomla! Documentation - User contributions [en]

How do I use Gmail as my mail server?

2025-01-07T05:24:36Z

Toivo: Corrected link to ASP page that Google has changed

If you have a working Gmail account you can use Gmail as your mail server by setting it in the Global Configuration.

On the server tab set the following:

*Mailer: SMTP
*SMTP Host: smtp.gmail.com
*SMTP Port 465
*SMTP Security: SSL/TLS
*SMTP Authentication: Yes
*Set the next two lines with your information. Use an app-specific password (ASP), described below.
*SMTP Username: your Gmail username
*SMTP Password: the app-specific password (ASP) you generated, described below.

The following are also working combinations:
*SMTP Port 587
*SMTP Security: STARTTLS

*SMTP Port 25
*SMTP Security: STARTTLS

The SSL module does not need to be enabled in Apache.

The OpenSSL extension needs to be enabled in PHP. The details can be found at the [https://www.php.net/manual/en/openssl.installation.php php.net Installation page].

If you are using WAMP on Windows, the ''openssl'' module is not enabled by default and you need to enable it:
# Open the ''php.ini'' file and uncomment the line <code>extension=php_openssl.dll</code> by removing the semicolon ; from the beginning of the line.
# Save the ''php.ini'' file and restart the Apache service.

{{tip|title=Note|Note that if you use 2-step verification in Gmail, add a new password in Settings - Accounts - Change accounts settings - Other Google Account settings - Security - 2-step verification - Manage your application specific passwords.}}

When the new Application-Specific Password (ASP) is presented in groups of four characters separated by spaces, make sure that you do '''not''' enter the spaces into the SMTP password in the mail server settings in Joomla.

* Application Specific Passwords (ASPs): See the Google Support [https://support.google.com/accounts/answer/185833?hl=en Sign in with App Passwords] page.
* 2-Step Verification: See the Google Support [https://support.google.com/accounts/answer/185839 Turn on 2-Step Verification] page.

<noinclude>[[Category:FAQ]][[Category:Server configurations]]</noinclude>

Creating a language definition file

2023-12-01T21:29:50Z

Toivo: Note about value limited to one line with no hard linebreaks.

<noinclude><languages /></noinclude>
{{Joomla version|version=3.x|comment=<translate>
series</translate>}}
{{-}}

<translate>

Joomla! language definition files are written in the very basic ''[[wikipedia:INI file|INI file format]]''. They must be saved using the ''UTF-8'' encoding. Blank lines and lines beginning with a semicolon (;) are ignored and the latter may be used to add comments to the file. Each line consists of a key-value pair separated by an equals sign:
</translate>

<source lang="ini">
<translate>
KEY="value"
</translate>
</source>

<translate>

where <code>KEY</code> is a string to be translated and <code>value</code> is the translated string. For example:
</translate>

<source lang="ini">
<translate>
ADDITIONAL_INFORMATION="Additional Information"</translate>
</source>

<translate>

Different versions of Joomla have used slightly different ways to read language files (namely a custom parser and the native PHP INI parser, the latter of which was buggy in PHP 5.2 and older), leading to different rules for what exactly is allowed in keys and values. Language files that abide by the following rules should work under many versions of Joomla, but at least on Joomla {{jver|3.x}} and newer.
</translate>

<translate>

The <code>KEY</code> should only use ASCII characters. It should only contain capital letters, digits, underscores and hyphens, and it should start with a capital letter. Dots (.) are formally allowed, but do not appear to be completely supported. It is a convention to replace any whitespace in the string to be translated with underscores. If more than one entry has the same key, the last one to be encountered is the one that will be used. When you use the key in a <code>JText::_</code> call, the case does not matter as strings are folded to upper case before searching takes place. So <code>additional_information</code>, <code>Additional_Information</code> or even <code>AdDiTiOnAl_InFoRmAtIoN</code> will be matched.
</translate>

<translate>

The <code>value</code> should always be surrounded by double-quote characters ("), as in the example. The value itself cannot include double-quote characters, although single-quote characters (') are valid. Use <code>\</code>, ''including the double quotes'', to place a double-quote character in your value. For example, to attach the value <code><nowiki><span class="red">Warning!</span></nowiki></code> to the key <code>WARNING_TEXT</code>, use following line:
</translate>

<source lang="ini">
WARNING_TEXT="<span class=\"red\">Warning!</span>"
</source>

<translate>

Note that these rules are stricter than required by the [https://www.php.net/manual/en/function.parse-ini-file.php PHP INI parser]. For example, the PHP INI parser allows you to omit the double quotes around the value as long as it does not contain certain characters. Using the rules above should make it much easier to avoid mistakes such as forgetting double quotes when they '''are''' required.
</translate>

Note also that from Joomla 4.4.1 and 5.0.1 each value can only be one line of text. Hard linebreaks invalidate the whole language definition file.

<noinclude>
----
<references/>
<translate>

[[Category:Tutorials]]
[[Category:Language Development]]
</translate>
</noinclude>

User Group List form field type

2022-10-12T07:40:55Z

Toivo: Usergrouplist standard form field type

<noinclude><languages /></noinclude>
<translate>
The '''usergrouplist''' form field type provides a dropdown select box of user groups.</translate>
<translate>
* '''type''' (mandatory) must be ''usergrouplist''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the field. This must match the name of the query results column that contains the values that will be shown to the user in the drop-down list, unless a different name is specified in the ''value_field'' attribute.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
<translate>
* '''layout''' (optional) (translatable) is the layout, for example joomla.form.field.list-fancy-select.</translate>
<translate>
* '''checksuperusergroup''' (optional) is boolean to omit Super User groups. Values 1 or 0.</translate>
<translate>
* '''default''' (optional) is the usergroup id of the default selection in the dropdown list. If omitted the width is determined by the browser.</translate>
<translate>
* '''multiple''' (optional) If set to ''true'' then allows more than one usergroup to be selected.</translate>

<translate>
Implemented by:</translate> <tt>libraries/src/Form/Field/UsergrouplistField.php</tt>

<translate>
Example of usergrouplist form field definition:</translate>

<source lang="xml">
<field
name="usergroup"
type="UserGroupList"
label="MOD_EXAMPLE_USERGROUP_LABEL"
description="MOD_EXAMPLE_USERGROUP_DESC"
layout="joomla.form.field.list-fancy-select"
checksuperusergroup="1"
default=""
multiple="0"
>
<option value="0">MOD_EXAMPLE_SELECT</option>
</field>
</source>

<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Standard form field types|List of standard form field types]]</translate>

<noinclude>
<translate>

[[Category:Standard form field types]]
</translate>
</noinclude>

User:Toivo

2022-09-21T21:19:27Z

Toivo: /* My testing subpages */

My name is Toivo and if you want to get in touch with me, post on my '''[[User_talk:{{PAGENAME}}|talk page]]'''.

==My testing subpages==
<splist/>

Created tutorials how to debug SMTP mail in Joomla 3 and Joomla 4:

[[How_to_debug_SMTP_mail_in_Joomla_3|How to debug SMTP mail in Joomla 3]]

[[How_to_debug_SMTP_mail_in_Joomla_4|How to debug SMTP mail in Joomla 4]]

How to debug SMTP mail in Joomla 4

2022-09-16T08:08:44Z

Toivo: Tutorial how to debug SMTP mail connection in Joomla 4 at protocol level.

Enable the plugin 'System - Debug' and configure it with the following setting, which restricts the debug output to your own login session at both the back end and the front end. If you do not want to login to the front end as Super User, create a unique user group for your testing activities and select that user group from the list of allowed user groups:

*Allowed Groups: Super Users

Save this setting.

Go to Global Configuration - System tab - Debug and set 'Debug System' to Yes.

Go to the Global Configuration - Server tab and make sure the level of error reporting is set to 'Maximum'.

Go to the Global Configuration - Logging tab and make a note of the contents of 'Path to Log Folder', usually [something]/administrator/logs and also select 'Log Almost Everything'.
Go to the section Custom logging and the field 'Log Categories'. Enter 'mail' (without quotation marks) into this field.

Save the settings.

While still in Global Configuration and the Server tab, press 'Send Test Email'. Alternatively, log in to the front end using your user name in the unique user group meant for testing activities and perform the function that will send an email.

Once the testing is finished, download the log file administrator/logs/everything.php. If the website was migrated from Joomla 2.5, the log file everything.php may reside in the logs folder at the top level of the Joomla folder.

<noinclude>[[Category:FAQ]][[Category:Debugging]]</noinclude>

How to debug SMTP mail in Joomla 3

2022-09-16T07:41:39Z

Toivo: Tutorial how to debug SMTP mail connection in Joomla at protocol level.

Go to Extensions - Plugins and configure the plugin 'System - Debug' with the following settings:

*Allowed Groups: Super Users
*Log Priorities: All
*Log Categories: mail
*Log Almost Everything

Go to Global Configuration - System and turn on the option 'Debug System'.
Then go to the Server tab and Mail Settings.
Click the button 'Send Test Mail'.
If the send function reports an error, you will find the details of the SMTP connection requests from Joomla and responses from the mail server, including the error codes, from the log file, usually administrator/logs/everything.php. If the website was updated from Joomla 2.5, the log file is logs/everything.php at the top level of the Joomla folder.

<noinclude>[[Category:FAQ]]</noinclude>
<noinclude>[[Category:Debugging]]</noinclude>

User:Toivo

2022-09-16T07:15:21Z

Toivo: This is my new user page.

My name is Toivo and if you want to get in touch with me, post on my '''[[User_talk:{{PAGENAME}}|talk page]]'''.

==My testing subpages==
<splist/>

Planning to create a tutorial how to debug SMTP mail.

J4.x:Cassiopeia Template Folders and Files

2022-03-12T07:23:39Z

Toivo: updated js file type from css to js

<noinclude>{{Joomla version|version=4.x}}</noinclude>
== Introduction ==

Newcomers to Joomla, sometimes new to PHP too, may know little of the architecture of a Joomla website and how it all comes together to present a website to the end user. That was me in 2010! However, having arrived here you will realise that Cassiopeia is a Site Template that controls the appearance of a site as seen by the general public. Administrators use a different template, Atum, with a completely different appearance. These templates are sometimes referred to as front-end and back-end templates.

A template is a Joomla extension that consists of a collection of files that take care of different aspects of the presentation. A website may have a number of site templates, one of which must be chosen as the default template used by all pages unless another specific template is selected for a specific page. And site templates may be present but unused.

This tutorial explains the use of the various files in the default Cassiopeia site template.

== Changes from Joomla 4.0 to Joomla 4.1 ==

Joomla 4.1 has moved the default media files from the templates folder to the media/templates folder. Existing media folders are moved on upgrade.

== File Structure ==

The following illustration shows the folder structure of the Cassiopeia template, including the files in the template root.

{| class="wikitable"
|-
! Joomla 4.0 !! Joomla 4.1
|-
| [[File:j4x-cassiopeia_template_explained_file_structure.png|Joomla 4.0 File Structure]] || [[File:j4x-cassiopeia_template_explained_file_structure_41.png|Joomla 4.1 File Structure]]
|}

A lot to explain! A brief starter explanation:

* css - the folder containing all of the template CSS files
* html - a folder containing component and module overrides, which may be empty
* images - a folder for images used by the template and its styles
* js - a folder for JavaScript used by the template
* scss - a folder for the scss files compiled to make the CSS files
* component.php - a layout used to display just a component without surrounding modules
* error.php - a simple layout used to display errors when a normal page cannot be displayed
* index.php - the layout used for all site pages using this template
* joomla.asset.json - a file specifying where to find CSS and JavaScript resources
* offline.php - a layout used to show a site is off-line for maintenance
* template_preview.php and template_details.php - images used for administration
* templateDetails.xml - the extension specification used for installation

Where to start?

== index.php ==

You are probably aware that a very simple HTML page looks like this:

<source lang="php">
<html>
<head>
</head>
<body>
<h1>Hello World!</h1>
<p>Message of the day.</p>
</body>
</html>
</source>

That is what is in index.php except that it is a little more complicated. Have a look through the file with a text editor and note the following:

* The first executable statement is '''defined('_JEXEC') or die;''' - every Joomla PHP file starts like that to prevent calling directly via an absolute URL. _JEXEC is defined when a page is accessed via mydomain.com/[site-root/]index.php (usually with index.php left off as that is used by default).
* The actual HTML output starts with '''<!DOCTYPE html>''' on line 127 - everything before that is PHP code to set needed variables.
* The head and the body contain '''jdoc:include''' statements that cause insertion of specific types of content - more on that later.
* The body contains landmarks such as header, main, and footer - accessibility features.
* The overall layout is achieved with grids - included only where the grid positions actually include modules.

=== Favicons ===

Favicons are the small icons that appear in the browser tab alongside your site name. Near the top of index.php are three instructions to load favicons into the page:
<source lang="php">
// Browsers support SVG favicons
$this->addHeadLink(HTMLHelper::_('image', 'joomla-favicon.svg', '', [], true, 1), 'icon', 'rel', ['type' => 'image/svg+xml']);
$this->addHeadLink(HTMLHelper::_('image', 'favicon.ico', '', [], true, 1), 'alternate icon', 'rel', ['type' => 'image/vnd.microsoft.icon']);
$this->addHeadLink(HTMLHelper::_('image', 'joomla-favicon-pinned.svg', '', [], true, 1), 'mask-icon', 'rel', ['color' => '#000']);
</source>

Joomla will look for the favicons first in cassiopeia/images - they are not there so Joomla will look in media/system/images - they are there so Joomla will load the URLs for the images there. If you want to use your own favicons rather than Joomla favicons you upload them to cassiopeia/images. They will not be affected by any update to the Cassiopeia template.

=== Template Variables ===

If you look through the template you will find lines containing $this->params->get(...) like this one:

<source lang="php">
$paramsColorName = $this->params->get('colorName', 'colors_standard');
</source>

Those parameters are set in the Advance tab of the Template: Edit Style page. That is where you can change the brand, logo, colour, layout, etc. The variables are defined in the templateDetails.xml file.

=== The Web Asset Manager ===

Notice the line near the top of index.php that creates an instance of the web asset manager and later lines that use it:

<source lang="php">
$wa = $this->getWebAssetManager();
...
$wa->registerAndUseStyle($assetColorName, $templatePath . '/css/global/' . $paramsColorName . '.css');
</source>

Joomla uses information in joomla.asset.json to load assets needed by the template. A portion of that file is shown here:

<source lang="php">
{
"$schema": "https://developer.joomla.org/schemas/json-schema/web_assets.json",
"name": "cassiopeia",
"version": "4.0.0",
"description": "This file contains details of the assets used by Cassiopeia, the default Joomla 4 site template.",
"license": "GPL-2.0-or-later",
"assets": [
{
"name": "template.cassiopeia.ltr",
"description": "The css file to be used when the site is left to right (LTR).",
"type": "style",
"uri": "template.min.css",
"dependencies": [
"fontawesome"
]
},
</source>

It shows that the asset named template.cassiopeia.ltr is to be found in in css/template.min.css and that asset in turn requires fontawesome, defined at the end of joomla.assets.json. Note that if you switch to debug mode Joomla will load the versions of CSS and JavaScript without the .min part.

=== The jdoc Statements ===

At some point during page creation the template index.php file is parsed (analysed) by the Joomla code and the jdoc statements picked out in reverse order. Each jdoc statement leads to code to generate a block of HTML to replace that statement. Amongst other things, that puts module content into the page.

== The css Files ==

The css folder contains the CSS files used by the Cassiopeia template. It is worth noting the file sizes of the different variants of a single CSS style sheet. For example template.css has these varieties:

* template.css 258,272 bytes
* template.min.css 205,427 bytes
* template.min.css.gz 32,526 butes

The first, template.css is a human-readable variant that is used when system debugging is enabled. The second, template.min.css is used on production sites where debugging is disabled. It has all white space removed and some optimisations made. The third, template.min.css.gz is a Gzip compressed variant of the min version used if the site .htaccess file is set up to offer Gzip variants of static resources. There is an article describing how do this in the [https://magazine.joomla.org/all-issues/december-2021/joomla-performance-tuning-ii-basic-settings Community Magazine].

Clearly the gz version is the most network bandwidth friendly.

=== user.css ===

Absent from the initial list of CSS files is user.css. This is a file that you create yourself to contain additions and overrides to the existing styles. For example, module parameters typically include a Module Class text entry box in the Advanced tab. Any module class you add there should have an entry in user.css. If you wish to override an existing style you can make an entry like this:

<source lang="php">
h1, .h1 {
color: purple;
}
</source>

== The html Files ==

This is the place to keep module, component, plugin and layout template overrides. For example, when Joomla renders a module it first looks for a template here and then in the modules own tmpl folder. This allows you to override the appearance of a core Joomla extension or a third party extension without changing the original code. Any changes made there would be overwritten by an update.

The default Cassiopeia template comes with overrides for layouts, mod_custom, mod_menu and tinymce.

== The js Files ==

There is only one basic JavaScript file used by the template and like CSS it comes in three varieties: template.js, template.min.js and template.min.js.gz. There is one other variety of interest: template.es5.js, which is coded for EcmaScript 5 (the 2011 version). All of the other JavaScript files are coded for later EcmaScript versions.

EcmaScript is currently up to Version 12 but it takes a while for browsers to catch up and adopt a new standard. JavaScript is a synonym for EcmaScript. See [https://en.wikipedia.org/wiki/ECMAScript Wikipedia] for a summary.

== The scss Files ==

The scss files contain the sources used to create the CSS files. They need to be compiled with a third party compiler. More...

== Template Positions ==

The positions in which modules can be placed are named in the templateDetails.xml file:

<source lang="xml">
<positions>
<position>topbar</position>
<position>below-top</position>
<position>menu</position>
<position>search</position>
<position>banner</position>
<position>top-a</position>
<position>top-b</position>
<position>main-top</position>
<position>main-bottom</position>
<position>breadcrumbs</position>
<position>sidebar-left</position>
<position>sidebar-right</position>
<position>bottom-a</position>
<position>bottom-b</position>
<position>footer</position>
<position>debug</position>
</positions>
</source>

The following illustration shows in schematic form where those positions occur on the page:

[[File:j4x-cassiopeia_template_explained_positions.png|Template Positions]]

Notice the '''component''' position marked with a green background. That is where the output from a component view is placed and is often the largest portion of the page. Immediately above that is the message position where Joomla system messages appear. For example, ''Your changes have been saved''.

The illustration shows that some of the positions are within landmarks such as '''header''' and '''footer''' but others are not. Something to look into!

With the sample data installed, the following illustration shows the Home page landmarks in the browser tools '''Inspector''' view.

[[File:j4x-cassiopeia_template_explained_inspector_landmarks.png|Template Landmarks]]

The header contains a '''brand''' location, not a position to which a module can be assigned. It can be left out. Beneath that is a '''menu''' and/or '''search''' position. It is used for the site menu and search box.

The contents of the remaining divs are self-evident from their class names. There is no container-sidebar-left because the sample data does not assign any module to that position.

== Further Information ==

* [[J4.x:Cassiopeia Template Customisation|Cassiopeia Template Customisation]] - using the Edit Style form and user.css
* [[J4.x:Cassiopeia Template Simplified - A Case Study|Cassiopeia Template Simplified - A Case Study]] - a simple template based on Cassiopeia

<noinclude>
[[Category:Tutorials]]
[[Category:Joomla! 4.x]]
</noinclude>

J4.x:Installing Joomla

2020-12-08T14:36:40Z

Toivo: minimum sizes from 20M to 30M

<noinclude><languages /></noinclude>
<translate>

Installing Joomla! for the first time is very easy. Joomla!’s built-in web installer makes setting up your new site a breeze.

== Requirements == 
=== Hosting Requirements ===
Before we start installing Joomla!, there are a couple prerequisites that need to be met to install Joomla! {{ns}} successfully. These apply whether you have a dedicated server, a shared hosting plan server, or are installing a copy on a local computer for testing or development.


You’ll need to meet the following [https://downloads.joomla.org/technical-requirements requirements] to install and use Joomla!</translate>

=== <translate>

References</translate> ===
<references/>
<translate>
==== Recommended PHP.ini Settings ==== 
There are some PHP settings that need to be sufficient for Joomla to install. The settings are usually in a "php.ini" or "user.ini". Talk to your host about how to change theses settings if it is possible to do so. If working on a localhost e.g. with [[S:MyLanguage/XAMPP|XAMPP]], you should not be restricted by these settings and VPS or dedicated hosting should also not be as restrictive.


The values for PHP.ini below are ''suggested values'' only.


* memory_limit - '''Minimum:''' 64M '''Recommended:''' 128M or better
* upload_max_filesize - '''Minimum:''' 30M
* post_max_size - '''Minimum:''' 30M
* max_execution_time: '''Recommended:''' 30
</translate>
<translate>
== Prepare for Install == 
You will need to complete two tasks before you can install Joomla! on your server. First, you will need to download the Joomla! package files. Next, you will need to have a database for Joomla! use.

=== Downloading and Uploading Joomla! Package Files ===  </translate>
{{warning|title=<translate>

Warning!</translate>| <translate> Currently Joomla 4 is in development and so here we are linking you to the nightly builds. These occasionally can be unstable. When Joomla {{ns}} is officially released - stable releases will be available as normal on</translate> [https://downloads.joomla.org]}}
#<translate>

Download the current nightly release of</translate> [https://developer.joomla.org/nightly-builds.html Joomla! {{ns}}]
<translate>

#Move the downloaded Joomla! installation package to the server. Use a [[wikipedia:FTP Client|FTP Client]] to transfer the Joomla! {{ns}} files to your server. There are several available for use, here is a detailed [[wp:Comparison_of_FTP_client_software|list of FTP Clients]]. Please make sure you are using a FTP client's official release.
:: Hint - This can be accomplished by simply moving the downloaded package to your server, then unpacking it. Or you can unpack the files on your local computer, then move the Joomla installation over to your server. Either way, the Joomla installation needs to be unpacked in the root of your site.</translate>

{{tip|text=<translate>

Normally you upload your web files to the root folder. This is typically named "public_html" but other variations include "htdocs" and this depends on what your host has the set up on the server. For Joomla purposes, you can load the files directly into "public_html" or a sub-folder within it.</translate>|title=<translate>

Your Server's "root" Folder</translate>}}

{{warning|title=<translate>

Warning!</translate>|<translate>

If you unpack the files on your own computer, then copy them to your server, be sure to move only the folders and files contained '''INSIDE''' the Joomla! package. If you unpack the folders and files into a folder, for example called,</translate> <code>''Joomla''</code> <translate>

and then upload that folder, your site will have to be accessed at</translate> <code>''yoursitename.com/Joomla''</code> <translate>

instead of</translate> <code>''yoursitename.com''</code>.}}

=== <translate>

Database for Joomla! Installation</translate> ===
<translate>

#If you need to create a database, please read "'''[[S:MyLanguage/Creating a Database for Joomla!|Create a database for use with Joomla!]]'''" first or skip to step #2.
#You will need to note basic database information needed when the actual Joomla! installation is started.
#* Location of database, localhost? Or a specific host's server such as <code>''dbserver1.yourhost.com''</code>?
#* The database name
#* The database user's name
#* The database user's password

== Start Install == 
=== Main Configuration ===
With the above requirements met, a database created and the required Joomla! files in place, you are ready to install Joomla!. Start the Joomla! web installer by opening your favorite browser and browsing to the site's domain name. On host installation you will use</translate> <code>''<nowiki>http://www.yoursitename.com</nowiki>''</code>. <translate>

If your are installing Joomla! locally, you will use</translate> <code>''<nowiki>http://localhost/</nowiki><<translate>

path to Joomla files</translate>>''</code>, <translate>

and you should see the installation screen</translate>.
<div style="clear:both; max-width:100%; height:auto; display:inline-block; float:right; margin-left:.3em;">[[File:<translate>

J4x_Installation_screen_page_1.png</translate>|border|left|500px]]</div>

<translate>

Joomla! will try to identify the '''Select Language''' field automatically from your browser's language. You can change this if needed.


Fill in the following information.
*'''Site Name''': the name of your website — this can be changed at any point later in the [[S:MyLanguage/Help40:Site_Global_Configuration#Site|Site Global Configuration]] page.


When everything on the first page is completed, click the '''Setup Login Data''' button to proceed:</translate>

{{-}}

<translate>== Login Data == 
You should now see the login data screen</translate>.
<div style="clear:both; max-width:100%; height:auto; display:inline-block; float:right; margin-left:.3em;">[[File:<translate>

J4x_Installation_screen_page_2.png</translate>|border|left|500px]]</div>

<translate>

Fill in the following information.
*'''Admin Name''': the name of the admin. This how Joomla will greet you when you log in!
*'''Admin Username''': Joomla! uses a default "admin" as the username for the '''Super User'''. You can leave it as is, change it now (which a good [[S:MyLanguage/Security_Checklist/Joomla!_Setup#Change the default administrator username|Security measure]]) or use [[S:MyLanguage/Help40:Site_My_Profile|My Profile]] in the ''Administration'' interface to change it later.
*'''Admin Password''': remember that super user has maximum control of the site (frontend & backend), so try to use a difficult password. Use [[S:MyLanguage/Help40:Site_My_Profile|My Profile]] in the ''Administration'' interface to change it later. Confirm the password in the '''Confirm Admin Password''' box.
*'''Admin Email Address''': the admin email address. Enter a valid email in case you forget your password. This is the email address where you'll receive a link to change the admin password.


When everything on the second page is completed, click the '''Setup Database Connection''' button to proceed:</translate>
{{-}}

<translate>== Database Configuration == 
=== Configuration Settings ===
You will need to enter the information about the database you will use for Joomla! now. It was suggested to write this information down under "'''Prepare for Install'''" tab. You may also read or review [[S:MyLanguage/Creating a Database for Joomla!|Creating a Database for Joomla!]].</translate>
<div style="clear:both; max-width:100%; height:auto; display:inline-block; float:right; margin-left:.5em;">[[File:<translate>

J40_Installation_screen_page_3.png</translate>|border|left|500px]]</div>

<translate>

For simplification, these instructions are a reference to installing with a [[wikipedia:MySQLi|MySQLi]] database. The instructions on the installation page are self explanatory, but here they are again:
* '''Database Type''': MySQLi is the common database used
* '''Hostname''' Where is your database located? Common is <code>''localhost''</code>, but some hosts use a specific database server such as</translate> <code>''dbserver1.yourhost.com''</code>
<translate>

* '''Username''': the username used to connect to the database
* '''Password''': the password for the database's username
* '''Database Name''': the name of the database
* '''Table Prefix''': one is generated automatically, but you can change it. For example, <code>jos3_</code> can be used. Just don't forget to put the underscore character</translate> (<code>_</code>) <translate>

at the end of the prefix.
* '''Connection Encryption''': specifies how the connection to the database should be encrypted. If you don't know - then it's best to stick to the default. However this allows enterprises who two way SSL encryption to the database to provide it.</translate>

<translate>

All these choices and more can be edited on the [[S:MyLanguage/Help40:Site_Global_Configuration#Server|Site Global Configuration]] page, under Server options after the installation is completed. Note, you will break your installation if you change these settings after installation unless you have a complete copy of the current database being used by the Joomla! installation. Common uses would be to update the username and password of the database or to complete a move of an existing installation to a new host with different parameters.


After you click the '''Install Joomla''' button, you should see the Joomla logo spinning. Once the installation completes, you should see the success page!</translate>
{{-}}

<translate>
== Finishing Up == 
=== Success and Finishing Up the Installation ===
Congratulations! Joomla! 4 is now installed. If you want to start using Joomla! right way without [[S:MyLanguage/J4.x:Installing_Joomla#Installing_Extra_Languages|installing extra languages]] there is one last step to complete the installation. You must delete the '''Installation Folder'''. Click on '''Remove Installation folder''' and a success message will appear. Now you can navigate to the '''Administrator''' log in by clicking '''Administrator''' or go right to your site by clicking '''Site'''.</translate>
<div align="center" style="max-width:100%; height:auto;">[[File:<translate>

J40_Installation_screen_page_4.png</translate>|border|700px]]</div>

<translate>

You may see the following section beneath the '''Customise Installation''' Button.
*'''Recommended Settings''': these are settings are recommended in your PHP configuration, but will not prevent Joomla! from being installed. You can refer to the above instructions on how they may be changed.</translate>

<translate>=== Installing Extra Languages ===  </translate>
<translate>

Before you complete your installation by deleting the '''Installation Folder''', click on:</translate>

:'''{{rarr}} <translate>

Install Additional Languages</translate>'''

<translate>

This will continue the installation of Joomla! by taking you to a new installation page.</translate>
{{-}}

<translate>==== Install Languages ====  </translate>
{{warning|<translate>

To allow easy development we are currently allowing installation of Joomla 3.x language packs into Joomla 4. Many aren't compatible and are expected to be missing language strings. The ability to view 3.x language packs in the list on this page will be removed before Joomla 4 stable is tagged. Out of the 3.x language packs we recommend testing with French, German and Persian for now.</translate>}}

<translate>

A list of language packs is displayed.</translate>

[[File:<translate>

J40_Installation_screen_page_5.png</translate>|right|450px]]

<translate>

Check the language or language packs you wish to install. Remember the following:</translate>
<translate>

* Language packs included in custom distributions will not be listed at this stage as they are already installed.
* A version of the packs proposed will match the Joomla Major version (4.0.x, 4.1.x, etc.). The minor version of the pack may not correspond, e.g. you are installing version 4.0.3 and a 4.0.2 language pack is shown.
* Unmatched language packs in the above example may have untranslated strings.
* The unmatched language packs will be offered as an update when the packs are updated by the registered Translation teams. The available update will be shown in the Control panel as well as in {{rarr|Extensions Manager,Update}}. This behavior is similar to {{rarr|Extensions Manager,Install Languages}}.


Click '''Next''' and a progress bar will be display while the language pack or packs are downloaded.</translate>

<translate>==== Choose Default Language ====  </translate>
<translate> When the download is complete You will now be presented with a very similar '''Congratulations! Your Joomla site is ready.''' screen. The difference will be the addition of some options allowing you to choose the default language for the Site and the Administrator interface.</translate>

<translate>

* Make your choices for default languages.</translate>{{-}}[[File:<translate>

J40_Installation_screen_page_4_default_langs.png</translate>]]{{-}}

<translate>

When you completed all the choices of language installation, click '''Set default language''' to confirm.</translate>

<translate>==== Finalise ====  </translate>
<translate>

Now you can delete the '''Installation Folder'''. Click on '''Remove Installation folder''' and a success message will appear. Now you can navigate to the '''Administrator''' log in by clicking '''Administrator''' or go right to your site by clicking '''Site'''.</translate>

<noinclude>
[[Category:Installation{{#translation:}}]]
[[Category:Joomla! 4.x{{#translation:}}]]
[[Category:Joomla! 4.0{{#translation:}}]]
[[Category:Beginners{{#translation:}}]]
</noinclude>

J3.x:Installing Joomla

2020-12-04T18:22:51Z

Toivo: upload_max_filesize and post_max_size from 20M to 30M, thinking about upgrade path to 3.10 and 4.0

<noinclude><languages /></noinclude>
<translate>
Installing Joomla! for the first time is very easy. Joomla!’s built-in web installer makes setting up your new site a breeze.

== Requirements == 
=== Hosting Requirements ===


Before we start installing Joomla!, there are a couple prerequisites that need to be met to install Joomla! {{ns}} successfully. These apply whether you have a dedicated server, a shared hosting plan server, or are installing a copy on a local computer for testing or development.


You’ll need to meet the following [https://downloads.joomla.org/technical-requirements requirements] to install and use Joomla!</translate>

=== <translate>
References</translate> ===
<references/>
<translate>
==== Recommended PHP.ini Settings ==== 
There are some PHP settings that need to be sufficient for Joomla to install. The settings are usually in a "php.ini" or "user.ini". Talk to your host about how to change theses settings if it is possible to do so. If working on a localhost e.g. with XAMPP, you should not be restricted by these settings and VPS or dedicated hosting should also not be as restrictive.


The values for PHP.ini below are ''suggested values'' only.


* memory_limit - '''Minimum:''' 64M '''Recommended:''' 128M or better
* upload_max_filesize - '''Minimum:''' 30M
* post_max_size - '''Minimum:''' 30M
* max_execution_time: '''Recommended:''' 30
</translate>
<translate>
== Prepare for Install == 
You will need to complete two tasks before you can install Joomla! on your server. First, you will need to download the Joomla! package files. Next, you will need to have a database for Joomla! use.

=== Downloading and Uploading Joomla! Package Files ===  </translate>


#<translate>
Download the current release of</translate> [https://downloads.joomla.org/latest Joomla! {{ns}}]
<translate>

#Move the downloaded Joomla! installation package to the server. Use a [[wikipedia:FTP Client|FTP Client]] to transfer the Joomla! 3.x files to your server. There are several available for use, here is a detailed [[wp:Comparison_of_FTP_client_software|list of FTP Clients]]. Please make sure you are using a FTP client's official release.
:: Hint - This can be accomplished by simply moving the downloaded package to your server, then unpacking it. Or you can unpack the files on your local computer, then move the Joomla installation over to your server. Either way, the Joomla installation needs to be unpacked in the root of your site.


The "root" of your site is the public folder where all web page files are stored so that a user can view the site examples include public_html and htdocs. What your Host uses depends on them.</translate>

{{tip|text=<translate>

Normally you upload your web files to the root folder. This is typically named "public_html" but other variations include "htdocs" and this depends on what your host has the set up on the server. For Joomla purposes, you can load the files directly into "public_html" or a sub-folder within it.</translate>|title=<translate>

Your Server's "root" Folder</translate>}}

{{warning|title=<translate>
Warning!</translate>|<translate>
If you unpack the files on your own computer, then copy them to your server, be sure to move only the folders and files contained '''INSIDE''' the Joomla! package. If you unpack the folders and files into a folder, for example called,</translate> <code>''Joomla''</code> <translate>
and then upload that folder, your site will have to be accessed at</translate> <code>''yoursitename.com/Joomla''</code> <translate>
instead of</translate> <code>''yoursitename.com''</code>.}}

=== <translate>
Database for Joomla! Installation</translate> ===
<translate>

#If you need to create a database, please read "'''[[S:MyLanguage/Creating a Database for Joomla!|Create a database for use with Joomla!]]'''" first or skip to step #2.
#You will need to note basic database information needed when the actual Joomla! installation is started.
#* Location of database, localhost? Or a specific host's server such as <code>''dbserver1.yourhost.com''</code>?
#* The database name
#* The database user's name
#* The database user's password

== Start Install == 
=== Main Configuration ===
With the above requirements met, a database created and the required Joomla! files in place, you are ready to install Joomla!. Start the Joomla! web installer by opening your favorite browser and browsing to the site's domain name. On host installation you will use</translate> <code>''<nowiki>http://www.yoursitename.com</nowiki>''</code>. <translate>
If your are installing Joomla! locally, you will use</translate> <code>''<nowiki>http://localhost/</nowiki><<translate>
path to Joomla files</translate>>''</code>, <translate>
and you should see the installation screen</translate>.
<div style="clear:both; max-width:100%; height:auto; display:inline-block; float:right; margin-left:.3em;">[[File:<translate>
J30_Installation_screen_page_1.png</translate>|border|left|500px]]</div>

<translate>
Joomla! will try to identify the '''Select Language''' field automatically from your browser's language. You can change this if needed.


Fill in the following information.
*'''Site Name''': the name of your website — this can be changed at any point later in the [[S:MyLanguage/Help30:Site_Global_Configuration#Site|Site Global Configuration]] page.
*'''Description''': enter a description of the website. This is a ''global fallback'' meta description used on every page which will be used by search engines. Generally, a maximum of 20 to 25 words is optimal. Again, this can be changed on the [[S:MyLanguage/Help30:Site_Global_Configuration#Site|Site Global Configuration]] page at any time. For more on ''metadata'', see [[S:MyLanguage/Help30:Site_Global_Configuration#Metadata_Settings|Global Metadata Settings]] and [[S:MyLanguage/Entering search engine meta-data|Entering search engine meta-data]].
*'''Admin Email Address''': the admin email address. Enter a valid email in case you forget your password. This is the email address where you'll receive a link to change the admin password.
*'''Admin Username''': Joomla! uses a default "admin" as the username for the '''Super User'''. You can leave it as is, change it now (which a good [[S:MyLanguage/Security_Checklist/Joomla!_Setup#Change the default administrator username|Security measure]]) or use [[S:MyLanguage/Help30:Site_My_Profile|My Profile]] in the ''Administration'' interface to change it later.
*'''Admin Password''': remember that super user has maximum control of the site (frontend & backend), so try to use a difficult password. Use [[S:MyLanguage/Help30:Site_My_Profile|My Profile]] in the ''Administration'' interface to change it later. Confirm the password in the '''Confirm Admin Password''' box.
*'''Site Offline''': click the Yes or No box. Yes - this means when installation is complete, your Joomla! website will display the 'Site is offline' message when you browse to</translate> <code>''yoursitename.com''</code> <translate>
to view the home page. No - this means the site is live when you browse to</translate> <code>''yoursitename.com''</code> <translate>
to view the home page. You can use the [[S:MyLanguage/Help30:Site_Global_Configuration#Site|Site Global Configuration]] in the ''Administration'' interface to change the Offline status at any time.


When everything on the first page is completed, click the '''next button''' to proceed:</translate>

{{-}}

<translate>== Database Configuration == 
=== Configuration Settings ===
You will need to enter the information about the database you will use for Joomla! now. It was suggested to write this information down under "'''Prepare for Install'''" tab. You may also read or review [[S:MyLanguage/Creating a Database for Joomla!|Creating a Database for Joomla!]].</translate>
<div style="clear:both; max-width:100%; height:auto; display:inline-block; float:right; margin-left:.5em;">[[File:<translate>
J30_Installation_screen_page_2.png</translate>|border|left|500px]]</div>

<translate>
For simplification, these intructions are a reference to installing with a [[wikipedia:MySQLi|MySQLi]] database. The instructions on the installation page are self explanatory, but here they are again:
* '''Database Type''': MySQLi is the common database used
* '''Hostname''' Where is your database located? Common is <code>''localhost''</code>, but some hosts use a specific database server such as</translate> <code>''dbserver1.yourhost.com''</code>
<translate>

* '''Username''': the username used to connect to the database
* '''Password''': the password for the database's username
* '''Database Name''': the name of the database
* '''Table Prefix''': one is generated automatically, but you can change it. For example, <code>jos3_</code> can be used. Just don't forget to put the underscore character</translate> (<code>_</code>) <translate>
at the end of the prefix.
* '''Old Database Process''': should the installer backup or delete existing tables during the installation of new tables? Click, Yes or No to select the choice.</translate>

<translate>
All these choices can be edited on the [[S:MyLanguage/Help30:Site_Global_Configuration#Server|Site Global Configuration]] page, under Server options after the installation is completed. Note, you will break your installation if you change these settings after installation unless you have a complete copy of the current database being used by the Joomla! installation. Common uses would be to update the username and password of the database or to complete a move of an existing installation to a new host with different parameters.


When all the information has been filled in, click the '''next button''' to proceed:</translate>
{{-}}
<translate>

== Finalise == 
=== Overview ===
It is now time to finalise the Joomla! installation. The last page of the web browser installation contains all the information about the installation. This includes the options(at the top) for installing sample data and the installation's configurations(at the bottom).
==== Install Sample Data and Email Configurations ====
The first options are for automatically installing sample content to the website and emailing the configuration settings.</translate>
<div style="clear:both; max-width:100%; height:auto; display:inline-block; float:right; margin-left:.3em;">[[File:<translate>
J30_Installation_screen_page_3_top.png</translate>|border|left|500px]]</div>
<translate>
If you are new to Joomla! it would be beneficial to install some '''sample data''' to see how Joomla! works. You can at this time choose to have the configuration settings emailed to you. If the '''Email Configuration''' choice is selected, the '''Email Password''' choice will appear. The email password is off by default for security. You can choose to have the password included, just click Yes.


Time to check the configurations of your install and the environment of the installation.
</translate>
{{-}}
<translate>

== Configuration Check == 
==== Checking Your Configurations ====
If everything is in order, you will see the install at the top of the overview page. If not, this is the place to check and see what may be causing an issue.</translate>
<div style="clear:both; max-width:100%; height:auto; display:inline-block; float:right; margin-left:.3em;">[[File:<translate>
J30_Installation_screen_page_3_bottom.png</translate>|border|left|500px]]</div><translate>

The '''section''' is broken into 4 groups:
*'''Main Configuration''': all the website specific information, such as the website name, description, admin username, etc.
*'''Database Configuration''': contains the information about the database Joomla! will use.
*'''Pre-Installation Check''': these requirements must all be shown as Yes, otherwise you will not be able to install Joomla! With the exception of the PHP Version, the rest are usually controlled in the [[wikipedia:INI_file|php.ini]]. You may need assistance from your host in correcting these settings or checking to see if it is possible to adjust them.
*'''Typical PHP settings''' that might cause the install to fail and may need adjusting include the following with suggested values: (1) memory_limit (64M), (2)max_execution_time (30), (3) post_max_size (30M), (4) upload_max_filesize (30M). For more information, see [http://php.net/manual/en/configuration.file.php PHP configuration file] file.
*'''Recommended Settings''': these are settings are recommended in your PHP configuration, but will not prevent Joomla! from being installed. You can refer to the above instructions on how they may be changed.


If everything is correct and all checks are passed, you may now click the '''Install''' button in the top right corner of the '''Overview''' page. This will start the actual installation process.


After you click the '''Install''' button, you should see a progress bar with additional information of the installation. Once the installation completes, you should see the success page!</translate>

{{-}}
<translate>
== Finishing Up == 
=== Success and Finishing Up the Installation ===
Congratulations! Joomla! 3 is now installed. If you want to start using Joomla! right way without [[S:MyLanguage/J3.x:Installing_Joomla#Installing_Extra_Languages|installing extra languages]] there is one last step to complete the installation. You must delete the '''Installation Folder'''. Click on '''Remove Installation folder''' and a success message will appear. Now you can navigate to the '''Administrator''' log in by clicking '''Administrator''' or go right to your site by clicking '''Site'''.</translate>
<div align="center" style="max-width:100%; height:auto;">[[File:<translate>
J30_Installation_screen_page_4.png</translate>|border|700px]]</div>

<translate>=== Installing Extra Languages === </translate>
[[File:<translate>
J3x_Install_Extra_Steps.png</translate>|right|400px]]

<translate>
Before you complete your installation by deleting the '''Installation Folder''', click on:</translate>

:'''{{rarr}} <translate>
Extra steps: Install languages</translate>'''

<translate>
This will continue the installation of Joomla! by taking you to a new installation page.</translate>
{{-}}

<translate>==== Install Languages ==== </translate>
<translate>
A list of language packs is displayed.</translate>

[[File:<translate>
J3x_Language_Installation_screen_page_1.png</translate>|right|450px]]

<translate>
Check the language or language packs you wish to install. Remember the following:</translate>
<translate>

* Language packs included in custom distributions will not be listed at this stage as they are already installed.
* A version of the packs proposed will match the Joomla Major version (3.0.x, 3.1.x, etc.). The minor version of the pack may not correspond, e.g. you are installing version 3.3.3 and a 3.3.2 language pack is shown.
* Unmatched language packs in the above example may have untranslated strings.
* The unmatched language packs will be offered as an update when the packs are updated by the registered Translation teams. The available update will be shown in the Control panel as well as in {{rarr|Extensions Manager,Update}}. This behavior is similar to {{rarr|Extensions Manager,Install Languages}}.


Click '''Next''' and a progress bar will be display while the language pack or packs are downloaded.</translate>

<translate>==== Choose Default Language ==== </translate>
<translate>
When the download is complete you can choose the default language for the Site and the Administrator interface.</translate>

<translate>

* Make your choices for default languages.</translate>{{-}}[[File:<translate>
J3x_Language_Installation_screen_page_2.png</translate>]]{{-}}

<translate>
You may also choose to activate the multilingual features of Joomla! at this time too.</translate>
<translate>

* Click '''Yes''' next to '''Activate the multilingual feature'''
* Two additional choice will appear.</translate>{{-}}[[File:<translate>
J3x_Language_Installation_screen_page_2_multilingual.png</translate>|600px]]{{-}}
<translate>

* '''Install localised content''', yes or no. This will automatically create one content category for each language installed and one featured article with dummy content for each content category installed.
* '''Enable the language code plugin''', yes or no. If enabled, the plugin will add the ability to change the language code in the generated HTML document to improve SEO.</translate>

<translate>
When you completed all the choices of language installation, click '''Next''' to proceed.</translate>

<translate>==== Finalise ==== </translate>
<translate>
You will now be presented with a very similar '''Congratulations! Joomla! is now installed.''' screen. The difference will be a notation of the default Administrator and Site language settings, if they were set. You will also not see the '''Extra Steps''' message in the bottom right.</translate>

[[File:<translate>
J3x_Language_Installation_screen_page_3.png</translate>|center|850px]]

<translate>
Now you can delete the '''Installation Folder'''. Click on '''Remove Installation folder''' and a success message will appear. Now you can navigate to the '''Administrator''' log in by clicking '''Administrator''' or go right to your site by clicking '''Site'''.</translate>

<noinclude>
[[Category:Installation{{#translation:}}]]
[[Category:Joomla! 3.x{{#translation:}}]]
[[Category:Joomla! 3.0{{#translation:}}]]
[[Category:Joomla! 3.1{{#translation:}}]]
[[Category:Joomla! 3.2{{#translation:}}]]
[[Category:Joomla! 3.3{{#translation:}}]]
[[Category:Joomla! 3.4{{#translation:}}]]
[[Category:Joomla! 3.5{{#translation:}}]]
[[Category:Joomla! 3.6{{#translation:}}]]
[[Category:Joomla! 3.7{{#translation:}}]]
[[Category:Joomla! 3.8{{#translation:}}]]
[[Category:Joomla! 3.9{{#translation:}}]]
</noinclude>

J4.x:CLI Update

2020-04-17T08:26:36Z

Toivo: Syntax extension core:check-updates, extension:install

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 <br />
<translate> CLI Update <br />Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

<translate>
== Introduction == 
</translate>
<translate> Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It is a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.</translate>

<translate> This documentation shows how the CLI Update can be used and how you can extend its functionality as a developer.</translate>

<translate>
===Requirements=== 
</translate>
<translate>
As it goes for all CLI (Command Line Interface) Apps, access to your Joomla! installation via the command line is required to use the tools provided by the CLI Update.
You might want to consider having SSH access for your live server.</translate>

<translate>

===Terms and definitions=== 
</translate>
*CLI - Command Line Interface
*SSH - Secure SHell

<translate>
==Using the CLI Update== 
</translate>
<translate> In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.</translate>
[[File:All commands.png|center|800px]]

<translate>
==General Command Usage== 
</translate>
<translate> In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.</translate>

<translate>
===Available commands=== 
</translate>
<translate> There are quite a number of commands available in the CLI Update that are ready for use. These commands are grouped based on the area of the Joomla! CMS that they are touching.</translate>

<translate>
====Checking for Core Updates==== 
</translate>
<translate> The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory:</translate><br />
<tt>php cli/joomla.php core:check-updates</tt>
<br />
<translate> The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.</translate>
[[File:Check updates.png|center|800px]]

<translate>
====Extension commands==== 
</translate>
<translate> The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.</translate>

<translate>
======Listing installed extensions====== 
</translate>
<translate> This command allows us to list all installed extensions. This command can run in two different ways which are:</translate>
*<translate> ''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:</translate>{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*<translate> ''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done:</translate> {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
<translate> This will list out only language based extensions, you can specify type as module, plugin and component as well.</translate>

<translate>
======Installing an Extension====== 
</translate>
<translate> Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.</translate>
*<translate> ''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download and install the <tt>com_patchtester</tt> extension.</translate>
{{-}}[[File:Extension install url.png|center|800px]]
*<translate> ''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:</translate>{{-}}<tt>php cli/joomla.php extension:install --path=/Users/bosunski/docs/com_pathtester.zip</tt> {{-}}[[File:Extension install path.png|center|800px]]
<translate> This loads the extension and performs the installation as expected.</translate>

<translate>
======Removing an extension====== 
</translate>
<translate> The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt></translate><br/>
<tt>php cli/joomla.php extension:remove 803</tt>
[[File:Extension Remove.png|center|800px]]

<translate>
====Updating the Joomla Core==== 
</translate>
<translate> As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this:</translate><br/>
<tt>php cli/joomla.php core:update</tt><br/>
<translate> This command updates the Joomla core updating it to the latest version available.</translate>

[[File:Core update.png|center|800px]]

<translate>
====Installing Joomla! via the CLI==== 
</translate>
<translate> The next command here is the <tt>core:install</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.</translate>

<translate>
=====Interactive installation===== 
</translate>
<translate> To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so:</translate><br/>
<tt>php cli/joomla.php extension:install</tt>

<translate> The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.</translate>

[[File:Core install interactive.png|center|800px]]

<translate>
=====Non-interactive Installation===== 
</translate>
<translate> The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this:</translate><br/>
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

<translate> An example of the contents of <tt>config.json</tt> can be:</translate><br/>
<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

<translate> OR as sample</translate> <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

<translate> The options defined are loaded and validated after which the installation will run.</translate>

<translate>

====Configuration based commands==== 
</translate>
<translate> The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:</translate>

<translate>
=====Setting configurations===== 
</translate>
<translate> The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

<translate> You can even add multiple option-value pairs like this:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla! sitename="Joomla Site"</tt>
<translate>

This will set multiple options at once.</translate>

[[File:Config set multiple.png|center|800px]]

<translate>
=====Getting configurations===== 
</translate>
<translate> The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command:</translate><br/>
<tt>php cli/joomla.php config:get sitename</tt>

<translate> This will return the value for the option <tt>sitename</tt>.</translate>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

<translate> This will return all the values for the available options.</translate>

[[File:Config get all.png|center|800px]]

<translate>
=====Getting grouped configurations===== 
</translate>
<translate> The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:</translate>

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

<translate> The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.</translate>

<translate>
====Site down and Site up commands==== 
</translate>
<translate> As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands:</translate><br/>
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

<translate> The second command puts the website in offline mode while the first command brings the website to online mode.</translate>

<translate>

==Contributing to CLI Update as a developer== 
</translate>

<translate>
===Adding more commands=== 
</translate>
<translate> The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.</translate>

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

<translate>
===Calling other commands within command classes=== 
</translate>
<translate> Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:</translate>

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<translate> Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.</translate>

<translate>
===Some important things to checkout=== 
</translate>
<translate> *Symfony Style Documentation: [https://symfony.com/doc/current/console/style.html How to Style a Console Command]</translate>

<noinclude><translate>

[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
[[Category:Joomla CLI]]</translate>
</noinclude>

Joomla! Forum FAQs

2020-03-31T08:38:02Z

Toivo: Search: case insensitive, minimum length of argument 4; Help: fixed broken link to FPA

{{review}}
===What forum is used at joomla.org?===

We are currently using the forum software, phpBB3. phpBB is located here: http://www.phpbb.com/

===How is the forum at joomla.org integrated with Joomla!?===
The forum is not bridged with Joomla! in any way. The forum uses a customized theme that matches the rest of the joomla.org sites.

===What are the rules of the joomla.org forums?===
You can read the current forum rules here: http://forum.joomla.org/viewtopic.php?f=8&t=65

===How do you empty your PM-box on the forum?===

Problem
Your PM-box is full and nobody can send you anymore messages. How to solve this?

Solution
go to your messages and "check" the box and click delete for those you want to delete.

Note: READ them first before you delete them!

===How do I search the forum to find what I need?===

The forum search is somewhat tricky. Here are some tips for effective searching:

#Searches are case insensitive. The minimum length of a search argument is four (4) characters.
#Searches are for whole words, so for example error and errors will give different results.The forums are spidered by external search engines so you may be more successful using one of these.
#Advanced search will let you search with more parameters.

===How can I ask for help?===
Describe your problem. Describe the things that you tried. Give all the necessary information about your server environment, your Joomla set-up and all installed non-core extensions. The [https://forumpostassistant.github.io/docs/ Forum Post Assistant] is an excellent tool to give all that information.

When your issue has been solved, please reply to your topic about your solution so that your topic can be useful for other users with the same issue. And a "thank you" will motivate the people who helped you, to continue to help others.

===What are the stars/ranks under the forum username represent?===
The stars and ranks are based upon the number of posts a user has. See this page for more details:[[Explain 5 Star Rating System For Forum Posters]].

===Why are there different colors of usernames?===
The different colors of the usernames are used to differentiate between the different working groups of Joomla!. See this page for more details:[[Explain 5 Star Rating System For Forum Posters]].

<noinclude>[[Category:FAQ]]</noinclude>

How do you recover or reset your admin password?

2019-02-10T09:25:11Z

Toivo: added current time to date columns, NULL values cause SQL error

<noinclude><languages /></noinclude>
{{version|2.5,3.x}}
{{tip|text=<translate>
This page is only for Joomla! 2.5 and higher versions. If you are still using Joomla! 1.5 </translate> [[S:MyLanguage/J1.5:How_do_you_recover_or_reset_your_admin_password%3F|<translate>
instructions can be found here</translate>]].|title=<translate>
Joomla! 1.5 Password Recovery</translate>}}

<translate>

Normally, you can add, edit and delete users and passwords from the back-end User Manager. To do this, you must be logged in as a member of the Super Administrator group.


In some situations, this may not be possible. For example, your site may have been "hacked" and had the passwords or users changed. Or perhaps the person who knew the passwords is no longer available. Or maybe you have forgotten the password that was used.


In these cases, it is still possible to alter the Joomla! database so you can log back in as a Super Administrator. These are the possible methods available to Joomla! administrators.
</translate>

<translate>
== Method 1: configuration.php file == 
</translate>
<translate>

If you have access to your <code>configuration.php</code> file for the Joomla installation on your server, then you can recover the password using the following method.


1. Using an FTP program connect to your site. Find the configuration.php file and look at the file permissions. If the permissions are 444 or some other value, then change the permissions of the configuration.php file to 644. This will help prevent issues when uploading the changed configuration.php file later in this process.


2. Download the configuration file.


3. Open the configuration.php file that was downloaded in a text editor such as notepad++ and add this line
</translate>

public $root_user='myname';

<translate>

to the bottom of the list where myname is a username with administrator access that you know the password for. An username that is Author level or higher can also be used in place of a username with administrator access.


4. Save the configuration.php file and upload it back to the site. You may leave the permissions on the configuration.php file at 644.


This user will now be a temporary super administrator.


5. Login to the back end and change the password of the administrator user you don't have the password for or create a new super admin user.
If you create the new user you may want to block or delete the old user depending on your circumstances.
</translate>

<translate>

6. When finished, make sure to use the "Click here to try to do it automatically" link that appears in the alert box to remove the line that was added to the configuration.php file. If using the link was not successful, then go back and delete the added line from your configuration.php file using a text editor. Upload the configuration.php file back to the site.
</translate>

<translate>

7. Using your FTP program verify the file permissions of the configuration.php file, they should be 444. If you manually removed the added line, then change the file permissions on the configuration.php file to 444.


If you have no users who know their passwords and you can't utilize front end registration you may need to make a change in your database as outlined below in this document.
</translate>

<translate>

== Method 2: Direct Editing of Database == 
If the methods above did not work, you have two other options, both of which require working with the MySQL database directly.
</translate>

<translate>
===Change the Password in the Database=== 
If the admin user is still defined, the simplest option is to change the password in the database to a known value. This requires that you have access to the MySQL database using phpMyAdmin or another client.
</translate>
{{warning|<translate>
These instructions show how to manually change a password to the word</translate> - "secret"|title=<translate>
Make sure you change your password once you regain access</translate>}}

<translate>
# Navigate to phpMyAdmin and select the database for the Joomla! site in the left-hand drop-down list box. This will show the database tables on the left side of the screen.
# Find and click on the table with "_users" appended in the list of tables (note: you may have a prefix that is not jos_, simply go to the _users table for your prefix).
# Click on the "Browse" button in the top toolbar. This will show all of the users that are set up for this site.</translate>
<translate>
# Find the user whose password you want to change and press the Edit icon for this row.
# A form will display that allows you to edit the password field. Copy the value</translate> <source lang="sql">d2064d358136996bd22421584a7cb33e:trd7TvKHx6dMeoMmBVxYmg0vuXEA4199</source> <translate>
into the password field and press the ''Go'' button. phpMyAdmin should display the message "Affected rows: 1". At this point, the password should be changed to '''"secret"'''.
# Log in with this user and password and change the password of this user to a secure value. Check all of the users using the User Manager to make sure they are legitimate. If you have been hacked, you may want to change all of the passwords on the site.</translate>

<translate>
===Add a New Super Administrator User=== 
If changing the password won't work, or you aren't sure which user is a member of the Super Administrator group, you can use this method to create a new user.
</translate>

<translate>
# Navigate to phpMyAdmin and select the database for the Joomla! site in the left-hand drop-down list box. This will show the database tables on the left side of the screen.
# Press the "SQL" button in the toolbar to run an SQL query on the selected database. This will display a field called "Run SQL query/queries on database <your database>".</translate>
<translate>
# Delete any text in this field and copy and paste the following query below and press the ''Go'' button to execute the query and add the new Administrator user to the table.
# Use the SQL query below to add another administrator account.</translate>

{{warning|<translate>
The following code uses jos31_ as the table name prefix which is only an example table prefix. The prefix when you first installed Joomla is '''RANDOM''' or what you set it specifically too. You will need to change all occurrences of '''jos31_'''(your install set prefix) found in the code below to the prefix your installation is using.</translate> |title=<translate>
Make sure you match your db table prefix!</translate>}}

'''<translate>
SQL code for use with Joomla</translate> {{JVer|2.5}} {{JVer|3.1}} '''

<source lang="sql">INSERT INTO `jos31_users`
(`name`, `username`, `password`, `params`, `registerDate`, `lastvisitDate`, `lastResetTime`)
VALUES ('Administrator2', 'admin2',
'd2064d358136996bd22421584a7cb33e:trd7TvKHx6dMeoMmBVxYmg0vuXEA4199', '', NOW(), NOW(), NOW());
INSERT INTO `jos31_user_usergroup_map` (`user_id`,`group_id`)
VALUES (LAST_INSERT_ID(),'8');
</source>

<translate>

At this point, you should be able to log into the back end of Joomla! with the username of "admin2" and password of "secret". After logging in, go to the User Manager and change the password to a new secure value and add a valid e-mail address to the account. If there is a chance you have been "hacked", be sure to check that all users are legitimate, especially any members of the Super Administrator group.
</translate>

{{warning|<translate>
Warning: The password values shown on this page are public knowledge and are only for recovery. Your site may be hacked if you do not change the password to a secure value after logging in. Be sure you change the password to a secure value after logging in.</translate>}}

<translate>
The examples above change the password to "secret". Two other possible values are shown below:</translate>
<pre>
- password = "this is the MD5 and salted hashed password"
------------------------------------------------------
- admin = 433903e0a9d6a712e00251e44d29bf87:UJ0b9J5fufL3FKfCc0TLsYJBh2PFULvT
- secret = d2064d358136996bd22421584a7cb33e:trd7TvKHx6dMeoMmBVxYmg0vuXEA4199
- OU812 = 5e3128b27a2c1f8eb53689f511c4ca9e:J584KAEv9d8VKwRGhb8ve7GdKoG7isMm
</pre>

<noinclude><translate>
[[Category:FAQ]][[Category:Administration FAQ]][[Category:Getting Started FAQ]] [[Category:User Management]]</translate></noinclude>

Plugin/Events/Contact

2019-01-10T15:16:52Z

Toivo: /* onSubmitContact */ corrected path, changed mails to emails

Contact events are triggered during the contact form submitting process.

== onValidateContact ==
'''Description'''

This event is triggered after a contact form has been submitted.
An example use case would be validating a captcha. If you return an Exception object form submission will be terminated.

'''Parameters'''

*<code>contact</code> A reference to the person who will receive the form.
*<code>data</code> A reference to the data in the $_POST variable.

'''Return Value'''

None on success or Exception on failure.

'''Called in files'''
*<tt>components/com_contact/controllers/contact.php</tt>

== onSubmitContact ==
'''Description'''

This event is triggered after a contact form has been submitted. You can use this for sending additional emails etc.

'''Parameters'''

*<code>contact</code> A reference to the person who will receive the form.
*<code>data</code> A reference to the data in the $_POST variable.

'''Return Value'''

None.
'''Called in files'''

*<tt>components/com_contact/controllers/contact.php</tt>

<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>

Plugin/Events/Contact

2019-01-10T15:15:07Z

Toivo: /* onValidateContact */ corrected path, fixed typo

Contact events are triggered during the contact form submitting process.

== onValidateContact ==
'''Description'''

This event is triggered after a contact form has been submitted.
An example use case would be validating a captcha. If you return an Exception object form submission will be terminated.

'''Parameters'''

*<code>contact</code> A reference to the person who will receive the form.
*<code>data</code> A reference to the data in the $_POST variable.

'''Return Value'''

None on success or Exception on failure.

'''Called in files'''
*<tt>components/com_contact/controllers/contact.php</tt>

== onSubmitContact ==
'''Description'''

This event is triggered after a contact form has been submitted. You can use this for sending additional mails etc.

'''Parameters'''

*<code>contact</code> A reference to the person who will receive the form.
*<code>data</code> A reference to the data in the $_POST variable.

'''Return Value'''

None.
'''Called in files'''

*<tt>components/com_contact/controller.php</tt>

<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>

J4.x:CLI Update

2018-12-28T16:59:35Z

Toivo: typo

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 <br />
<translate> CLI Update <br />Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

<translate>
== Introduction == 
</translate>
<translate> Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It is a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.</translate>

<translate> This documentation shows how the CLI Update can be used and how you can extend its functionality as a developer.</translate>

<translate>
===Requirements=== 
</translate>
<translate>
As it goes for all CLI (Command Line Interface) Apps, access to your Joomla! installation via the command line is required to use the tools provided by the CLI Update.
You might want to consider having SSH access for your live server.</translate>

<translate>

===Terms and definitions=== 
</translate>
*CLI - Command Line Interface
*SSH - Secure SHell

<translate>
==Using the CLI Update== 
</translate>
<translate> In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.</translate>
[[File:All commands.png|center|800px]]

<translate>
==General Command Usage== 
</translate>
<translate> In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.</translate>

<translate>
===Available commands=== 
</translate>
<translate> There are quite a number of commands available in the CLI Update that are ready for use. These commands are grouped based on the area of the Joomla! CMS that they are touching.</translate>

<translate>
====Checking for Updates Updates==== 
</translate>
<translate> The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory:</translate><br />
<tt>php cli/joomla.php check-updates</tt>
<br />
<translate> The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.</translate>
[[File:Check updates.png|center|800px]]

<translate>
====Extension commands==== 
</translate>
<translate> The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.</translate>

<translate>
======Listing installed extensions====== 
</translate>
<translate> This command allows us to list all installed extensions. This command can run in two different ways which are:</translate>
*<translate> ''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:</translate>{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*<translate> ''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done:</translate> {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
<translate> This will list out only language based extensions, you can specify type as module, plugin and component as well.</translate>

<translate>
======Installing an Extension====== 
</translate>
<translate> Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.</translate>
*<translate> ''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.</translate>
{{-}}[[File:Extension install url.png|center|800px]]
*<translate> ''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:</translate>{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt> {{-}}[[File:Extension install path.png|center|800px]]
<translate> This loads the extension and performs the installation as expected.</translate>

<translate>
======Removing an extension====== 
</translate>
<translate> The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt></translate><br/>
<tt>php cli/joomla.php extension:remove 803</tt>
[[File:Extension Remove.png|center|800px]]

<translate>
====Updating the Joomla Core==== 
</translate>
<translate> As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this:</translate><br/>
<tt>php cli/joomla.php core:update</tt><br/>
<translate> This command updates the Joomla core updating it to the latest version available.</translate>

[[File:Core update.png|center|800px]]

<translate>
====Installing Joomla! via the CLI==== 
</translate>
<translate> The next command here is the <tt>core:install</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.</translate>

<translate>
=====Interactive installation===== 
</translate>
<translate> To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so:</translate><br/>
<tt>php cli/joomla.php extension:install</tt>

<translate> The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.</translate>

[[File:Core install interactive.png|center|800px]]

<translate>
=====Non-interactive Installation===== 
</translate>
<translate> The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this:</translate><br/>
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

<translate> An example of the contents of <tt>config.json</tt> can be:</translate><br/>
<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

<translate> OR as sample</translate> <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

<translate> The options defined are loaded and validated after which the installation will run.</translate>

<translate>

====Configuration based commands==== 
</translate>
<translate> The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:</translate>

<translate>
=====Setting configurations===== 
</translate>
<translate> The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

<translate> You can even add multiple option-value pairs like this:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla! sitename="Joomla Site"</tt>
<translate>

This will set multiple options at once.</translate>

[[File:Config set multiple.png|center|800px]]

<translate>
=====Getting configurations===== 
</translate>
<translate> The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command:</translate><br/>
<tt>php cli/joomla.php config:get sitename</tt>

<translate> This will return the value for the option <tt>sitename</tt>.</translate>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

<translate> This will return all the values for the available options.</translate>

[[File:Config get all.png|center|800px]]

<translate>
=====Getting grouped configurations===== 
</translate>
<translate> The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:</translate>

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

<translate> The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.</translate>

<translate>
====Site down and Site up commands==== 
</translate>
<translate> As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands:</translate><br/>
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

<translate> The second command puts the website in offline mode while the first command brings the website to online mode.</translate>

<translate>

==Contributing to CLI Update as a developer== 
</translate>

<translate>
===Adding more commands=== 
</translate>
<translate> The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.</translate>

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

<translate>
===Calling other commands within command classes=== 
</translate>
<translate> Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:</translate>

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<translate> Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.</translate>

<translate>
===Some important things to checkout=== 
</translate>
*Symfony Style Documentation: [https://symfony.com/doc/current/console/style.html How to Style a Console Command]

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-12-28T16:50:27Z

Toivo: grammar

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 <br />
<translate> CLI Update <br />Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

<translate>
== Introduction == 
</translate>
<translate> Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It is a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.</translate>

<translate> This documentation shows how the CLI Update can be used and how you can extend its functionality as a developer.</translate>

<translate>
===Requirements=== 
</translate>
<translate>
As it goes for all CLI (Command Line Interface) Apps, access to your Joomla! installation via the command line is required to use the tools provided by the CLI Update.
You might want to consider having SSH access for your live server.</translate>

<translate>

===Terms and definitions=== 
</translate>
*CLI - Command Line Interface
*SSH - Secure SHell

<translate>
==Using the CLI Update== 
</translate>
<translate> In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.</translate>
[[File:All commands.png|center|800px]]

<translate>
==General Command Usage== 
</translate>
<translate> In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.</translate>

<translate>
===Available commands=== 
</translate>
<translate> There are quite a number of commands available in the CLI Update that are ready for use. These commands are grouped based on the area of the Joomla! CMS that they are touching.</translate>

<translate>
====Checking for Updates Updates==== 
</translate>
<translate> The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory:</translate><br />
<tt>php cli/joomla.php check-updates</tt>
<br />
<translate> The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.</translate>
[[File:Check updates.png|center|800px]]

<translate>
====Extension commands==== 
</translate>
<translate> The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.</translate>

<translate>
======Listing installed extensions====== 
</translate>
<translate> This command allows us to list all installed extensions. This command can run in two different ways which are:</translate>
*<translate> ''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:</translate>{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*<translate> ''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done:</translate> {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
<translate> This will list out only language based extensions, you can specify type as module, plugin and component as well.</translate>

<translate>
======Installing an Extension====== 
</translate>
<translate> Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.</translate>
*<translate> ''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.</translate>
{{-}}[[File:Extension install url.png|center|800px]]
*<translate> ''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:</translate>{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt> {{-}}[[File:Extension install path.png|center|800px]]
<translate> This loads the extension and performs the installation as expected.</translate>

<translate>
======Removing an extension====== 
</translate>
<translate> The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt></translate><br/>
<tt>php cli/joomla.php extension:remove 803</tt>
[[File:Extension Remove.png|center|800px]]

<translate>
====Updating the Joomla Core==== 
</translate>
<translate> As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this:</translate><br/>
<tt>php cli/joomla.php core:update</tt><br/>
<translate> This command updates the Joomla core updating it to the latest version available.</translate>

[[File:Core update.png|center|800px]]

<translate>
====Installing Joomla! via the CLI==== 
</translate>
<translate> The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.</translate>

<translate>
=====Interactive installation===== 
</translate>
<translate> To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so:</translate><br/>
<tt>php cli/joomla.php extension:install</tt>

<translate> The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.</translate>

[[File:Core install interactive.png|center|800px]]

<translate>
=====Non-interactive Installation===== 
</translate>
<translate> The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this:</translate><br/>
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

<translate> An example of the contents of <tt>config.json</tt> can be:</translate><br/>
<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

<translate> OR as sample</translate> <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

<translate> The options defined are loaded and validated after which the installation will run.</translate>

<translate>
====Configuration based commands==== 
</translate>
<translate> The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:</translate>

<translate>
=====Setting configurations===== 
</translate>
<translate> The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

<translate> You can even add multiple option-value pairs like this:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla! sitename="Joomla Site"</tt>
<translate>

This will set multiple options at once.</translate>

[[File:Config set multiple.png|center|800px]]

<translate>
=====Getting configurations===== 
</translate>
<translate> The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command:</translate><br/>
<tt>php cli/joomla.php config:get sitename</tt>

<translate> This will return the value for the option <tt>sitename</tt>.</translate>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

<translate> This will return all the values for the available options.</translate>

[[File:Config get all.png|center|800px]]

<translate>
=====Getting grouped configurations===== 
</translate>
<translate> The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:</translate>

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

<translate> The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.</translate>

<translate>
====Site down and Site up commands==== 
</translate>
<translate> As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands:</translate><br/>
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

<translate> The second command puts the website in offline mode while the first command brings the website to online mode.</translate>

<translate>

==Contributing to CLI Update as a developer== 
</translate>

<translate>
===Adding more commands=== 
</translate>
<translate> The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.</translate>

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

<translate>
===Calling other commands within command classes=== 
</translate>
<translate> Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:</translate>

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<translate> Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.</translate>

<translate>
===Some important things to checkout=== 
</translate>
*Symfony Style Documentation: [https://symfony.com/doc/current/console/style.html How to Style a Console Command]

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-12-28T16:47:46Z

Toivo: fixed typos

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 <br />
<translate> CLI Update <br />Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

<translate>
== Introduction == 
</translate>
<translate> Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It is a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.</translate>

<translate> This documentation shows how the CLI Update can be used and how you can extend its functionality as a developer.</translate>

<translate>
===Requirements=== 
</translate>
<translate>
As it goes for all CLI (Command Line Interface) Apps, access to your Joomla! installation via the command line is required to use the tools provided by the CLI Update.
You might want to consider having SSH access for your live server.</translate>

<translate>

===Terms and definitions=== 
</translate>
*CLI - Command Line Interface
*SSH - Secure SHell

<translate>
==Using the CLI Update== 
</translate>
<translate> In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.</translate>
[[File:All commands.png|center|800px]]

<translate>
==General Command Usage== 
</translate>
<translate> In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.</translate>

<translate>
===Available commands=== 
</translate>
<translate> There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.</translate>

<translate>
====Checking for Updates Updates==== 
</translate>
<translate> The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory:</translate><br />
<tt>php cli/joomla.php check-updates</tt>
<br />
<translate> The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.</translate>
[[File:Check updates.png|center|800px]]

<translate>
====Extension commands==== 
</translate>
<translate> The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.</translate>

<translate>
======Listing installed extensions====== 
</translate>
<translate> This command allows us to list all installed extensions. This command can run in two different ways which are:</translate>
*<translate> ''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:</translate>{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*<translate> ''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done:</translate> {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
<translate> This will list out only language based extensions, you can specify type as module, plugin and component as well.</translate>

<translate>
======Installing an Extension====== 
</translate>
<translate> Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.</translate>
*<translate> ''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.</translate>
{{-}}[[File:Extension install url.png|center|800px]]
*<translate> ''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:</translate>{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt> {{-}}[[File:Extension install path.png|center|800px]]
<translate> This loads the extension and performs the installation as expected.</translate>

<translate>
======Removing an extension====== 
</translate>
<translate> The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt></translate><br/>
<tt>php cli/joomla.php extension:remove 803</tt>
[[File:Extension Remove.png|center|800px]]

<translate>
====Updating the Joomla Core==== 
</translate>
<translate> As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this:</translate><br/>
<tt>php cli/joomla.php core:update</tt><br/>
<translate> This command updates the Joomla core updating it to the latest version available.</translate>

[[File:Core update.png|center|800px]]

<translate>
====Installing Joomla! via the CLI==== 
</translate>
<translate> The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.</translate>

<translate>
=====Interactive installation===== 
</translate>
<translate> To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so:</translate><br/>
<tt>php cli/joomla.php extension:install</tt>

<translate> The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.</translate>

[[File:Core install interactive.png|center|800px]]

<translate>
=====Non-interactive Installation===== 
</translate>
<translate> The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this:</translate><br/>
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

<translate> An example of the contents of <tt>config.json</tt> can be:</translate><br/>
<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

<translate> OR as sample</translate> <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

<translate> The options defined are loaded and validated after which the installation will run.</translate>

<translate>
====Configuration based commands==== 
</translate>
<translate> The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:</translate>

<translate>
=====Setting configurations===== 
</translate>
<translate> The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

<translate> You can even add multiple option-value pairs like this:</translate><br/>
<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla! sitename="Joomla Site"</tt>
<translate>

This will set multiple options at once.</translate>

[[File:Config set multiple.png|center|800px]]

<translate>
=====Getting configurations===== 
</translate>
<translate> The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command:</translate><br/>
<tt>php cli/joomla.php config:get sitename</tt>

<translate> This will return the value for the option <tt>sitename</tt>.</translate>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

<translate> This will return all the values for the available options.</translate>

[[File:Config get all.png|center|800px]]

<translate>
=====Getting grouped configurations===== 
</translate>
<translate> The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:</translate>

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

<translate> The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.</translate>

<translate>
====Site down and Site up commands==== 
</translate>
<translate> As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands:</translate><br/>
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

<translate> The second command puts the website in offline mode while the first command brings the website to online mode.</translate>

<translate>
==Contributing to CLI Update as a developer== 
</translate>

<translate>
===Adding more commands=== 
</translate>
<translate> The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.</translate>

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

<translate>
===Calling other commands within command classes=== 
</translate>
<translate> Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:</translate>

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<translate> Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.</translate>

<translate>
===Some important things to checkout=== 
</translate>
*Symfony Style Documentation: [https://symfony.com/doc/current/console/style.html How to Style a Console Command]

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

How do I use Gmail as my mail server?

2017-10-06T08:31:36Z

Toivo: updated SMTP port and security, re-ordered fields

If you have a working Gmail account you can use Gmail as your mail server by setting it in the global configuration.

On the server tab set the following:

*Mailer: SMTP
*SMTP Host: smtp.gmail.com
*SMTP Port 465
*SMTP Security: SSL/TLS
*SMTP Authentication: Yes
*Set the next two lines with your information. You need to use an app specific password (ASP), described below.
*SMTP Username: your gmail username
*SMTP Password: your gmail password

The following are also working combinations:
*SMTP Port 587
*SMTP Security: STARTTLS

*SMTP Port 25
*SMTP Security: STARTTLS

The SSL module does not need to be enabled in Apache.

The OpenSSL extension needs to be enabled in PHP. The details can be found at http://www.php.net/manual/en/openssl.installation.php

If you are using WAMP on Windows, the openssl module is not enabled by default and you need to enable it. To do this:
# Open the php.ini file and uncomment the line <code>extension=php_openssl.dll</code> by removing the semicolon ; from the beginning of the line.
# Save the php.ini file and restart the Apache service.

{{tip|title=Note|Note that if you use 2-step verification in Gmail, you need to add a new password in Settings - Accounts - Change accounts settings - Other Google Account settings - Security - 2-step verification - Manage your application specific passwords.}}

When the new Application Specific Password (ASP) is presented in groups of four characters separated by spaces, make sure that you '''do NOT enter the spaces''' into the SMTP password in the mail server settings in Joomla.

* Application Specific Passwords (ASPs): https://support.google.com/accounts/answer/185833
* 2-Step Verification: https://support.google.com/accounts/answer/1070457

<noinclude>[[Category:FAQ]][[Category:Server configurations]]</noinclude>

Sending email from extensions

2017-08-27T15:35:38Z

Toivo: /* Set a Sender */

{{Joomla version|version=2.5|time=and after}}
This is an example of how to send an email from a Joomla component. You would typically put this into your component's controller.
=== Fetch the Mail Object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

<source lang="php">
$mailer = JFactory::getMailer();
</source>

=== Set a Sender ===
The sender of an email is set with [https://api.joomla.org/cms-3/classes/JMail.html#method_setSender setSender]. The function takes an array with an email address and a name as an argument. We fetch the site's email address and name from the global configuration. These are set in the administration back-end (Global Configuration -> Server -> Mail Settings).

<source lang="php">
$config = JFactory::getConfig();
$sender = array(
$config->get( 'mailfrom' ),
$config->get( 'fromname' )
);

$mailer->setSender($sender);
</source>

In 3.1, $config->getValue() should be changed to $config->get()

=== Recipient ===
You set the recipient of an email with the function [https://api.joomla.org/cms-3/classes/JMail.html#method_addRecipient addRecipient].
To set the email address to the currently logged in user, we fetch it from the user object.

<source lang="php">
$user = JFactory::getUser();
$recipient = $user->email;

$mailer->addRecipient($recipient);
</source>

If we had multiple recipients, we would put each recipient's email address in an array.

<source lang="php">
$recipient = array( 'person1@domain.com', 'person2@domain.com', 'person3@domain.com' );

$mailer->addRecipient($recipient);
</source>

=== Create the Mail ===
We need to set a subject line and create the text body. The subject is set with [https://api.joomla.org/cms-3/classes/JMail.html#method_setSubject setSubject].

The easy way to create an email body is as a string with plain text. Use the function [https://api.joomla.org/cms-3/classes/JMail.html#method_setBody setBody] to add a message to the mail body. You can also attach a file with [https://api.joomla.org/cms-3/classes/JMail.html#method_addAttachment addAttachment]. It takes a single file name or an array of file names as the argument.

<source lang="php">
$body = "Your body string\nin double quotes if you want to parse the \nnewlines etc";
$mailer->setSubject('Your subject string');
$mailer->setBody($body);
// Optional file attached
$mailer->addAttachment(JPATH_COMPONENT.'/assets/document.pdf');
</source>

If you prefer to format your email in HTML, you need to tell the mailer it is HTML. This is done with [https://api.joomla.org/cms-3/classes/JMail.html#method_isHtml isHTML]. When sending HTML emails you should normally set the [http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#property_Encoding Encoding] to base64 in order to avoid unwanted characters in the output. The subject line and any attachments are handled as above, with the exception of images embedded in the HTML. These are taken care of with the function [http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#method_addEmbeddedImage AddEmbeddedImage].

<source lang="php">
$body = '<h2>Our mail</h2>'
. '<div>A message to our dear readers'
. '<img src="cid:logo_id" alt="logo"/></div>';
$mailer->isHtml(true);
$mailer->Encoding = 'base64';
$mailer->setBody($body);
// Optionally add embedded image
$mailer->AddEmbeddedImage( JPATH_COMPONENT.'/assets/logo128.jpg', 'logo_id', 'logo.jpg', 'base64', 'image/jpeg' );
</source>

Normally you would leave any images on your server and refer to them with an ordinary HTML image tag, to reduce size of the mail and the time sending it.

=== Sending the Mail ===
The mail is sent with the function [https://api.joomla.org/cms-3/classes/JMail.html#method_Send Send]. It returns '''true''' on success or a JError object.

<source lang="php">
$send = $mailer->Send();
if ( $send !== true ) {
echo 'Error sending email: ';
} else {
echo 'Mail sent';
}
</source>

You would probably want to write your own error handler, if there is an error sending the mail.

The JMail object is used for sending mail in Joomla's contact manager. See the file joomla/components/com_contact/controller.php

===See also===
* [https://api.joomla.org/cms-3/classes/JFactory.html#method_getMailer JFactory->getMailer on api.joomla.org]

[[Category:Development]]
[[Category:Component Development]]

Sending email from extensions

2017-08-27T15:34:10Z

Toivo: /* Recipient */

{{Joomla version|version=2.5|time=and after}}
This is an example of how to send an email from a Joomla component. You would typically put this into your component's controller.
=== Fetch the Mail Object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

<source lang="php">
$mailer = JFactory::getMailer();
</source>

=== Set a Sender ===
The sender of an email is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSender setSender]. The function takes an array with an email address and a name as an argument. We fetch the site's email address and name from the global configuration. These are set in the administration back-end (Global Configuration -> Server -> Mail Settings).

<source lang="php">
$config = JFactory::getConfig();
$sender = array(
$config->get( 'mailfrom' ),
$config->get( 'fromname' )
);

$mailer->setSender($sender);
</source>

In 3.1, $config->getValue() should be changed to $config->get()

=== Recipient ===
You set the recipient of an email with the function [https://api.joomla.org/cms-3/classes/JMail.html#method_addRecipient addRecipient].
To set the email address to the currently logged in user, we fetch it from the user object.

<source lang="php">
$user = JFactory::getUser();
$recipient = $user->email;

$mailer->addRecipient($recipient);
</source>

If we had multiple recipients, we would put each recipient's email address in an array.

<source lang="php">
$recipient = array( 'person1@domain.com', 'person2@domain.com', 'person3@domain.com' );

$mailer->addRecipient($recipient);
</source>

=== Create the Mail ===
We need to set a subject line and create the text body. The subject is set with [https://api.joomla.org/cms-3/classes/JMail.html#method_setSubject setSubject].

The easy way to create an email body is as a string with plain text. Use the function [https://api.joomla.org/cms-3/classes/JMail.html#method_setBody setBody] to add a message to the mail body. You can also attach a file with [https://api.joomla.org/cms-3/classes/JMail.html#method_addAttachment addAttachment]. It takes a single file name or an array of file names as the argument.

<source lang="php">
$body = "Your body string\nin double quotes if you want to parse the \nnewlines etc";
$mailer->setSubject('Your subject string');
$mailer->setBody($body);
// Optional file attached
$mailer->addAttachment(JPATH_COMPONENT.'/assets/document.pdf');
</source>

If you prefer to format your email in HTML, you need to tell the mailer it is HTML. This is done with [https://api.joomla.org/cms-3/classes/JMail.html#method_isHtml isHTML]. When sending HTML emails you should normally set the [http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#property_Encoding Encoding] to base64 in order to avoid unwanted characters in the output. The subject line and any attachments are handled as above, with the exception of images embedded in the HTML. These are taken care of with the function [http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#method_addEmbeddedImage AddEmbeddedImage].

<source lang="php">
$body = '<h2>Our mail</h2>'
. '<div>A message to our dear readers'
. '<img src="cid:logo_id" alt="logo"/></div>';
$mailer->isHtml(true);
$mailer->Encoding = 'base64';
$mailer->setBody($body);
// Optionally add embedded image
$mailer->AddEmbeddedImage( JPATH_COMPONENT.'/assets/logo128.jpg', 'logo_id', 'logo.jpg', 'base64', 'image/jpeg' );
</source>

Normally you would leave any images on your server and refer to them with an ordinary HTML image tag, to reduce size of the mail and the time sending it.

=== Sending the Mail ===
The mail is sent with the function [https://api.joomla.org/cms-3/classes/JMail.html#method_Send Send]. It returns '''true''' on success or a JError object.

<source lang="php">
$send = $mailer->Send();
if ( $send !== true ) {
echo 'Error sending email: ';
} else {
echo 'Mail sent';
}
</source>

You would probably want to write your own error handler, if there is an error sending the mail.

The JMail object is used for sending mail in Joomla's contact manager. See the file joomla/components/com_contact/controller.php

===See also===
* [https://api.joomla.org/cms-3/classes/JFactory.html#method_getMailer JFactory->getMailer on api.joomla.org]

[[Category:Development]]
[[Category:Component Development]]

Sending email from extensions

2017-08-27T15:29:40Z

Toivo: /* Create the Mail */

{{Joomla version|version=2.5|time=and after}}
This is an example of how to send an email from a Joomla component. You would typically put this into your component's controller.
=== Fetch the Mail Object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

<source lang="php">
$mailer = JFactory::getMailer();
</source>

=== Set a Sender ===
The sender of an email is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSender setSender]. The function takes an array with an email address and a name as an argument. We fetch the site's email address and name from the global configuration. These are set in the administration back-end (Global Configuration -> Server -> Mail Settings).

<source lang="php">
$config = JFactory::getConfig();
$sender = array(
$config->get( 'mailfrom' ),
$config->get( 'fromname' )
);

$mailer->setSender($sender);
</source>

In 3.1, $config->getValue() should be changed to $config->get()

=== Recipient ===
You set the recipient of an email with the function [http://api.joomla.org/1.5/Joomla-Framework/Mail/JMail.html# addRecipient].
To set the email address to the currently logged in user, we fetch it from the user object.

<source lang="php">
$user = JFactory::getUser();
$recipient = $user->email;

$mailer->addRecipient($recipient);
</source>

If we had multiple recipients, we would put each recipient's email address in an array.

<source lang="php">
$recipient = array( 'person1@domain.com', 'person2@domain.com', 'person3@domain.com' );

$mailer->addRecipient($recipient);
</source>

=== Create the Mail ===
We need to set a subject line and create the text body. The subject is set with [https://api.joomla.org/cms-3/classes/JMail.html#method_setSubject setSubject].

The easy way to create an email body is as a string with plain text. Use the function [https://api.joomla.org/cms-3/classes/JMail.html#method_setBody setBody] to add a message to the mail body. You can also attach a file with [https://api.joomla.org/cms-3/classes/JMail.html#method_addAttachment addAttachment]. It takes a single file name or an array of file names as the argument.

<source lang="php">
$body = "Your body string\nin double quotes if you want to parse the \nnewlines etc";
$mailer->setSubject('Your subject string');
$mailer->setBody($body);
// Optional file attached
$mailer->addAttachment(JPATH_COMPONENT.'/assets/document.pdf');
</source>

If you prefer to format your email in HTML, you need to tell the mailer it is HTML. This is done with [https://api.joomla.org/cms-3/classes/JMail.html#method_isHtml isHTML]. When sending HTML emails you should normally set the [http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#property_Encoding Encoding] to base64 in order to avoid unwanted characters in the output. The subject line and any attachments are handled as above, with the exception of images embedded in the HTML. These are taken care of with the function [http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#method_addEmbeddedImage AddEmbeddedImage].

<source lang="php">
$body = '<h2>Our mail</h2>'
. '<div>A message to our dear readers'
. '<img src="cid:logo_id" alt="logo"/></div>';
$mailer->isHtml(true);
$mailer->Encoding = 'base64';
$mailer->setBody($body);
// Optionally add embedded image
$mailer->AddEmbeddedImage( JPATH_COMPONENT.'/assets/logo128.jpg', 'logo_id', 'logo.jpg', 'base64', 'image/jpeg' );
</source>

Normally you would leave any images on your server and refer to them with an ordinary HTML image tag, to reduce size of the mail and the time sending it.

=== Sending the Mail ===
The mail is sent with the function [https://api.joomla.org/cms-3/classes/JMail.html#method_Send Send]. It returns '''true''' on success or a JError object.

<source lang="php">
$send = $mailer->Send();
if ( $send !== true ) {
echo 'Error sending email: ';
} else {
echo 'Mail sent';
}
</source>

You would probably want to write your own error handler, if there is an error sending the mail.

The JMail object is used for sending mail in Joomla's contact manager. See the file joomla/components/com_contact/controller.php

===See also===
* [https://api.joomla.org/cms-3/classes/JFactory.html#method_getMailer JFactory->getMailer on api.joomla.org]

[[Category:Development]]
[[Category:Component Development]]

Sending email from extensions

2017-08-27T15:26:08Z

Toivo: /* Create the Mail */

{{Joomla version|version=2.5|time=and after}}
This is an example of how to send an email from a Joomla component. You would typically put this into your component's controller.
=== Fetch the Mail Object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

<source lang="php">
$mailer = JFactory::getMailer();
</source>

=== Set a Sender ===
The sender of an email is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSender setSender]. The function takes an array with an email address and a name as an argument. We fetch the site's email address and name from the global configuration. These are set in the administration back-end (Global Configuration -> Server -> Mail Settings).

<source lang="php">
$config = JFactory::getConfig();
$sender = array(
$config->get( 'mailfrom' ),
$config->get( 'fromname' )
);

$mailer->setSender($sender);
</source>

In 3.1, $config->getValue() should be changed to $config->get()

=== Recipient ===
You set the recipient of an email with the function [http://api.joomla.org/1.5/Joomla-Framework/Mail/JMail.html# addRecipient].
To set the email address to the currently logged in user, we fetch it from the user object.

<source lang="php">
$user = JFactory::getUser();
$recipient = $user->email;

$mailer->addRecipient($recipient);
</source>

If we had multiple recipients, we would put each recipient's email address in an array.

<source lang="php">
$recipient = array( 'person1@domain.com', 'person2@domain.com', 'person3@domain.com' );

$mailer->addRecipient($recipient);
</source>

=== Create the Mail ===
We need to set a subject line and create the text body. The subject is set with [https://api.joomla.org/cms-3/classes/JMail.html#method_setSubject setSubject].

The easy way to create an email body is as a string with plain text. Use the function [
https://api.joomla.org/cms-3/classes/JMail.html#method_setBody setBody] to add a message to the mail body. You can also attach a file with [https://api.joomla.org/cms-3/classes/JMail.html#method_addAttachment addAttachment]. It takes a single file name or an array of file names as the argument.

<source lang="php">
$body = "Your body string\nin double quotes if you want to parse the \nnewlines etc";
$mailer->setSubject('Your subject string');
$mailer->setBody($body);
// Optional file attached
$mailer->addAttachment(JPATH_COMPONENT.'/assets/document.pdf');
</source>

If you prefer to format your email in HTML, you need to tell the mailer it is HTML. This is done with [https://api.joomla.org/cms-3/classes/JMail.html#method_isHtml isHTML]. When sending HTML emails you should normally set the [
http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#property_Encoding Encoding] to base64 in order to avoid unwanted characters in the output. The subject line and any attachments are handled as above, with the exception of images embedded in the HTML. These are taken care of with the function [http://phpmailer.github.io/PHPMailer/classes/PHPMailer.html#method_addEmbeddedImage AddEmbeddedImage].

<source lang="php">
$body = '<h2>Our mail</h2>'
. '<div>A message to our dear readers'
. '<img src="cid:logo_id" alt="logo"/></div>';
$mailer->isHtml(true);
$mailer->Encoding = 'base64';
$mailer->setBody($body);
// Optionally add embedded image
$mailer->AddEmbeddedImage( JPATH_COMPONENT.'/assets/logo128.jpg', 'logo_id', 'logo.jpg', 'base64', 'image/jpeg' );
</source>

Normally you would leave any images on your server and refer to them with an ordinary HTML image tag, to reduce size of the mail and the time sending it.

=== Sending the Mail ===
The mail is sent with the function [https://api.joomla.org/cms-3/classes/JMail.html#method_Send Send]. It returns '''true''' on success or a JError object.

<source lang="php">
$send = $mailer->Send();
if ( $send !== true ) {
echo 'Error sending email: ';
} else {
echo 'Mail sent';
}
</source>

You would probably want to write your own error handler, if there is an error sending the mail.

The JMail object is used for sending mail in Joomla's contact manager. See the file joomla/components/com_contact/controller.php

===See also===
* [https://api.joomla.org/cms-3/classes/JFactory.html#method_getMailer JFactory->getMailer on api.joomla.org]

[[Category:Development]]
[[Category:Component Development]]

Sending email from extensions

2017-08-27T14:47:17Z

Toivo: /* Sending the Mail */

{{Joomla version|version=2.5|time=and after}}
This is an example of how to send an email from a Joomla component. You would typically put this into your component's controller.
=== Fetch the Mail Object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

<source lang="php">
$mailer = JFactory::getMailer();
</source>

=== Set a Sender ===
The sender of an email is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSender setSender]. The function takes an array with an email address and a name as an argument. We fetch the site's email address and name from the global configuration. These are set in the administration back-end (Global Configuration -> Server -> Mail Settings).

<source lang="php">
$config = JFactory::getConfig();
$sender = array(
$config->get( 'mailfrom' ),
$config->get( 'fromname' )
);

$mailer->setSender($sender);
</source>

In 3.1, $config->getValue() should be changed to $config->get()

=== Recipient ===
You set the recipient of an email with the function [http://api.joomla.org/1.5/Joomla-Framework/Mail/JMail.html# addRecipient].
To set the email address to the currently logged in user, we fetch it from the user object.

<source lang="php">
$user = JFactory::getUser();
$recipient = $user->email;

$mailer->addRecipient($recipient);
</source>

If we had multiple recipients, we would put each recipient's email address in an array.

<source lang="php">
$recipient = array( 'person1@domain.com', 'person2@domain.com', 'person3@domain.com' );

$mailer->addRecipient($recipient);
</source>

=== Create the Mail ===
We need to set a subject line and create the text body. The subject is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSubject setSubject].

The easy way to create an email body is as a string with plain text. Use the function [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setBody setBody] to add a message to the mail body. You can also attach a file with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#addAttachment addAttachment]. It takes a single file name or an array of file names as the argument.

<source lang="php">
$body = "Your body string\nin double quotes if you want to parse the \nnewlines etc";
$mailer->setSubject('Your subject string');
$mailer->setBody($body);
// Optional file attached
$mailer->addAttachment(JPATH_COMPONENT.'/assets/document.pdf');
</source>

If you prefer to format your email in HTML, you need to tell the mailer it is HTML. This is done with [http://api.joomla.org/Unknown/PHPMailer.html#methodIsHTML IsHTML]. When sending HTML emails you should normally set the [http://api.joomla.org/Unknown/PHPMailer.html#$Encoding Encoding] to base64 in order to avoid unwanted characters in the output. The subject line and any attachments are handled as above, with the exception of images embedded in the HTML. These are taken care of with the function [http://api.joomla.org/Unknown/PHPMailer.html#AddEmbeddedImage AddEmbeddedImage].

<source lang="php">
$body = '<h2>Our mail</h2>'
. '<div>A message to our dear readers'
. '<img src="cid:logo_id" alt="logo"/></div>';
$mailer->isHtml(true);
$mailer->Encoding = 'base64';
$mailer->setBody($body);
// Optionally add embedded image
$mailer->AddEmbeddedImage( JPATH_COMPONENT.'/assets/logo128.jpg', 'logo_id', 'logo.jpg', 'base64', 'image/jpeg' );
</source>

Normally you would leave any images on your server and refer to them with an ordinary HTML image tag, to reduce size of the mail and the time sending it.

=== Sending the Mail ===
The mail is sent with the function [https://api.joomla.org/cms-3/classes/JMail.html#method_Send Send]. It returns '''true''' on success or a JError object.

<source lang="php">
$send = $mailer->Send();
if ( $send !== true ) {
echo 'Error sending email: ';
} else {
echo 'Mail sent';
}
</source>

You would probably want to write your own error handler, if there is an error sending the mail.

The JMail object is used for sending mail in Joomla's contact manager. See the file joomla/components/com_contact/controller.php

===See also===
* [https://api.joomla.org/cms-3/classes/JFactory.html#method_getMailer JFactory->getMailer on api.joomla.org]

[[Category:Development]]
[[Category:Component Development]]

Sending email from extensions

2017-08-27T14:44:18Z

Toivo: /* See also */

{{Joomla version|version=2.5|time=and after}}
This is an example of how to send an email from a Joomla component. You would typically put this into your component's controller.
=== Fetch the Mail Object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

<source lang="php">
$mailer = JFactory::getMailer();
</source>

=== Set a Sender ===
The sender of an email is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSender setSender]. The function takes an array with an email address and a name as an argument. We fetch the site's email address and name from the global configuration. These are set in the administration back-end (Global Configuration -> Server -> Mail Settings).

<source lang="php">
$config = JFactory::getConfig();
$sender = array(
$config->get( 'mailfrom' ),
$config->get( 'fromname' )
);

$mailer->setSender($sender);
</source>

In 3.1, $config->getValue() should be changed to $config->get()

=== Recipient ===
You set the recipient of an email with the function [http://api.joomla.org/1.5/Joomla-Framework/Mail/JMail.html# addRecipient].
To set the email address to the currently logged in user, we fetch it from the user object.

<source lang="php">
$user = JFactory::getUser();
$recipient = $user->email;

$mailer->addRecipient($recipient);
</source>

If we had multiple recipients, we would put each recipient's email address in an array.

<source lang="php">
$recipient = array( 'person1@domain.com', 'person2@domain.com', 'person3@domain.com' );

$mailer->addRecipient($recipient);
</source>

=== Create the Mail ===
We need to set a subject line and create the text body. The subject is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSubject setSubject].

The easy way to create an email body is as a string with plain text. Use the function [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setBody setBody] to add a message to the mail body. You can also attach a file with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#addAttachment addAttachment]. It takes a single file name or an array of file names as the argument.

<source lang="php">
$body = "Your body string\nin double quotes if you want to parse the \nnewlines etc";
$mailer->setSubject('Your subject string');
$mailer->setBody($body);
// Optional file attached
$mailer->addAttachment(JPATH_COMPONENT.'/assets/document.pdf');
</source>

If you prefer to format your email in HTML, you need to tell the mailer it is HTML. This is done with [http://api.joomla.org/Unknown/PHPMailer.html#methodIsHTML IsHTML]. When sending HTML emails you should normally set the [http://api.joomla.org/Unknown/PHPMailer.html#$Encoding Encoding] to base64 in order to avoid unwanted characters in the output. The subject line and any attachments are handled as above, with the exception of images embedded in the HTML. These are taken care of with the function [http://api.joomla.org/Unknown/PHPMailer.html#AddEmbeddedImage AddEmbeddedImage].

<source lang="php">
$body = '<h2>Our mail</h2>'
. '<div>A message to our dear readers'
. '<img src="cid:logo_id" alt="logo"/></div>';
$mailer->isHtml(true);
$mailer->Encoding = 'base64';
$mailer->setBody($body);
// Optionally add embedded image
$mailer->AddEmbeddedImage( JPATH_COMPONENT.'/assets/logo128.jpg', 'logo_id', 'logo.jpg', 'base64', 'image/jpeg' );
</source>

Normally you would leave any images on your server and refer to them with an ordinary HTML image tag, to reduce size of the mail and the time sending it.

=== Sending the Mail ===
The mail is sent with the function [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#Send Send]. It returns '''true''' on success or a JError object.

<source lang="php">
$send = $mailer->Send();
if ( $send !== true ) {
echo 'Error sending email: ';
} else {
echo 'Mail sent';
}
</source>

You would probably want to write your own error handler, if there is an error sending the mail.

The JMail object is used for sending mail in Joomla's contact manager. See the file joomla/components/com_contact/controller.php

===See also===
* [https://api.joomla.org/cms-3/classes/JFactory.html#method_getMailer JFactory->getMailer on api.joomla.org]

[[Category:Development]]
[[Category:Component Development]]

J3.x:Global configuration

2016-09-21T06:37:51Z

Toivo:

<noinclude><languages /></noinclude>
{{incomplete}}
{{Joomla version|version=3.0|time=and later}}
<translate>
This article expands on the information given about Global Configuration in the Joomla online Help, and also to provide hints and tips about use of the settings found in this part of the administrative interface. The Global Configuration area is part of the administrative interface (also referred to as the “backend”), accessed via</translate>

<pre>http://<translate>
pathtojoomla</translate>/administrator</pre>

<translate>
This area is accessible only if you are logged-in as a member of a group having the attribute of being Super Administrators (by default the Super Users group only). Once logged in, to access the page:</translate>

<translate>
* go to {{rarr|System,Global Configuration}} or
* click the Global Configuration icon</translate> {{-}}[[File:J3x-global-config-quick-icon.png]]{{-}}

<translate>
from the main control panel.</translate>

<translate>== Overview == 
As the name implies, Global Configuration is the area of the Joomla administrative interface where a user with Super Administrator attributes is able to make changes that globally affect the behaviour of the web site and also alter some default settings for the presentation of, and access to site content.</translate>

<translate>
All the parameters under the Site, System and Server tabs in the Global Configuration are stored as values in the file ''configuration.php'', which you will find in the root folder of Joomla installation. This file is set up automatically by the software installation process and thus many of the parameters appearing in the Global Configuration screens are best left as their initial settings. Should Joomla be unable to update ''configuration.php'' a message such as "Could not save data. Error: Could not write to the configuration file." will be displayed, rather than the usual "Configuration successfully saved.". There are a number of ways of overcoming this problem, please refer to [[S:MyLanguage/Cannot save Global Configuration changes|Cannot save Global Configuration changes]] for further information.</translate>

<translate>
The parameters controlled by a third tab, Permissions, (present only with Joomla v1.6.x and later) differ from those controlled via the other tabs in that they are stored within the web site's database.</translate>

<translate>== The Toolbar == 
The Global Configuration toolbar consists of four buttons to enable the user to save changes, move away from the Global Configuration page and call up online Help pages. Toolbars differ between Joomla v1.5.x and the later versions, in respect of naming and order of buttons.</translate>

<translate>=== The Joomla 3.x Toolbar === 
* '''Save.''' Saves any changes made under any tab and the Global Configuration screen remains open so that editing or checking of global parameters can continue.
* '''Save & Close'''. As Save, but returns to the Administrator welcome screen.
* '''Cancel.''' Returns to the Administrator welcome screen without saving any changes to the Global Configuration.
* '''Help. '''Opens the Help Screen for Global Configuration.</translate>

<translate>== The Site Tab Options == 
'''Note: '''the order in which these items appear on the screen vary slightly between the different versions of Joomla.</translate>

<translate>=== “Site Settings” Group === 
This group of options control a miscellaneous collection of parameters that broadly control the behaviour of the public web pages of the Joomla site.</translate>

<translate>
* '''Site Name.''' The name of the web site. This text provides an single-point of update of the site name and is frequently used by site templates as the header text of each web page.</translate>

<translate>
* '''Site Offline.''' This setting provides a means of putting a site offline to general users by changing the default setting of “No” to “Yes”. When offline the public pages of the web site will be replaced by the Offline Message (see below) and a log-in form. Only Administrators are able to log in the site when set to offline using this option. Once logged-in, Administrators are able to see the web site and work on it as normal.</translate>
<translate>
* '''Offline Message.''' The message that will be displayed on the site when the site is offline. It may be changed to provide something more helpful than the default message. This could be a date or time when the site will be back online, or the URL of an alternative web site that any visitors could use.</translate>
<translate>
* '''Default Editor.''' The default text [http://help.joomla.org/proxy/index.php?option=com_help&view=help&keyref=Content_creators#Content_Editors editor] for use when creating or updating articles on the site. This may be “No editor” (edit raw HTML code only), one of editors pre-installed in Joomla, or an editor installed subsequently as an extension. The editor loaded when a registered site user starts editing text content may be overridden on a user-by-user basis, but in the absence of any such override it will be the Default Editor as set here.</translate>
<translate>
* '''Default Access Level.''' (only present in Joomla v1.6.x and later) The access level given by default to new content items, menu entries, etc. By default this is “Public”, but could be changed to other levels if – for example – it was undesirable for newly created items to be visible to all site users. The access level for any items may be overridden when created, or changed at a later point by anyone logged-in with the appropriate permissions.</translate>
<translate>
* '''Default List Limit.''' This sets the maximum number of items per page in lists displayed in various pages of the Joomla administrative interface, although this value may be overridden temporarily within the list pages themselves. By default, this parameter is set to 20 but may be changed to any of a number of values ranging from 5 to 100. <br />'''Tip:''' Use a larger value (50 or 100) than the default as it is usually easier to scroll up and down a list on a single page than to move between lots of short pages. Also if all items are on one page, it is much easier to carry out a global search, for example for text in an article title.</translate>
<translate>
* '''Default Feed Limit.''' The number of content items to be shown in any RSS newsfeeds set up on the web site. By default, this is set to 10, although unless the site is very active a smaller number may be better.</translate>
<translate>
* '''Feed Email.''' Atom and RSS newsfeeds generated from site content by the Joomla “Syndicate feeds” (“Syndication” in Joomla v1.5.x) site module may include an e-mail address as part of the author's identity. This parameter determines the source of that email address: the “Author Email” setting will use the email address held on the site for content author, “Site E-mail” will use the “From email” address set up under the Server tab (see below) for emails generated automatically by the web site.<br />'''Tip:''' “Site E-mail” is usually the preferred setting if content syndication is being used on a web site. This is because the alternative will expose the content authors' email addresses to collection by spam lists.</translate>

<translate>=== “Metadata Settings” Group === 
This group of options control the presence or content of several of the metadata entries (i.e. code like ''<nowiki><meta name = …. \></nowiki>'') in the header of each page of the web site. Although not visible to the site user, metadata entries may be used in various ways by web search engines and their appropriate use can significantly aid the search rankings and visibility of a web site. Note that several of the following metadata parameters may be overridden for the content categories and individual content items.</translate>

<translate>
* '''Site Meta Description.''' Text added here appears in web page headers as the “description” metadata entry. Search engines often use this to provide descriptive text for your web pages in place some (possibly inappropriate) text from the content of the web page. A description of around 20 words is recommended. This metadata entry is omitted from web pages if this entry is blank.</translate>
<translate>
* '''Site Meta Keywords.''' Words and phrases (separated by commas) added here appear in web page headers as the “keywords” metadata entry. Search engines may use these words to refine their indexing of the site's web pages. This metadata entry is omitted from web pages if this entry is blank.</translate>
<translate>
* '''Content Rights.''' (Only present in Joomla v1.6.x and later.) Text added here appears in web page headers as the “rights” metadata entry. If appropriate, describe here what rights others have to use this content. This metadata entry is omitted from web pages if this entry is blank.</translate>
<translate>
* '''Show Author Meta Tag.''' When this parameter is set to “Yes” an “author” metadata entry is added to the page header when appropriate, using the content item's author name as the metadata text.</translate>

<translate>=== “SEO Settings” Group === 
SEO is an abbreviation of ''Search Engine Optimization''. Settings in this group alter the format of URLs for pages in the web site, and this may have a significant effect of the search rankings of individual pages, as well as making URLs more human-friendly.</translate>

<translate>
'''Tip:''' after making any changes to the settings in this group, refresh any of the web site's pages already open in your web browser (usually Ctrl+R will do this). Failure to so this will likely mean that the format of web links internal to the site no longer match that which Joomla is expecting and thus give the appearance of broken links.</translate>

<translate>
'''Tip: '''Avoid if at all possible altering the SEO Settings once a web site is established. Changing any of the first three items below will mean that nearly all of a site's URLs will also change and result in broken links from other sites and perhaps a temporary drop in search engine rankings.</translate>

<translate>
* '''Search Engine Friendly URLs.''' Joomla's internal representation of URLs tends to be lengthy and also difficult to interpret by humans and search engine spiders. This is a typical example of the internal URL for a page displaying a content item: <tt>www.example.com/index.php?option=com_content&view=article&id=22&Itemid=437</tt>. If this Global Configuration option is set to “yes”, the URL is modified into a shorter and more meaningful form: <tt>www.example.com/index.php/getting-started</tt>. The identifying text in the URL (in this case “getting_started”) is derived from the Alias text set up for each Category, content item, and Menu item. The default setting is “No”.</translate>
<translate>
* '''Use Apache mod_rewrite. '''When this parameter is set to “Yes“, Joomla will use the mod_rewrite function of Apache web servers to eliminate the ''index.php'' part of the URL. Thus when this is operating the “search engine friendly” URL shown above will become: <tt>www.example.com/getting-started</tt>.<br />'''Note:''' This parameter is set to “No” by default. It should not be set to “Yes” unless the web server uses Apache software and has been set up so that mod_rewrite is installed and will work with your web site (see [[S:MyLanguage/How to check if mod rewrite is enabled on your server|here]] for how to check). Also for this function to work, the ''htaccess.txt'' file installed in the root directory of the web site (or preferably a copy of it) should be renamed to ''.htaccess''. As an incorrectly configured ''.htaccess'' file can easily cause major server errors, so do not modify the ''.htaccess'' file unless you understand how it works.</translate>
<translate>
* '''Adds Suffix to URL.''' When set to “Yes”, Joomla will add ''.html'' to the end of the most site URLs thus simulating static file-based web content. The URLs shown above will then become: <tt>www.example.com/index.php/getting-started.html</tt> or <tt>www.example.com/getting-started.html</tt>. This setting is largely down to personal preference, but bearing in mind that it is easy to confuse ''.htm'' and .''html'' suffixes when typing URLs, the advantage my lie with having this feature switched off. The default setting is “No”.</translate>
<translate>
* '''Unicode aliases. '''(Only present in Joomla v1.6.x and later.) Choose between “Transliteration” (No) and “Unicode” (Yes) aliases. When saving edited content, the former setting attempts to convert, where appropriate, any alias text into the corresponding Latin characters. The latter setting leaves any non-Latin characters in the alias text unchanged. Changing this parameter does not retroactively change aliases, it just changes the behaviour of automatic alias generation for future content editing and creation. “Transliteration” (No) is the default setting.</translate>
<translate>
* '''Add Site Name To Page Titles.''' (Only present in Joomla v1.6.x and later.) Appends the site name to page titles in the ''<nowiki><title></nowiki>'' tag of each web page header. (This text usually appears in the top bar of the web browser window and/or on the browser tab.) Joomla v1.6.x introduced this feature as an option to either include the site name text before the page title (e.g. ''Site Name – Page Name'') or omit it. With Joomla v1.7.x the options also include inserting the site name after the page name (e.g. ''Page Name – Site Name'') as well as before.</translate>

<translate>=== “Cookie Settings” Group === 
Only present in Joomla v1.6.x and later, these settings allow the site cookies to be modified to suit certain circumstances. For the majority of web sites these entries may be left blank. The cookie domain may be useful if you want a cookie be valid for several subdomains. The cookie path would have to be set if the cookie should only be valid for a certain subdirectory.</translate>

<translate>
* '''Cookie Domain.''' Overrides the site's default cookie domain with the domain added here. The most likely situation when this would be needed is when the Joomla site is “bridged“ with other sites (e.g. forum or e-commerce) in sub-domains of the Joomla site. The default cookie domain may be like <tt>www.example.com</tt>, but using <tt>.example.com</tt> (note the leading dot) here will deliver cookies valid for any sub-domain of example.com.</translate>
<translate>
* '''Cookie Path.''' Overrides the site's default path for which the cookie is valid with the path added here.</translate>

<translate>== The System Tab Options == </translate>
<translate>=== “System Settings” Group=== </translate>
<translate>
* '''Path to Log Folder.''' The full path to the folder on the server where any logs should be stored by Joomla! or its extensions. This folder location is set up on Joomla installation and should not normally be changed.</translate>
<translate>
* '''Help Server.''' Select the default source of the information presented when a Help button is clicked. The purpose of this choice is mainly to select the appropriate language variant of the Help service. The choice of Help service may be overridden for individual registered site users.</translate>

<translate>=== “Debug Settings” Group=== </translate>
<translate>
* '''Debug System.''' If set to “Yes”, Joomla will add debug information on every page, below the normal web page area. This information will include various forms of diagnostic information, including the full database queries used in generating the page. The default setting is “No”. The mix and format of diagnostic information presented by the debug function may be altered by editing the parameters of the Debug - System plug-in (Extensions > Plug-in Manager).<br/>'''Note:''' the debug information displayed with this parameter set to “Yes” is visible to all users and thus may be a security risk if used on a public web site. The debug information is visible even if Site Offline is set to “Yes”.</translate>
<translate>
* '''Debug Language. '''<nowiki>If set to “Yes”, Joomla will activate features designed to help debug language translations for a Joomla site. This includes the addition of language translation information to page debug information (requires Debug System also set to “Yes”), and markers to show translated content within the web pages themselves. For further information, refer to</nowiki> [[S:MyLanguage/Debugging a translation|Debugging a translation]].</translate>

<translate>=== “Cache Settings” Group=== </translate>

<translate>
* '''Cache''' This setting controls whether or not site caching is enabled. When enabled, web pages are held for a period of time in cache storage and are retrieved from there rather than being re-created each time required. Caching is a strategy to reduce the loading presented by busy web sites to a web server. The default setting is “No”.<br/>'''Tip: '''When debugging a Joomla site, switch off the cache as it may hide changes to web pages, and thus mask the effect of modifications to web site code.</translate>
<translate>
* '''[[S:MyLanguage/Cache|Cache Handler]].''' This setting defines the mechanism used to manage the cache storage.</translate>
<translate>
* '''Cache Time.''' This parameter defines the maximum time for which web pages are held in the cache storage before being updated with the current version. The default is 15 minutes.</translate>

<translate>=== “Session Settings” Group=== 
The “session” is the data that identifies and relates to a specific web site user, and which persists as that user moves from page to page.</translate>

<translate>
* '''Session Lifetime.''' This parameter determines how long it takes until a user is automatically logged off for being inactive. The default setting is 15 minutes, although it can be useful to temporarily lengthen this parameter on development sites to avoid having to repeatedly log back in.</translate>
<translate>
* '''Session Handler.''' Selects the mechanism used to hold session information between one page request and the next one from the same user. The options are “Database” (the default) and “None”. The former stores session information as entries in a table in the site's Joomla database, the latter uses the session handling mechanism built in to PHP.</translate>

<translate>== The Server Tab Options == </translate>
<translate>=== “Server Settings” Group === 
* '''Path to Temp Folder.''' This is the full path to the folder on the server that Joomla and its extensions will use for temporary file storage. This folder location is set up on Joomla installation and should not normally be changed.</translate>
<translate>
* '''GZIP Page Compression.''' If set to “Yes”, the web server will compress the content sent out from your Joomla site. This will speed-up page load times, especially for web site users who have a low-bandwidth connection. The default setting is “No”.</translate>
<translate>
* '''Error Reporting. '''This parameter sets the level of error reporting to be used by PHP on the Joomla site. It has five options: System Default, None, Simple, Maximum and Development. “System Default” leaves the level of PHP error reporting to that set up in the server (usually in the ''php.ini'' file). “None” switches off PHP error reporting, and “Simple”, “Maximum” and “Development” override the server setting to give a basic level of reporting (for “Simple”) and the reporting of all errors (“Maximum” and “Development”). <br/>'''Tip:''' Should your Joomla site fail to the extent that it is not possible to use the Administrator pages to activate error reporting, you can switch on full PHP error reporting by editing the ''configuration.php'' file. Changing the ''$error_reporting'' parameter in that file to a value of 'maximum' is the equivalent to setting Error Reporting to “Maximum”.</translate>
<translate>
* '''Force SSL.''' This parameter has three options: “None”, “Administrator Only”, and “Entire Site”. Using the appropriate setting, this parameter forces any web browser connections to the administrative “backend”, or to the complete Joomla site, to use the secure HTTP protocol (HTTPS). The “Entire Site” setting is appropriate where security of any web transaction (e.g. e-commerce) is important. Ideally there should also be an appropriate certificate in place to verify the identity of your web site. The “Administrator Only” setting is ideal for enhancing the security of other types of web site as it encrypts “backend” content and passwords that could be put to malicious use if intercepted. <br/>'''Note:''' before moving away from the default setting of “None”, it is essential that you check the server delivering your web site is capable of operating in HTTPS mode.</translate>

<translate>=== “Location Settings” Group === </translate>
<translate>
* '''Server Time Zone.''' Sets the time zone for use across the web site, based on a choice of capital cities. (default is “London”, UTC 00:00) Internally, Joomla stores the [[wikipedia:Coordinated_Universal_Time|date and time of events as UTC]]. It then uses “Server Time Zone” to set the appropriate offset to display time and date information on the web site in the server's local time zone. '''Note:''' that each user also has a time zone parameter that, by default, is the same as the Server Time Zone but which may be changed to reflect the preferred time zone of that user.</translate>

<translate>=== “FTP Settings” Group === </translate>
<translate>
A significant problem with running scripted programs – such as Joomla – on Linux and similar servers is that the files and folders making up the program are not owned by the same identity as the one used to execute the web server code. The files and folders making up the web site will usually be put in place on the server by means of FTP, and thus will be owned by the personal log-in identity used for FTP access. In contrast, the web server code will be executed by a generic identity used for automatic processes within the server.</translate>

<translate>
Because of this difference between the FTP upload and web server identities, automatic updates of the web site code (e.g. installing or updating extensions) will be blocked by the security features that prevent one user's files being altered by another user.</translate>

<translate>
One solution to this problem is for Joomla to use FTP when installing or deleting files, and if this is used it is essential that the FTP log-on credentials are the same as those used when installing the Joomla web site.</translate>

<translate>
The FTP option is generally only needed on shared servers using Linux and Unix-like operating systems. The problem does not arise with other operating systems, and on dedicated servers there is the alternative option of changing the ownership and/or permissions of the web site files so that they may be modified by the web server processes.</translate>

<translate>
FTP is also not necessary when the Joomla site has been set up to operate under CGI or FastCGI as the web server process then generally operates under the same identity as the one used for FTP access.</translate>

<translate>
* '''Enable FTP.''' Setting this to “Yes” will force Joomla to use FTP when adding, deleting, or updating web site files. This is in place of the PHP functions which would normally be used to do this. The default setting is “No”, and should not be changed unless FTP upload is necessary (see the detail above).</translate>
<translate>
* '''FTP Host.''' The URL to be used for FTP access to the Joomla web site files.</translate>
<translate>
* '''FTP Port. '''Generally “21”. You will be advised by your web hosting provider if a different port number needs to be used for FTP access to your site files.</translate>
<translate>
* '''FTP Username.''' The user identity that Joomla will use for FTP access. This must be the same identity as used in setting up the web site.</translate>
<translate>
* '''FTP Password. '''The password for the above user identity.</translate>
<translate>
* '''FTP Root.''' This is the path from the FTP log-in location to the folder that holds the Joomla site.</translate>

<translate>=== “Database Settings” Group === 
These parameters identify the database location, the database and tables within that database that hold configuration and content information for your web site. It also includes the username required for accessing the database contents, but '''not''' the password associated with that username. Should you need to change the database password, edit the line defining the value of ''$password'' in the file ''configuration.php'', which you will find in the Joomla root.</translate>

<translate>
* '''Database Type.''' This determines the type of the database being used by this Joomla installation and also the type of interface used to access the database. Current versions of Joomla can operate on MySQL, MSSQL and PostgreSQL. For MySQL there are two choices:“MySQL” and “MySQLi”. These are two different PHP interfaces to MySQL databases. The latter should be used if possible as it should work with all modern implementations of MySQL server, and offers a number of advantages over the MySQL interface.<ref>[http://php.net/manual/en/mysqli.overview.php PHP MySQLi Overview]</ref> For MSSQL also two choices: MS SQL Server and MS SQL Azure.</translate>
<translate>
* '''Host '''('''Hostname''' in v1.5,x). The hostname of the database server to be used. In most web hosting situations, the database server is located in the same system as the web server and this parameter should then be set to “localhost”. Otherwise this setting should be the server name or IP address (e.g. “mysql.example.com”).</translate>
<translate>
* '''Database Username''' ('''Username''' in v1.5.x). The username required to access the database carrying the Joomla site's data tables.</translate>
<translate>
* '''Database Name''' ('''Database''' in v1.5.x). The name of the database carrying the Joomla site's data tables.</translate>
<translate>
* '''Database Table Prefix. '''The prefix applied to the name of the database tables used by this Joomla installation. For Joomla v1.5.x and v1.6.x this is “jos_” by default, and should another Joomla site have to share the same database, the database tables would be kept separate by setting up this second site with a different prefix – e.g. “jos2_”. With Joomla v1.7.x the same result is achieved by using a prefix that is a randomly generated alphabetic code and underscore – e.g. “vduea_”.</translate>

<translate>=== “Mail Settings” Group === 
This group is used to set up the sending of automatically generated emails from the Joomla! web site.</translate>

<translate>
* '''Mailer.''' This sets the mechanism to be used when sending automatically generated emails. The choice is between “PHP Mail” (the PHP ''mail()'' function), “Sendmail” (an email handling program available in many web servers), or “SMTP” (a separate email delivery server similar to those used by most email clients). The default setting is “PHP Mailer”.</translate>
<translate>
* '''From email''' ('''Mail from''' in v1.5.x). The email address to be used as “from” address in any outgoing emails generated by the Joomla site.</translate>
<translate>
* '''From Name.''' This defines the “from” name in any outgoing emails generated by the Joomla site.</translate>
<translate>
* ''' Disable Mass Mail.''' Select "Yes" to disable the Mass Mail Users function, select "No" to make it active. Mass Mail allows to send emails to all or to a specific group of registered users.</translate>

<translate>
The remaining Mail Settings parameters need to be set up only if Mailer is set to “SMTP”.</translate>

<translate>
* '''SMTP Authentication. '''Whether or not the external SMTP server requires authentication before accepting outgoing emails. The default is “No”.</translate>
<translate>
* '''SMTP Security. '''The form of security required by the SMTP server. – “None”, “SSL” or “TLS”. The default is “None”.</translate>
<translate>
* '''SMTP Port. '''The IP port to use when connecting to the SMTP server. This will usually be “25” for None, or “465” for SSL or TLS.</translate>
<translate>
* '''SMTP Username. '''The username to be used when connecting to the SMTP server in SSL or TLS mode. May be left blank if there is no SMTP authentication.</translate>
<translate>
* '''SMTP Password.''' The password to be used when connecting to the SMTP server in SSL or TLS mode. May be left blank if there is no SMTP authentication.</translate>
<translate>
* '''SMTP Host. '''The hostname of the SMTP server (e.g. “smtp.example.com”).</translate>

<translate>== The Permissions Tab Options == 
This tab is only present in Joomla v1.6.x and later as it reflects the enhanced flexibility of access control introduced with v1.6. It provides the means to set up the default permissions for all of the groups of users in terms their ability to edit site content and other settings of the site, and to access administrative functions.</translate>

<translate>
There are comprehensive descriptions of the use of the settings under this tab and the general principles of operation and set-up of permissions in Joomla v1.6 and later here: [[S:MyLanguage/J3.x:Access Control List Tutorial#Global_Configuration|ACL Tutorial for Joomla 3.x]].</translate>

<translate>==References== </translate>
<references>

<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.4]]
[[Category:Installation]]
[[Category:Security]]
[[Category:Global Configuration Management]]
[[Category:FAQ]]
</translate>
</noinclude>

Web page diagnostic tools

2015-01-04T09:47:22Z

Toivo: Fixed broken links to Firefox addons, added Joomla Developer Toolbox

Many browsers can act as platforms for diagnostic tools. You can analyze Web pages built with any version of Joomla by using them. These browser tools have many built-in features such as a DOM Inspector, JavaScript Debugger, Network Inspector, Resources Inspector, Storage Inspector, Profiler, Error Log, Remote Debugging, etc. These tools make it easier to see and debug exactly what is being processed by a browser when rendering a web page.
<noinclude>{{RightTOC}}</noinclude>
=== Mozilla Firefox Web Browser ===
* [http://getfirebug.com Firebug] is an Add-on for Firefox 1.5+
::For more information, please watch [[Using Firebug With Your Joomla Website|the free video tutorial on using Firebug with Joomla]].)
::[[File:Screenshot-368firebug.png|350px]]
{{clear}}
* [http://addons.mozilla.org/en-US/firefox/addon/web-developer Web Developer] toolbar (Firefox 1+, Flock, Seamonkey)
* [http://addons.mozilla.org/en-US/firefox/addon/css-viewer CSS Viewer] (Firefox 1.5+)
* [http://addons.mozilla.org/en-US/firefox/collections/joomla-quickstart/joomla-developer-toolbox/ Joomla Developer Toolbox - a collection of essential extensions for web developers] (Firefox 1+)

=== Internet Explorer Web Browser ===
* [http://www.microsoft.com/downloads/details.aspx?familyid=e59c3964-672d-4511-bb3e-2d5e1db91038 Microsoft Internet Explorer Developer Toolbar] (MSIE 7)
* [http://www.debugbar.com/?langage=en DebugBar] (MSIE 5 - 8, free for personal use)
* MSIE 8+, press SHIFT+F12 or click the [http://msdn.microsoft.com/en-us/library/cc304131(VS.85).aspx Developer Tools] icon in the command bar
* Users of Office XP and later may also install the "Script Debugger" via Office Setup. (The debugger is not installed by default.)

=== Opera Web Browser ===
Opera has a built-in diagnostic tool called Dragonfly.
When viewing the page, right click and choose "Inspect Element" to start Dragonfly.
* [http://www.opera.com/dragonfly/documentation/ Introduction to Opera Dragonfly] (Opera 10+)
{{#ev:youtube|BeTzJ-HGLo4}}
=== Safari Web Browser ===
* How to enable the [http://developer.apple.com/internet/safari/faq.html#anchor14 Safari 3.x Developer Menu] ({{os|mac}} {{os|win}})
* [http://webkit.org/blog/61/introducing-drosera/ WebKit Drosera JavaScript Debugger] ({{os|mac}} WebKit: {{os|linux}})
<noinclude>
[[Category:Development Reference]]
[[Category:Template Development]]
[[Category:Template Reference]]
</noinclude>

Chunk:Module Position

2014-06-27T20:30:05Z

Toivo: 'They' replaced with 'Placeholders'

<translate>

A module position is a placeholder in a [[template]]. Placeholders identify one or several positions within the template and tell the Joomla! application where to place output from modules assigned to a particular position. The template designer has complete control over module positions, creating variations between templates and the respective Joomla! default positions assigned to modules in the installation sample data.


For example, the module position '''Left''' could be defined to be on the left side of the template to display a site navigation menu. So if a module is assigned the '''Left''' position, it will be displayed wherever the designer puts that '''Left''' module position - not necessarily the left side of the page.
<noinclude>[[Category:Glossary definitions|{{PAGENAME}}]]</noinclude></translate>
<noinclude>
== Languages ==
<languages /></noinclude>

How do I use Gmail as my mail server?

2014-05-05T10:07:20Z

Toivo: explained uncommenting

If you have a working Gmail account you can use Gmail as your mail server by setting it in the global configuration.

On the server tab set the following:

*Mailer: SMTP
*Set the next three lines with your information, leave your path untouched unless you are sure it needs to change for some reason.
*SMTP Authentication: Yes
*SMTP Security: SSL
*SMTP Port 465
*SMTP username: your gmail username
*SMTP password: your gmail password
*SMTP host: smtp.gmail.com

The following is also a working combination:
*SMTP Security: TLS
*SMTP Port 587

The SSL module does not need to be enabled in Apache.

The OpenSSL extension needs to be enabled in PHP. The details can be found at http://www.php.net/manual/en/openssl.installation.php

If you are using WAMP on Windows, the openssl module is not enabled by default and you need to enable it. To do this:
# Open the php.ini file and uncomment the line <code>extension=php_openssl.dll</code> by removing the semicolon ; from the beginning of the line.
# Save the php.ini file and restart the Apache service.

{{tip|title=Note|Note that if you use 2-step verification in Gmail, you need to add a new password in Settings - Accounts - Change accounts settings - Other Google Account settings - Security - 2-step verification - Manage your application specific passwords.}}

When the new Application Specific Password (ASP) is presented in groups of four characters separated by spaces, make sure that you '''do NOT enter the spaces''' into the SMTP password in the mail server settings in Joomla.

* Application Specific Passwords (ASPs): https://support.google.com/accounts/answer/185833
* 2-Step Verification: https://support.google.com/accounts/answer/1070457

<noinclude>[[Category:FAQ]][[Category:Server configurations]]</noinclude>

How do I use Gmail as my mail server?

2014-01-25T12:21:15Z

Toivo: Corrected references to SSL in Apache, added the need for SSL in PHP, added links to Google ASP and 2-step verification instructions

If you have a working Gmail account you can use Gmail as your mail server by setting it in the global configuration.

On the server tab set the following:

*Mailer: SMTP
*Set the next three lines with your information, leave your path untouched unless you are sure it needs to change for some reason.
*SMTP Authentication: Yes
*SMTP Security: SSL
*SMTP Port 465
*SMTP username: your gmail username
*SMTP password: your gmail password
*SMTP host: smtp.gmail.com

The following is also a working combination:
*SMTP Security: TLS
*SMTP Port 587

The SSL module does not need to be enabled in Apache.

The OpenSSL extension needs to be enabled in PHP. The details can be found at [http://www.php.net/manual/en/openssl.installation.php]

If you are using WAMP on Windows, the openssl module is not enabled by default and you need to enable it. To do this:
# Open the php.ini file and uncomment out the line <code>extension=php_openssl.dll</code>.
# Save the php.ini file and restart the Apache service.

Note that if you use 2-step verification in Gmail, you need to add a new password in Settings - Accounts - Change accounts settings - Other Google Account settings - Security - 2-step verification - Manage your application specific passwords.

When the new Application Specific Password (ASP) is presented in groups of four characters separated by spaces, make sure that you do NOT enter the spaces into the SMTP password in the mail server settings in Joomla.

Application Specific Passwords (ASPs): [https://support.google.com/accounts/answer/185833]

2-Step Verification: [https://support.google.com/accounts/answer/1070457]

<noinclude>[[Category:FAQ]][[Category:Server configurations]]</noinclude>

What do the locks mean and how do you get rid of them?

2013-11-04T10:58:10Z

Toivo: Added reference to the "Close" button and the tooltip popup

At any given time you may see a padlock next to a specific item in Joomla!'s administrative backend. These padlocks may be displayed next to any of the following (Content Items, Menu Items, Modules, etc).

The Joomla! system places these padlocks next to an item to indicate that a user is currently editing the item (i.e. the item is "checked out"). The lock is removed when the user clicks on the "Save" or "Close" button for that item. If the user never clicks "Save" or "Close" and instead hits the "Back" button or navigates to another page, then the item remains locked. If a different user needs to work with an item that is in the "checked out" state he or she must first ask a manager or administrator to check the item in before any new changes can be made.

=Joomla 2.5 and newer {{JVer|2.5}}{{JVer|3.x}}=
There are three ways of checking items back in. One way is to contact the person that has the item checked out to see if they are done with the item. You can hover the cursor above the lock and the tooltip popup will display the name of the user who checked out the article.

If you have access to the administrative backend and sufficient rights and can also either click on the padlock to check only this item back in or click on Site->Maintenance->Global Check-in to check all items in.

The later option should be used very carefully, especially in multi-user environments. This single action checks in all previously checked out items, whether they were checked out by you or not. Possible undesirable side effects may be that multiple editors end up working on the same document. In this case whoever clicks the save button last has their version saved as the final copy.

=Joomla 1.5 and older {{JVer|1.0}}{{JVer|1.5}}=
There are two ways of checking items back in. One way is to contact the person that has the item checked out to see if they are done with the item. This can be difficult if you do not know who has the item checked out.

The other option utilises the administrative back end; Click on "System => Global check in" This option should be used very carefully, especially in multi-user environments. This single action checks in all previously checked out items, whether they were checked out by you or not. Possible undesirable side effects may be that multiple editors end up working on the same document. In this case whoever clicks the save button last has their version saved as the final copy.

<noinclude>[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.0 FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Version 1.6 FAQ]]
[[Category:Version 1.7 FAQ]]</noinclude>

How do I use Gmail as my mail server?

2013-10-10T14:01:20Z

Toivo: fixed typo

If you have a working Gmail account you can use Gmail as your mail server by setting it in the global configuration.

On the server tab set the following:

*Mailer: SMTP
*Set the next three lines with your information, leave your path untouched unless you are sure it needs to change for some reason.
*SMTP Authentication: Yes
*SMTP Security: SSL
*SMTP Port 465
*SMTP username: your gmail username
*SMTP password: your gmail password
*SMTP host: smtp.gmail.com

The following is also a working combination:
*SMTP Security: TLS
*SMTP Port 587

The SSL module must be enabled in apache. If it is not, enable it with a2enmod ssl

Note that if you are using WAMP on Windows, you may need to enable the openssl module (which is not enabled by default). To do this:
# Open the php.ini file and uncomment out the line <code>extension=php_openssl.dll</code>.
# Save the php.ini file and restart the Apache service.

Note that if you use 2-step verification in Gmail, you need to add a new password in Settings - Accounts - Change accounts settings - Other Google Account settings - Security - 2-step verification - Manage your application specific passwords. When the new password is presented in groups of four characters separated by spaces, do NOT enter the spaces into the SMTP password in the mail server settings.

<noinclude>[[Category:FAQ]][[Category:Server configurations]]</noinclude>

How do I use Gmail as my mail server?

2013-09-29T16:36:26Z

Toivo: Added TSL option, SSLSessionCache setting for WAMP, note about 2-step verification

If you have a working Gmail account you can use Gmail as your mail server by setting it in the global configuration.

On the server tab set the following:

*Mailer: SMTP
*Set the next three lines with your information, leave your path untouched unless you are sure it needs to change for some reason.
*SMTP Authentication: Yes
*SMTP Security: SSL
*SMTP Port 465
*SMTP username: your gmail username
*SMTP password: your gmail password
*SMTP host: smtp.gmail.com

The following is also a working combination:
*SMTP Security: TSL
*SMTP Port 587

The SSL module must be enabled in apache. If it is not, enable it with a2enmod ssl

Note that if you are using WAMP on Windows, you may need to enable the openssl module (which is not enabled by default). To do this:
# Open the php.ini file and uncomment out the line <code>extension=php_openssl.dll</code>.
# Save the php.ini file and restart the Apache service.

Note that if you use 2-step verification in Gmail, you need to add a new password in Settings - Accounts - Change accounts settings - Other Google Account settings - Security - 2-step verification - Manage your application specific passwords. When the new password is presented in groups of four characters separated by spaces, do NOT enter the spaces into the SMTP password in the mail server settings.

<noinclude>[[Category:FAQ]][[Category:Server configurations]]</noinclude>

Talk:How do you recover or reset your admin password?

2009-05-10T00:44:06Z

Toivo: /* LAST_INSERT_ID( ) */ new section

I think this will not work anymore, because in Joomla 1.5 an additional $salt parameter is used to encrypt the password. In the usertable the password is stored in the format:

<source lang="php">
$encript:$salt
</source>

so simple md5 hashed passwords will not work anymore...

== Worked for me ==

It worked for me when I tested it. [[User:Dextercowley|Mark Dexter]] 15:08, 4 October 2008 (EDT)

== md5 CAN Be used in Joomla 1.5.7 ==

Trust me :-) You can put in an md5 in the database as the password, When that user tries to login Joomla will notice that the password is md5 hashed and will then UPGRADE that password to a SALTED password, saving the result back to the database - thats why it works :-) [[User:Prazgod|Phil Taylor]]

== LAST_INSERT_ID( ) ==

Depending on the version of the MySQL server, the function LAST_INSERT_ID( ) can produce 0 and the recovery procedure fails.

You can insert the admin2 user into the last two tables 'manually'. Run this query to find out the id of the admin2 user:

SELECT * FROM `jos_users`
WHERE username = 'admin2'

Use the value of id in the next query to replace 9999:

INSERT INTO `jos_core_acl_aro` VALUES (NULL, 'users', 9999, 0, 'Administrator', 0);

Use the value of id to replace 9999 to find out aro_id:

SELECT * FROM `jos_core_acl_aro`
WHERE value = 9999

Use the value of aro_id in the last query to replace 8888:

INSERT INTO `jos_core_acl_groups_aro_map` VALUES (25, '', 8888);

[[User:Toivo|Toivo]] 00:44, 10 May 2009 (UTC)