plugins/phorum/INSTALL

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