[Summary view] [Print] [Text view]

   1  scripts.txt
   2  
   3  MediaWiki primary scripts are in the root directory of the software. Users
   4  should only use these scripts to access the wiki. There are also some .php that
   5  aren't primary scripts but helper files and won't work if they are accessed
   6  directly by the web.
   7  
   8  Primary scripts:
   9  
  10    index.php
  11      Main access point. It handles the most of requests.
  12      See https://www.mediawiki.org/wiki/Manual:Index.php
  13  
  14    api.php
  15      Script to provide an API for bots to fetch content and informations about
  16      the site and also modify it. See https://www.mediawiki.org/wiki/API
  17      for more informations.
  18  
  19    img_auth.php
  20      Script that only serve images to logged in users. To configure the wiki
  21      to use that script, see https://www.mediawiki.org/wiki/Manual:Image_Authorisation.
  22  
  23    load.php
  24      Used by ResourceLoader to serve minified, concatenated and gzipped CSS and JS.
  25  
  26    opensearch_desc.php
  27      Returns a OpenSearch description document (see http://www.opensearch.org/)
  28      that points to the search engines of the wiki.
  29  
  30    profileinfo.php
  31      Allow users to see the profiling information that are stored in the
  32      database.
  33  
  34      To save the profiling information in the database (required to use this
  35      script), you have to modify StartProfiler.php to use the Profiler class and
  36      not the stub profiler which is enabled by default.
  37      You will also need to set $wgProfileToDatabase to true in LocalSettings.php
  38      to force the profiler to save the informations in the database and apply the
  39      maintenance/archives/patch-profiling.sql patch to the database.
  40  
  41      To enable the profileinfo.php itself, you'll need to set $wgDBadminuser
  42      and $wgDBadminpassword in your LocalSettings.php, as well as $wgEnableProfileInfo 
  43      See also https://www.mediawiki.org/wiki/Manual:Profiling .
  44  
  45    thumb.php
  46      Script used to resize images if it is configured to be done when the web
  47      browser requests the image and not when generating the page. This script can
  48      be used as a 404 handler to generate image thumbs when they don't exist.
  49  
  50  There is also a file with a .php5 extension for each script. They can be used if
  51  the web server needs a .php5 to run the file with the PHP 5 engine and runs .php
  52  scripts with PHP 4. To use these files, you have to modify $wgScriptExtension to
  53  '.php5' is LocalSettings.php but it is already done by the config script if you
  54  used mw-config/index.php5 for installation.
  55