admin/environment/php extension/xmlrpc: Difference between revisions

From MoodleDocs
(Added ==You can (usually) ignore this warning==)
Line 1: Line 1:
{{Environment}}
{{Environment}}
To install the xmlrpc library on Microsoft Windows:
To install the xmlrpc library on Microsoft Windows:
#Open the ''php.ini'' file, depending on your installation this may be found in the ''moodle/apache/bin'' folder
#Open the ''php.ini'' file, depending on your installation this may be found in the ''moodle/apache/bin'' folder
#Find the line: <code>;extension=php_xmlrpc.dll</code>
#Find the line: <code>;extension=php_xmlrpc.dll</code>
#Remove the <code>;</code> at the beginning of the line
#Remove the <code>;</code> at the beginning of the line
#If necessary restart the web server, e.g. IIS or Apache.
#If necessary restart the web server, e.g. IIS or Apache.
To install the xmlrpc library on Linux/Unix
To install the xmlrpc library on Linux/Unix


If you are using PHP as provided by the OS, you can just install the appropriate package, and restart the service (e.g. PHP-FPM or Apache):
If you are using PHP as provided by the OS, you can just install the appropriate package, and restart the service (e.g. PHP-FPM or Apache):
* On Ubuntu and Debian, the command is: apt-get install php-xmlrpc
* On Ubuntu and Debian, the command is: apt-get install php-xmlrpc
* On RedHat, Fedora, CentOS and SuSE, the command is: dnf install php-xmlrpc
* On RedHat, Fedora, CentOS and SuSE, the command is: dnf install php-xmlrpc
If you compiled your PHP from source:
If you compiled your PHP from source:
# You need to recompile PHP from source  
# You need to recompile PHP from source  
# add '''--with-xmlrpc''' to the command line when you run '''configure'''
# add '''--with-xmlrpc''' to the command line when you run '''configure'''
==You can (usually) ignore this warning==
==You can (usually) ignore this warning==
According to [https://moodle.org/mod/forum/discuss.php?d=438119#p1764843 this post]:
There are 2 features in Moodle that require that PHP extension - both are disabled by default:
There are 2 features in Moodle that require that PHP extension - both are disabled by default:


One called "Moodle networking" or "Mnet" - has been historically used for connecting multiple Moodle sites to each other so you can share login processes, or connecting Moodle to Mahara (an e-portfolio system)
# "[[MNet|Moodle networking/Mnet]]" - has been historically used for connecting multiple Moodle sites to each other so you can share login processes, or connecting Moodle to Mahara (an e-portfolio system), MNet is generally considered deprecated and the LTI features in Moodle mostly provide replacements - however Mnet still contains some functions that are not easy to reproduce using other methods - it's unlikely it will be officially removed until the functionality Mnet currently provides can be easily replicated using other functionality.
 
# XMLRPC Web services protocol - If enabled, Moodle [[Using web services|web services]] allow external systems to make API calls to your Moodle site - there are a few different ways that this data can be formatted(protocols); one of those protocols is XMLRPC and if uses the xmlrpc php exension to do this.
The other feature allows for an external system to make webservice calls to your Moodle site - there are a few different ways that this data can be formatted, and one of those uses the xmlrpc php exension.
 
Both those features are slated for removal at some point as they mostly have supported altertnatives in Moodle, (and you aren't using the features anyway) so you can ignore the warning.


If you have not enabled either of these features, you can safely ignore the warning. PHP 8.0 has also removed the extension out of core, so Moodle is currently investigating the options of improving this warning/removing it - more info in https://tracker.moodle.org/browse/MDL-70889
[[Category:Environment|PHP extension]]
[[Category:Environment|PHP extension]]
[[Category:MNet|PHP]]
[[Category:MNet|PHP]]
[[fr:admin/environment/php extension/xmlrpc]]
[[fr:admin/environment/php extension/xmlrpc]]
[[es:admin/environment/php extension/xmlrpc]]
[[es:admin/environment/php extension/xmlrpc]]

Revision as of 21:34, 22 September 2022

To install the xmlrpc library on Microsoft Windows:

  1. Open the php.ini file, depending on your installation this may be found in the moodle/apache/bin folder
  2. Find the line: ;extension=php_xmlrpc.dll
  3. Remove the ; at the beginning of the line
  4. If necessary restart the web server, e.g. IIS or Apache.

To install the xmlrpc library on Linux/Unix

If you are using PHP as provided by the OS, you can just install the appropriate package, and restart the service (e.g. PHP-FPM or Apache):

  • On Ubuntu and Debian, the command is: apt-get install php-xmlrpc
  • On RedHat, Fedora, CentOS and SuSE, the command is: dnf install php-xmlrpc

If you compiled your PHP from source:

  1. You need to recompile PHP from source
  2. add --with-xmlrpc to the command line when you run configure

You can (usually) ignore this warning

There are 2 features in Moodle that require that PHP extension - both are disabled by default:

  1. "Moodle networking/Mnet" - has been historically used for connecting multiple Moodle sites to each other so you can share login processes, or connecting Moodle to Mahara (an e-portfolio system), MNet is generally considered deprecated and the LTI features in Moodle mostly provide replacements - however Mnet still contains some functions that are not easy to reproduce using other methods - it's unlikely it will be officially removed until the functionality Mnet currently provides can be easily replicated using other functionality.
  2. XMLRPC Web services protocol - If enabled, Moodle web services allow external systems to make API calls to your Moodle site - there are a few different ways that this data can be formatted(protocols); one of those protocols is XMLRPC and if uses the xmlrpc php exension to do this.

If you have not enabled either of these features, you can safely ignore the warning. PHP 8.0 has also removed the extension out of core, so Moodle is currently investigating the options of improving this warning/removing it - more info in https://tracker.moodle.org/browse/MDL-70889