Automatic updates deployment - Historial de revisió

Germanvaleroelizondo: added link to spanish translation of document

2013-01-06T16:03:01Z

added link to spanish translation of document

← Versió més antiga		Revisió del 16:03, 6 gen 2013
Línia 68:		Línia 68:

	[[de:Automatische Aktualisierungen]]		[[de:Automatische Aktualisierungen]]
			[[es:Implementar actualizaciones automáticas]]

Tsala: small polishing

2012-12-06T14:48:53Z

small polishing

Ghillenb a 08:34, 5 des 2012

2012-12-05T08:34:19Z

← Versió més antiga		Revisió del 08:34, 5 des 2012
Línia 68:		Línia 68:

	This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site when fetching the ZIP package. See [[SSL certificate for moodle.org]] for more info.		This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site when fetching the ZIP package. See [[SSL certificate for moodle.org]] for more info.

			[[de:Automatische Aktualisierungen]]

Tsala: rearranging

2012-12-04T18:01:00Z

rearranging

← Versió més antiga		Revisió del 18:01, 4 des 2012
Línia 1:		Línia 1:
	{{Installing Moodle}}		{{Installing Moodle}}
	{{New features}}~~[[File:plugins overview.png\|thumb\|left\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable~~ updates deployment ~~in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.~~		{{New features}}
			==Enabling updates deployment==

	This functionality requires that [[Available update notifications]] are enabled at the site.~~<br clear="all" />~~		[[File:plugins overview.png\|thumb\|left\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.

			This functionality requires that [[Available update notifications]] are enabled at the site.

	== How it works ==		== How it works ==

Tsala: Installing Moodle template

2012-12-04T17:44:02Z

Installing Moodle template

← Versió més antiga		Revisió del 17:44, 4 des 2012
Línia 1:		Línia 1:
			{{Installing Moodle}}
	{{New features}}[[File:plugins overview.png\|thumb\|left\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.		{{New features}}[[File:plugins overview.png\|thumb\|left\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.

Mudrd8mz: Available update notifications page moved

2012-12-04T14:44:10Z

Available update notifications page moved

← Versió més antiga		Revisió del 14:44, 4 des 2012
Línia 1:		Línia 1:
	{{New features}}[[File:plugins overview.png\|thumb\|left\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.		{{New features}}[[File:plugins overview.png\|thumb\|left\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.

	This functionality requires that [[~~Notifications\|Update~~ notifications]] is enabled at the site.<br clear="all" />		This functionality requires that [[Available update notifications]] are enabled at the site.<br clear="all" />

	== How it works ==		== How it works ==

Mudrd8mz: /* Plugin files not writable */ Merged with the current admin/mdeploy/notwritable

2012-12-04T14:30:29Z

Plugin files not writable: Merged with the current admin/mdeploy/notwritable

← Versió més antiga		Revisió del 14:30, 4 des 2012
Línia 28:		Línia 28:
	=== Plugin files not writable ===		=== Plugin files not writable ===

	During the deployment, Moodle will replace the whole folder with the plugin code with a new version. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences.		During the deployment, Moodle will replace the whole folder with the plugin code with a new version. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences. The exact location of the plugin folder depends on the type of the plugin. For a full list of locations see the Moodle path on https://docs.moodle.org/dev/Plugins

	Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:		Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:
Línia 36:		Línia 36:
	# chown -R www-data stampcoll		# chown -R www-data stampcoll
	# chmod -R u+w stampcoll		# chmod -R u+w stampcoll

			See also more about [[Installing plugins]].

	=== Can not download the package ===		=== Can not download the package ===

Mudrd8mz: Added info about missing install button

2012-12-04T14:25:44Z

Added info about missing install button

← Versió més antiga		Revisió del 14:25, 4 des 2012
Línia 21:		Línia 21:

	$CFG->disableupdateautodeploy = true;		$CFG->disableupdateautodeploy = true;

			== Missing install button ==

			If the updates deployment feature is not enabled (or if it was disabled at the config.php file), no button to install the update is displayed. If the feature is enabled, the page displaying the list of available updates performs some pre-checks to make sure the deployment will work. If a pre-check fails, a short information with a help pop-up is displayed.

			=== Plugin files not writable ===

			During the deployment, Moodle will replace the whole folder with the plugin code with a new version. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences.

			Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:

			# cd /var/www/vhosts/moodle/htdocs
			# cd mod
			# chown -R www-data stampcoll
			# chmod -R u+w stampcoll

			=== Can not download the package ===

			Make sure that the site http://moodle.org/plugins is up and running at the moment. If it is down, your site can't fetch the ZIP packages from it. Wait for the moodle.org site is up again and try to repeat the deployment procedure.

			There can also be a problem with the validation of the SSL certificate of the moodle.org site. See [[SSL certificate for moodle.org]] for more info.

	== Errors and exceptions ==		== Errors and exceptions ==

Mudrd8mz: Moved the SSL info to a separate page as it is related to other pages, too

2012-12-04T14:10:53Z

Moved the SSL info to a separate page as it is related to other pages, too

← Versió més antiga		Revisió del 14:10, 4 des 2012
Línia 40:		Línia 40:
	==== cURL error 60 SSL certificate problem ====		==== cURL error 60 SSL certificate problem ====

	This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site when fetching the ZIP package.		This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site when fetching the ZIP package. See [[SSL certificate for moodle.org]] for more info.

	~~ZIP packages are downloaded via the secure HTTPS protocol. The mdeploy utility validates the~~ SSL certificate of the remote site (which is the Moodle plugins directory in this case) and verifies its identity. To make this work, there must be a certificate (in the PEM format) of the [http://en.wikipedia.org/wiki/Certificate_authority certificate authority (CA)] that issued the certificate for moodle.org ~~installed at your server.~~

	~~The SSL certificate of the Moodle plugins directory has been issued by the [https://www.digicert.com/digicert-root-certificates.htm DigiCert CA~~] and signed by their ''DigiCert High Assurance EV Root CA'' certificate. If this CA certificate is missing, the remote site can not be verified and the mdeploy utility refuses to download the ZIP (to protect you from so called man-in-the-middle attack). The exact location of that certificate at your server depends on the OS type and other settings. At Linux servers it may be typically found at /usr/share/ca-certificates/mozilla/DigiCert_High_Assurance_EV_Root_CA.crt for ~~example.~~

	The recommended way to fix this problem is to update your server's operating system so that it contains recent SSL certificates of common certificate authorities. At Debian based distributions, these certificates are distributed in the ''ca-certificates'' package. Gentoo servers provide them via the ''app-misc/ca-certificates'' ebuild. It's also a good idea to make sure that the OpenSSL libraries (libssl) and cURL libraries (libcurl) are up-to-date at your server.

	If updating the operating system is not an option for you and the administrator of the server refuses to update the CA certificates at the server (there's not a good argument for that though), here is a workaround for you. You can download the [https://www.digicert.com/testroot/DigiCertHighAssuranceEVRootCA.crt DigiCert High Assurance EV Root CA] certificate from [https://www.digicert.com/digicert-root-certificates.htm digicert.com] and put it into your ''moodledata/moodleorgca.crt'' file. If the certificate is found there, Moodle will use it instead of relying on the one provided by the operating system.

Mudrd8mz: Basic info about the feature and some of errors that may raise

2012-12-04T13:36:57Z

Basic info about the feature and some of errors that may raise

Pàgina nova

{{New features}}[[File:plugins overview.png|thumb|left|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.

This functionality requires that [[Notifications|Update notifications]] is enabled at the site.<br clear="all" />

== How it works ==

As a part of the information about available updates for the site, URL of the ZIP package with the new version of an installed plugin is returned. When ''Install this update'' button is pressed and the the deployment is confirmed at the next page, a standalone utility called ''mdeploy.php'' is executed.

# The mdeploy utility authorizes the request to make sure you are coming ''exactly'' from the confirmation page displayed in the previous step.
# The ZIP package with the new version is fetched from the [https://moodle.org/plugins Moodle plugins directory].
# A simple integrity check is performed to make sure the ZIP was downloaded correctly.
# The current version of the plugin code is archived into a directory at ''moodledata/mdeploy/archive/'' so you have a backup (just in case you had some local tweaks in the code, for example).
# The current directory with the plugin is removed and replaced with the content of the downloaded ZIP.
# Your browser is redirected to the page where the normal upgrade procedure happens.

At this moment, you can deploy another available update (if there is such) or perform the upgrade procedure as if you uploaded the ZIP contents to your site manually.

== Disabling updates deployment ==

In a few circumstances (such as completely managed servers, which may have a lot of local modifications, or sites that have their own solution for updates deployment - for example via [[Git for Administrators|Git checkouts]]) it is desirable to not to allow automatic updates deployment. The feature may be disabled completely by adding the following code to the [[Configuration file|config.php file]]:

$CFG->disableupdateautodeploy = true;

== Errors and exceptions ==

[[File:mdeploy-exception.png|thumb|left|Error screen during the plugin deployment]]If anything goes wrong during the deployment, please read the error page carefully and copy the error message together with the debugging information for later reference. Also, check the mdeploy.log file. The mdeploy utility logs all the steps into this file located at ''moodledata/mdeploy/mdeploy.log''. The log file usually contains additional details and debugging information describing the reason of the failure.

When you navigate back from the error screen, always remember to go back up to the screen with the list of available plugins (where you clicked the ''Install this update'' button originally). Just going back to the previous confirmation screen or even reloading the current page will not work as the request would not be authorized any more. Doing so leads to the ''unauthorized_access_exception'' with the message ''Unable to read the passphrase file.''

The following section describes some errors that may raise and how to deal with them.<br clear="all" />

=== Unable to download the package (download_file_exception) ===

Check the bottom of the mdeploy.log file. It will probably contain a line starting with "cURL error" followed by the error number and the cURL error description.

==== cURL error 7 couldn't connect to host ====

Make sure that the site http://moodle.org/plugins is up and running at the moment. If it is down, your site can't fetch the ZIP packages from it. Wait for the moodle.org site is up again and try to repeat the deployment procedure.

==== cURL error 60 SSL certificate problem ====

This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site when fetching the ZIP package.

ZIP packages are downloaded via the secure HTTPS protocol. The mdeploy utility validates the SSL certificate of the remote site (which is the Moodle plugins directory in this case) and verifies its identity. To make this work, there must be a certificate (in the PEM format) of the [http://en.wikipedia.org/wiki/Certificate_authority certificate authority (CA)] that issued the certificate for moodle.org installed at your server.

The SSL certificate of the Moodle plugins directory has been issued by the [https://www.digicert.com/digicert-root-certificates.htm DigiCert CA] and signed by their ''DigiCert High Assurance EV Root CA'' certificate. If this CA certificate is missing, the remote site can not be verified and the mdeploy utility refuses to download the ZIP (to protect you from so called man-in-the-middle attack). The exact location of that certificate at your server depends on the OS type and other settings. At Linux servers it may be typically found at /usr/share/ca-certificates/mozilla/DigiCert_High_Assurance_EV_Root_CA.crt for example.

The recommended way to fix this problem is to update your server's operating system so that it contains recent SSL certificates of common certificate authorities. At Debian based distributions, these certificates are distributed in the ''ca-certificates'' package. Gentoo servers provide them via the ''app-misc/ca-certificates'' ebuild. It's also a good idea to make sure that the OpenSSL libraries (libssl) and cURL libraries (libcurl) are up-to-date at your server.

If updating the operating system is not an option for you and the administrator of the server refuses to update the CA certificates at the server (there's not a good argument for that though), here is a workaround for you. You can download the [https://www.digicert.com/testroot/DigiCertHighAssuranceEVRootCA.crt DigiCert High Assurance EV Root CA] certificate from [https://www.digicert.com/digicert-root-certificates.htm digicert.com] and put it into your ''moodledata/moodleorgca.crt'' file. If the certificate is found there, Moodle will use it instead of relying on the one provided by the operating system.

← Versió més antiga		Revisió del 14:48, 6 des 2012
Línia 3:		Línia 3:
	==Enabling updates deployment==		==Enabling updates deployment==

	[[File:plugins overview.png\|thumb~~\|left~~\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.		[[File:plugins overview.png\|thumb\|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.

	This functionality requires ~~that~~ [[Available update notifications]] ~~are~~ enabled ~~at the site~~.		Note: This functionality requires [[Available update notifications]] to be enabled.

	== How it works ==		== How it works ==

	~~As a part of the information~~ about available updates ~~for the site~~, ~~URL~~ of ~~the~~ ZIP ~~package with the~~ new ~~version~~ of an installed ~~plugin is returned~~. When ''Install this update'' button is pressed and the the deployment is confirmed at the ~~next~~ page, a standalone utility called ''mdeploy.php'' is executed.		# Information about available updates, including URLs of ZIP packages of new versions of installed plugins, are available as a web service at download.moodle.org.
			# When a 'Install this update' button is pressed and the the deployment is confirmed on the following page, a standalone utility called ''mdeploy.php'' is executed.
	# The mdeploy utility authorizes the request to make sure you are coming ''exactly'' from the confirmation page displayed in the previous step.		# The mdeploy utility authorizes the request to make sure you are coming ''exactly'' from the confirmation page displayed in the previous step.
	# The ZIP package ~~with~~ the new version is fetched from the [https://moodle.org/plugins Moodle plugins directory].		# The ZIP package of the new version is fetched from the [https://moodle.org/plugins Moodle plugins directory].
	# A simple integrity check is performed to make sure the ZIP was downloaded correctly.		# A simple integrity check is performed to make sure the ZIP was downloaded correctly.
	# The current version of the plugin code is archived into a ~~directory at~~ ''moodledata/mdeploy/archive/'' ~~so you have~~ a backup (just in case you had some local tweaks in the code, for example).		# The current version of the plugin code is archived into a folder ''moodledata/mdeploy/archive/'' as a backup (just in case you had some local tweaks in the code, for example).
	# The current ~~directory with~~ the plugin is removed and replaced with the ~~content~~ of the downloaded ZIP.		# The current folder containing the plugin is removed and replaced with the contents of the downloaded ZIP.
	# Your browser is redirected to the page where the normal upgrade procedure happens.		# Your browser is redirected to the page where the normal upgrade procedure happens.

	At this moment, you can deploy another available update (if there is ~~such~~) or perform the upgrade procedure as if you uploaded the ZIP contents to your site manually.		At this moment, you can deploy another available update (if there is one) or perform the upgrade procedure the same as if you had uploaded the ZIP contents to your site manually.

	== Disabling updates deployment ==		== Disabling updates deployment ==
Línia 26:		Línia 26:
	$CFG->disableupdateautodeploy = true;		$CFG->disableupdateautodeploy = true;

	== Missing install button ==		==Possible problems==

			=== Missing install button ===

	If the updates deployment feature is not enabled (or if it ~~was~~ disabled at the config.php file), no button to install the update is displayed. If the feature is enabled, the page displaying the list of available updates performs some pre-checks to make sure the deployment will work. If a pre-check fails, ~~a short~~ information with a help pop-up is displayed.		If the updates deployment feature is not enabled (or if it is disabled in the config.php file), no button to install the update is displayed. When the feature is enabled, the page displaying the list of available updates performs some pre-checks to make sure the deployment will work. If a pre-check fails, information with a help pop-up is displayed.

	=== Plugin files not writable ===		=== Plugin files not writable ===

	During the deployment, Moodle will replace the whole folder with the plugin code with a new version. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences. The exact location of the plugin folder depends on the type of the plugin. For a full list of locations see the Moodle path ~~on https~~://docs.~~moodle.org/dev/Plugins~~		During the deployment, Moodle will replace the whole folder with the plugin code with a new version of the code. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences. The exact location of the plugin folder depends on the type of the plugin. For a full list of locations see the Moodle path in the [[:dev:Plugins\|Plugins developer docs]].

	Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:		Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:
Línia 45:		Línia 47:
	=== Can not download the package ===		=== Can not download the package ===

	Make sure that ~~the site~~ http://moodle.org/plugins is up ~~and running at the moment~~. If it is down, your site ~~can't~~ fetch the ZIP packages from it. Wait for ~~the~~ moodle.org ~~site is~~ up again and try to repeat the deployment procedure.		Make sure that http://moodle.org/plugins is up. If the site is down, your Moodle site will not be able to fetch the ZIP packages from it. Wait for http://moodle.org/plugins to be up again and then try to repeat the deployment procedure.

	There can also be a problem with the validation of the SSL certificate ~~of the moodle.org site~~. See [[SSL certificate for moodle.org]] for more info.		There can also be a problem with the validation of the SSL certificate. See [[SSL certificate for moodle.org]] for more info.

	== Errors and exceptions ==		== Errors and exceptions ==

	[[File:mdeploy-exception.png\|thumb~~\|left~~\|Error screen during the plugin deployment]]If anything goes wrong during the deployment, please read the error page carefully and copy the error message together with the debugging information for later reference. Also, check the mdeploy.log file. The mdeploy utility logs all the steps into this file located at ''moodledata/mdeploy/mdeploy.log''. The log file usually contains additional details and debugging information describing the ~~reason~~ of the failure.		[[File:mdeploy-exception.png\|thumb\|Error screen during the plugin deployment]]If anything goes wrong during the deployment, please read the error page carefully and copy the error message together with the debugging information for later reference. Also, check the mdeploy.log file. The mdeploy utility logs all the steps into this file located at ''moodledata/mdeploy/mdeploy.log''. The log file usually contains additional details and debugging information describing the cause of the failure.

	When you navigate back from the error screen, always remember to go back up to the screen with the list of available plugins (where you clicked the ''Install this update'' button originally). Just going back to the previous confirmation screen or even reloading the current page will not work as the request would not be authorized any more. Doing so leads to the ''unauthorized_access_exception'' with the message ''Unable to read the passphrase file.''		When you navigate back from the error screen, always remember to go back up to the screen with the list of available plugins (where you clicked the 'Install this update' button originally). Just going back to the previous confirmation screen or even reloading the current page will not work, as the request would not be authorized any more. Doing so leads to the ''unauthorized_access_exception'' with the message ''Unable to read the passphrase file.''

	The following section describes some errors that may ~~raise~~ and how to deal with them.~~<br clear="all" />~~		The following section describes some errors that you may encounter and how to deal with them.

	=== Unable to download the package (download_file_exception) ===		=== Unable to download the package (download_file_exception) ===
Línia 61:		Línia 63:
	Check the bottom of the mdeploy.log file. It will probably contain a line starting with "cURL error" followed by the error number and the cURL error description.		Check the bottom of the mdeploy.log file. It will probably contain a line starting with "cURL error" followed by the error number and the cURL error description.

	~~====~~ cURL error 7 couldn't connect to host ~~====~~		; cURL error 7 couldn't connect to host : Make sure that the site http://download.moodle.org is up and running at the moment. If it is down, your site can't call the web service to fetch the available updates info. Wait for http://download.moodle.org to be up again then re-check.

	Make sure that the site http://moodle.org~~/plugins~~ is up and running at the moment. If it is down, your site can't fetch the ~~ZIP packages from it~~. Wait for ~~the~~ moodle.org ~~site is~~ up again ~~and try to repeat the deployment procedure~~.

	~~==== cURL error 60 SSL certificate problem ====~~

	This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site ~~when fetching the ZIP package~~. See [[SSL certificate for moodle.org]] for more info.		; cURL error 60 (SSL certificate problem) : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. See [[SSL certificate for moodle.org]] for more info.

	[[de:Automatische Aktualisierungen]]		[[de:Automatische Aktualisierungen]]