scripts.txt 2.4 KB

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