download.xhtml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [
   4   <!ENTITY % htmlpurifier.current SYSTEM "current.ent"> %htmlpurifier.current;
   5 ]>
   6 <html
   7   xmlns="http://www.w3.org/1999/xhtml"
   8   xmlns:xi="http://www.w3.org/2001/XInclude"
   9   xml:lang="en">
  10 <head>
  11   <title>Download - HTML Purifier</title>
  12   <xi:include href="common-meta.xml" xpointer="xpointer(/*/node())" />
  13   <meta name="description" content="Download HTML Purifier, the standards-compliant HTML filter library." />
  14   <meta name="keywords" content="HTMLPurifier, HTML Purifier, HTML, filter, filtering, standards, compliant, w3c, download, zip, tarball, tgz, sig, gpg, gnupg, sha1, hash, checksum" />
  15 </head>
  16 <body>
  17
  18 <xi:include href="common-header.xml" xpointer="xpointer(/*/node())" />
  19
  20 <div id="main">
  21 <h1 id="title">Download</h1>
  22
  23 <div id="content">
  24
  25 <p>
  26   The current version of HTML Purifier is
  27   <strong>&htmlpurifier.current.version;</strong>, released on
  28   &htmlpurifier.current.release-date;, and is compatible with
  29   <abbr>PHP</abbr> 5.0.5 and up (all code is <code>E_STRICT</code>
  30   compliant). This library is open-source,
  31   licensed under the <a href="http://www.gnu.org/licenses/lgpl.html"><abbr>LGPL</abbr>
  32   v2.1+</a>. We offer multiple ways of downloading
  33   and installing HTML Purifier.
  34 </p>
  35
  36 <div id="toc" class="floated" />
  37
  38 <!--
  39 <h2 id="Errata">Errata</h2>
  40
  41 <p>
  42   Here is a list of known bugs. These issues have all been fixed in the
  43   <a href="#NightlyBuilds">trunk</a> unless
  44   otherwise noted:
  45 </p>
  46
  47 <ul>
  48 </ul>
  49 -->
  50
  51 <h2 id="Standard">Standard</h2>
  52
  53 <p>
  54   We offer the standard zip and tarball downloads. Download them,
  55   unzip them, and with a few simple <a href="#Installation">installation</a> steps get
  56   to using HTML Purifier right away:
  57 </p>
  58
  59 <ul>
  60     <li><a class="download" href="&url.dl;.tar.gz">HTML Purifier &htmlpurifier.current.version; (.tar.gz)</a> [<a href="&url.dl;.tar.gz.sig">sig</a>]</li>
  61     <li><a class="download" href="&url.dl;.zip"   >HTML Purifier &htmlpurifier.current.version; (.zip)</a>    [<a href="&url.dl;.zip.sig">sig</a>]</li>
  62 </ul>
  63
  64 <h3 id="Lite">Lite Distribution</h3>
  65
  66 <p>
  67   No, it's not magically faster. HTML Purifier Lite offers the same
  68   functionality of HTML Purifier (standard), except that anything not
  69   essentially to the basic functioning of the library has been stripped
  70   out: end-user documentation, unit-tests, profiling, maintenance scripts, etc.
  71   Just the <code>library</code> folder.
  72 </p>
  73
  74 <ul>
  75     <li><a class="download" href="&url.dl;-lite.tar.gz">HTML Purifier &htmlpurifier.current.version; Lite (.tar.gz)</a> [<a href="&url.dl;-lite.tar.gz.sig">sig</a>]</li>
  76     <li><a class="download" href="&url.dl;-lite.zip"   >HTML Purifier &htmlpurifier.current.version; Lite (.zip)</a>    [<a href="&url.dl;-lite.zip.sig">sig</a>]</li>
  77 </ul>
  78
  79 <h3 id="Standalone">Standalone Distribution</h3>
  80
  81 <p>
  82   For those of you who balk at the possibility of a 100+ includes, we also
  83   offer a conveniently packaged single-file version of HTML Purifier. Well,
  84   not really, since HTML Purifier does require some auxiliary files in
  85   order to work (but they are neatly tucked away in a folder named
  86   <code>standalone</code>). Include <code>HTMLPurifier.standalone.php</code>
  87   and be done with it!
  88 </p>
  89
  90 <ul>
  91     <li><a class="download" href="&url.dl;-standalone.tar.gz">HTML Purifier &htmlpurifier.current.version; Standalone (.tar.gz)</a> [<a href="&url.dl;-standalone.tar.gz.sig">sig</a>]</li>
  92     <li><a class="download" href="&url.dl;-standalone.zip"   >HTML Purifier &htmlpurifier.current.version; Standalone (.zip)</a>    [<a href="&url.dl;-standalone.zip.sig">sig</a>]</li>
  93 </ul>
  94
  95 <h3 id="SHA1"><acronym>SHA-1</acronym> checksums</h3>
  96
  97 <p>
  98   Here are the <acronym>SHA-1</acronym> checksums you can use to
  99   verify the integrity of your HTML Purifier download:
 100 </p>
 101
 102 <pre class="long">&htmlpurifier.current.hashes;</pre>
 103
 104 <h3 id="GnuPG">GnuPG signatures</h3>
 105
 106 <p>
 107   There are <tt>.sig</tt> files which you can use to cryptographically verify
 108   that the release is from me, Edward Z. Yang.  You can find
 109   my <a href="http://www.thewritingpot.com/gpgpubkey.asc">public key
 110   here (0x869C48DA)</a>.  My key's fingerprint is:
 111   <tt>3FA8 E9A9 7385 B691 A6FC  B3CB A933 BE7D 869C 48DA</tt>.
 112 </p>
 113
 114 <p>Verify files with this command:</p>
 115
 116 <pre class="command">gpg --verify <strong>$filename</strong>.sig</pre>
 117
 118 <p>Future releases will be signed with my new <a href="ezyang-tablet.asc">ezyang@mit.edu</a>
 119 key.  This key is signed by my old key, and you can retrieve the signature
 120 from <a href="http://pgp.mit.edu:11371/pks/lookup?op=vindex&amp;search=0x4B3B9E321E1C674B">pgp.mit.edu</a>.</p>
 121
 122 <h2 id="PEAR"><acronym>PEAR</acronym></h2>
 123
 124 <p>
 125   HTML Purifier is also available via a <acronym>PEAR</acronym> channel.
 126   The <acronym>PEAR</acronym> installer is an incredibly powerful and robust
 127   way to install <abbr>PHP</abbr> packages, and
 128   does not have to be limited to packages found on
 129   <a href="http://pear.php.net/">pear.php.net</a>. With
 130   <acronym>PEAR</acronym>, installing is as simple as these
 131   two commands in your shell:
 132 </p>
 133
 134 <pre class="command">pear channel-discover htmlpurifier.org
 135 pear install hp/HTMLPurifier</pre>
 136
 137 <p>
 138   ...and then following the <a href="#Installation">installation instructions</a>.
 139 </p>
 140
 141 <p>
 142   You can upgrade with:
 143 </p>
 144
 145 <pre class="command">pear upgrade hp/HTMLPurifier</pre>
 146
 147 <h2 id="Git">Git</h2>
 148
 149 <p>
 150   For those who like to live on the edge, you can also grab the latest
 151   developmental code from our Git
 152   repository.  Simply execute this command in your shell:
 153 </p>
 154
 155 <pre class="command">git clone git://repo.or.cz/htmlpurifier.git</pre>
 156
 157 <p>
 158   You must have Git installed. Windows users can grab a copy of Git via the
 159   <a href="http://code.google.com/p/msysgit/">msysgit project</a>.
 160 </p>
 161
 162 <p>
 163   Code in master is quite stable;
 164   a combination of extensive unit-testing and atomic commits means that
 165   the most recent version will almost never be broken.
 166 </p>
 167
 168 <p>
 169   Online repository browsing and mirroring services (click links to get
 170   pull URLs) are available at numerous places:
 171 </p>
 172
 173 <ul>
 174   <li><strong><a href="http://repo.or.cz/w/htmlpurifier.git">repo.or.cz</a></strong> -
 175     Master repository: prefer pulling from it, always push to it. Make this your
 176     <code>origin</code> remote if it isn't already.
 177     <a href="http://repo.or.cz/m/regproj.cgi?name=htmlpurifier/">Allows forks</a>,
 178     please use them!</li>
 179   <li><a href="http://gitorious.org/projects/htmlpurifier">Gitorious</a> -
 180     Regular old mirror. Allows forks, but don't use them.</li>
 181   <li><a href="http://github.com/ezyang/htmlpurifier/tree/master">GitHub</a> -
 182     Regular old mirror, but with <a href="http://github.com/ezyang/htmlpurifier/network">pretty
 183     history visualization tools</a>. Allows forks, but don't use them.</li>
 184   <li><a href="http://git.htmlpurifier.org">git.htmlpurifier.org</a> -
 185     Dumb HTTP mirror with no web interface, use as last resort.</li>
 186 </ul>
 187
 188 <h2 id="Installation">Installation</h2>
 189
 190 <h3>File permissions</h3>
 191
 192 <p>
 193   HTML Purifier will write
 194   out cache files for HTMLDefinition in the subdirectories of
 195   <code>HTMLPurifier/DefinitionCache/Serializer</code>. If you are in
 196   the <code>library/</code> folder of HTML Purifier, you can set the
 197   appropriate permissions using:
 198 </p>
 199
 200 <pre class="command">chmod -R 0755 HTMLPurifier/DefinitionCache/Serializer</pre>
 201
 202 <p>
 203   If the above command doesn't work, you may need to assign write permissions
 204   to all. This may be necessary if your webserver runs as nobody, but is
 205   not recommended since it means any other user can write files in the
 206   directory. Use:
 207 </p>
 208
 209 <pre class="command">chmod -R 0777 HTMLPurifier/DefinitionCache/Serializer</pre>
 210
 211 <p>
 212   You can also chmod files via your <abbr>FTP</abbr> client; this option
 213   is usually accessible by right clicking the corresponding directory and
 214   then selecting <q>chmod</q> or <q>file permissions</q>.
 215 </p>
 216
 217 <p>
 218   If you are unable or unwilling to give write permissions to the cache
 219   directory, you can either disable the cache (and suffer a performance
 220   hit):
 221 </p>
 222
 223 <pre>$config-&gt;set('Core', 'DefinitionCache', null);</pre>
 224
 225 <p>
 226   Or move the cache directory somewhere else (no trailing slash):
 227 </p>
 228
 229 <pre>$config-&gt;set('Cache', 'SerializerPath', '/home/user/absolute/path');</pre>
 230
 231 <h3>Quick install</h3>
 232
 233 <p>If your website is in UTF-8 and XHTML Transitional, use this code:</p>
 234
 235 <pre>&lt;?php
 236     require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
 237
 238     $purifier = new HTMLPurifier();
 239     $clean_html = $purifier-&gt;purify($dirty_html);
 240 ?&gt;</pre>
 241
 242 <p>If your website is in a different encoding or doctype, use this code:</p>
 243
 244 <pre>&lt;?php
 245     require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
 246
 247     $config = HTMLPurifier_Config::createDefault();
 248     $config-&gt;set('Core', 'Encoding', <strong>'ISO-8859-1'</strong>); // replace with your encoding
 249     $config-&gt;set('HTML', 'Doctype', <strong>'HTML 4.01 Transitional'</strong>); // replace with your doctype
 250     $purifier = new HTMLPurifier($config);
 251
 252     $clean_html = $purifier-&gt;purify($dirty_html);
 253 ?&gt;</pre>
 254
 255 <p>
 256   People with HTML Purifier already in their path (<acronym>PEAR</acronym>,
 257   for example) can use:
 258 </p>
 259
 260 <pre>require_once 'HTMLPurifier.auto.php';</pre>
 261
 262 <p>
 263   For detailed installation instructions, read the
 264   <a href="http://repo.or.cz/w/htmlpurifier.git?a=blob;f=INSTALL;hb=v&htmlpurifier.current.version;"><code>INSTALL</code></a>
 265   document.
 266 </p>
 267
 268 <h2 id="MailingList">Mailing list</h2>
 269
 270 <p>
 271   You can be notified of new releases by a low-traffic announce list. Subscribe
 272   <a href="https://mailman.mit.edu:444/mailman/listinfo/htmlpurifier">at the mailman page</a>.
 273   We take your privacy very seriously and will not use emails submitted
 274   to this web form for any other purposes.
 275 </p>
 276
 277 <p>
 278   You can also subscribe to a moderately higher traffic, unmoderated
 279   mailing list intended for development discussion and user support
 280   at <a href="http://groups.google.com/group/htmlpurifier">Google Groups</a>.
 281 </p>
 282
 283 <h2 id="History">History</h2>
 284
 285 <p>
 286   Previous releases can be obtained by browsing
 287   the <a href="releases/">release directory</a>
 288   or checking code out of the
 289   <a href="http://htmlpurifier.org/svnroot/htmlpurifier/tags/">tags/
 290   directory</a>.  However, they are not supported and should not be used
 291   in live environments. If you are having trouble upgrading, pop over
 292   to <a href="http://htmlpurifier.org/phorum/">the forums</a> and get help.
 293 </p>
 294
 295 </div>
 296 </div>
 297
 298 </body>
 299 </html>