You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

85 line
2.4KB

  1. Install
  2. How to install the Phorum HTML Purifier plugin
  3. 0. PREREQUISITES
  4. ----------------
  5. This Phorum module only works on PHP5 and with HTML Purifier 4.0.0
  6. or later.
  7. 1. UNZIP
  8. --------
  9. Unzip phorum-htmlpurifier-x.y.z, producing an htmlpurifier folder.
  10. You've already done this step if you're reading this!
  11. 2. MOVE
  12. -------
  13. Move the htmlpurifier folder to the mods/ folder of your Phorum
  14. installation, so the directory structure looks like:
  15. phorum/
  16. mods/
  17. htmlpurifier/
  18. INSTALL - this install file
  19. info.txt, ... - the module files
  20. htmlpurifier/
  21. 3. INSTALL HTML PURIFIER
  22. ------------------------
  23. Download and unzip HTML Purifier <htmlpurifier.org>. Place the contents of
  24. the library/ folder in the htmlpurifier/htmlpurifier folder. Your directory
  25. structure will look like:
  26. phorum/
  27. mods/
  28. htmlpurifier/
  29. htmlpurifier/
  30. HTMLPurifier.auto.php
  31. ... - other files
  32. HTMLPurifier/
  33. Advanced users:
  34. If you have HTML Purifier installed elsewhere on your server,
  35. all you need is an HTMLPurifier.auto.php file in the library folder which
  36. includes the HTMLPurifier.auto.php file in your install.
  37. 4. MIGRATE
  38. ----------
  39. If you're setting up a new Phorum installation, all you need to do is create
  40. a blank migrate.php file in the htmlpurifier module folder (NOT the library
  41. folder.
  42. If you have an old Phorum installation and was using BBCode,
  43. copy migrate.bbcode.php to migrate.php. If you were using a different input
  44. format, follow the instructions in migrate.bbcode.php to create your own custom
  45. migrate.php file.
  46. Your directory structure should now look like this:
  47. phorum/
  48. mods/
  49. htmlpurifier/
  50. migrate.php
  51. 5. ENABLE
  52. ---------
  53. Navigate to your Phorum admin panel at http://example.com/phorum/admin.php,
  54. click on Global Settings > Modules, scroll to "HTML Purifier Phorum Mod" and
  55. turn it On.
  56. 6. MIGRATE SIGNATURES
  57. ---------------------
  58. If you're setting up a new Phorum installation, skip this step.
  59. If you allowed your users to make signatures, navigate to the module settings
  60. page of HTML Purifier (Global Settings > Modules > HTML Purifier Phorum Mod >
  61. Configure), type in "yes" in the "Confirm" box, and press "Migrate."
  62. ONLY DO THIS ONCE! BE SURE TO BACK UP YOUR DATABASE!
  63. 7. CONFIGURE
  64. ------------
  65. Configure using Edit settings. See that page for more information.
  66. vim: et sw=4 sts=4