plugins/phorum/README

   1
   2 HTML Purifier Phorum Mod - Filter your HTML the Standards-Compliant Way!
   3
   4 This Phorum mod enables HTML posting on Phorum.  Under normal circumstances,
   5 this would cause a huge security risk, but because we are running
   6 HTML through HTML Purifier, output is guaranteed to be XSS free and
   7 standards-compliant.
   8
   9 This mod requires HTML input, and previous markup languages need to be
  10 converted accordingly.  Thus, it is vital that you create a 'migrate.php'
  11 file that works with your installation. If you're using the built-in
  12 BBCode formatting, simply move migrate.bbcode.php to that place; for
  13 other markup languages, consult said file for instructions on how
  14 to adapt it to your needs.
  15
  16     -- NOTE -------------------------------------------------
  17     You can also run this module in parallel with another
  18     formatting module; this module attempts to place itself
  19     at the end of the filtering chain. However, if any
  20     previous modules produce insecure HTML (for instance,
  21     a JavaScript email obfuscator) they will get cleaned.
  22
  23 This module will not work if 'migrate.php' is not created, and an improperly
  24 made migration file may *CORRUPT* Phorum, so please take your time to
  25 do this correctly. It should go without saying to *BACKUP YOUR DATABASE*
  26 before attempting anything here. If no migration is necessary, you can
  27 simply create a blank migrate.php file. HTML Purifier is smart and will
  28 not re-migrate already processed messages. However, the original code
  29 is irretrievably lost (we may change this in the future.)
  30
  31 This module will not automatically migrate user signatures, because this
  32 process may take a long time. After installing the HTML Purifier module and
  33 then configuring 'migrate.php', navigate to Settings and click 'Migrate
  34 Signatures' to migrate all user signatures to HTML.
  35
  36 All of HTML Purifier's usual functions are configurable via the mod settings
  37 page. If you require custom configuration, create config.php file in
  38 the mod directory that edits a $config variable. Be sure, also, to
  39 set $PHORUM['mod_htmlpurifier']['wysiwyg'] to TRUE if you are using a
  40 WYSIWYG editor (you can do this through a common hook or the web
  41 configuration form).
  42
  43 Visit HTML Purifier at <http://htmlpurifier.org/>.
  44
  45     vim: et sw=4 sts=4