plugins/phorum/INSTALL

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