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 <h2 id="PEAR"><acronym>PEAR</acronym></h2>
 119
 120 <p>
 121   HTML Purifier is also available via a <acronym>PEAR</acronym> channel.
 122   The <acronym>PEAR</acronym> installer is an incredibly powerful and robust
 123   way to install <abbr>PHP</abbr> packages, and
 124   does not have to be limited to packages found on
 125   <a href="http://pear.php.net/">pear.php.net</a>. With
 126   <acronym>PEAR</acronym>, installing is as simple as these
 127   two commands in your shell:
 128 </p>
 129
 130 <pre class="command">pear channel-discover htmlpurifier.org
 131 pear install hp/HTMLPurifier</pre>
 132
 133 <p>
 134   ...and then following the <a href="#Installation">installation instructions</a>.
 135 </p>
 136
 137 <p>
 138   You can upgrade with:
 139 </p>
 140
 141 <pre class="command">pear upgrade hp/HTMLPurifier</pre>
 142
 143 <h2 id="Git">Git</h2>
 144
 145 <p>
 146   For those who like to live on the edge, you can also grab the latest
 147   developmental code from our Git
 148   repository.  Simply execute this command in your shell:
 149 </p>
 150
 151 <pre class="command">git clone git://repo.or.cz/htmlpurifier.git</pre>
 152
 153 <p>
 154   You must have Git installed. Windows users can grab a copy of Git via the
 155   <a href="http://code.google.com/p/msysgit/">msysgit project</a>.
 156 </p>
 157
 158 <p>
 159   Code in the trunk actually tends to be quite stable;
 160   a combination of extensive unit-testing and atomic commits means that
 161   the most recent version will almost never be broken.
 162 </p>
 163
 164 <p>
 165   Online repository browsing and mirroring services (click links to get
 166   pull URLs) are available at numerous places:
 167 </p>
 168
 169 <ul>
 170   <li><strong><a href="http://repo.or.cz/w/htmlpurifier.git">repo.or.cz</a></strong> -
 171     Master repository: prefer pulling from it, always push to it. Make this your
 172     <code>origin</code> remote if it isn't already.
 173     <a href="http://repo.or.cz/m/regproj.cgi?name=htmlpurifier/">Allows forks</a>,
 174     please use them!</li>
 175   <li><a href="http://gitorious.org/projects/htmlpurifier">Gitorious</a> -
 176     Regular old mirror. Allows forks, but don't use them.</li>
 177   <li><a href="http://github.com/ezyang/htmlpurifier/tree/master">GitHub</a> -
 178     Regular old mirror, but with <a href="http://github.com/ezyang/htmlpurifier/network">pretty
 179     history visualization tools</a>. Allows forks, but don't use them.</li>
 180   <li><a href="http://git.htmlpurifier.org">git.htmlpurifier.org</a> -
 181     Dumb HTTP mirror with no web interface, use as last resort.</li>
 182 </ul>
 183
 184 <p id="Subversion">
 185   For backwards compatibility reasons, the
 186   <a href="http://htmlpurifier.org/svnroot/htmlpurifier/trunk">Subversion repository</a>
 187   is still available, as well as the <a href="http://htmlpurifier.org/viewvc.cgi/htmlpurifier/trunk/">ViewVC interface</a>.
 188   We will also continue to support tags, for projects that use Subversion
 189   externals. However, the trunk will not be regularly updated.
 190 </p>
 191
 192 <h2 id="PHP4">HTML Purifier 2.1 for <abbr>PHP</abbr> 4</h2>
 193
 194 <p>
 195   <strong>Warning:</strong> The HTML Purifier 2.1 series is retired and
 196   will only be receiving major
 197   bug and security fixes. However, it is compatible with <abbr>PHP</abbr> 4
 198   so if you're stuck on this now officially deprecated version of
 199   <abbr>PHP</abbr>, here are the older downloads:
 200 </p>
 201
 202 <ul>
 203   <li><a class="download" href="releases/htmlpurifier-2.1.5.tar.gz">HTML Purifier 2.1.5 (.tar.gz)</a></li>
 204   <li><a class="download" href="releases/htmlpurifier-2.1.5.zip">HTML Purifier 2.1.5 (.zip)</a></li>
 205 </ul>
 206
 207 <!--
 208 <h2 id="NightlyBuilds">Nightly Builds</h2>
 209
 210 <p>
 211   Nightly tarballs of the most recent SVN snapshots are available
 212   for those of you who want to live on the edge but never got
 213   <code>svn export</code> to work.  These builds are <abbr>PHP</abbr>5 only.
 214   The build is performed every day at midnight, and is available here:
 215 </p>
 216
 217 <ul>
 218   <li><a class="download" href="http://htmlpurifier.org/releases/htmlpurifier-trunk.tar.gz">HTML Purifier Trunk Snapshot (.tar.gz)</a></li>
 219   <li><a class="download" href="http://htmlpurifier.org/releases/htmlpurifier-trunk-lite.tar.gz">HTML Purifier Trunk Snapshot Lite (.tar.gz)</a></li>
 220   <li><a class="download" href="http://htmlpurifier.org/releases/htmlpurifier-trunk-standalone.tar.gz">HTML Purifier Trunk Snapshot Standalone (.tar.gz)</a></li>
 221 </ul>
 222
 223 <p>
 224   <strong>Warning:</strong> These builds have not yet been updated to use
 225   Git, so they may be slightly out-of-date.
 226 </p>
 227 -->
 228
 229 <h2 id="Installation">Installation</h2>
 230
 231 <h3>File permissions</h3>
 232
 233 <p>
 234   <strong>Starting with HTML Purifier 2.0.0, it is vital that you set
 235   proper directory permissions for where HTML Purifier writes out
 236   some temporary files.</strong> Specifically, HTML Purifier will write
 237   out cache files for HTMLDefinition in the subdirectories of
 238   <code>HTMLPurifier/DefinitionCache/Serializer</code>. If you are in
 239   the <code>library/</code> folder of HTML Purifier, you can set the
 240   appropriate permissions using:
 241 </p>
 242
 243 <pre class="command">chmod -R 0755 HTMLPurifier/DefinitionCache/Serializer</pre>
 244
 245 <p>
 246   If the above command doesn't work, you may need to assign write permissions
 247   to all. This may be necessary if your webserver runs as nobody, but is
 248   not recommended since it means any other user can write files in the
 249   directory. Use:
 250 </p>
 251
 252 <pre class="command">chmod -R 0777 HTMLPurifier/DefinitionCache/Serializer</pre>
 253
 254 <p>
 255   You can also chmod files via your <abbr>FTP</abbr> client; this option
 256   is usually accessible by right clicking the corresponding directory and
 257   then selecting <q>chmod</q> or <q>file permissions</q>.
 258 </p>
 259
 260 <p>
 261   If you are unable or unwilling to give write permissions to the cache
 262   directory, you can either disable the cache (and suffer a performance
 263   hit):
 264 </p>
 265
 266 <pre>$config->set('Core', 'DefinitionCache', null);</pre>
 267
 268 <p>
 269   Or move the cache directory somewhere else (no trailing slash):
 270 </p>
 271
 272 <pre>$config->set('Cache', 'SerializerPath', '/home/user/absolute/path');</pre>
 273
 274 <p>
 275   If there is a demand for it, future versions will also support
 276   <a href="http://danga.com/memcached/">memcached</a>
 277   as a caching system.
 278 </p>
 279
 280 <h3>Quick install</h3>
 281
 282 <p>If your website is in UTF-8 and XHTML Transitional, use this code:</p>
 283
 284 <pre>&lt;?php
 285     require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
 286
 287     $purifier = new HTMLPurifier();
 288     $clean_html = $purifier->purify($dirty_html);
 289 ?&gt;</pre>
 290
 291 <p>If your website is in a different encoding or doctype, use this code:</p>
 292
 293 <pre>&lt;?php
 294     require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
 295
 296     $config = HTMLPurifier_Config::createDefault();
 297     $config->set('Core', 'Encoding', <strong>'ISO-8859-1'</strong>); // replace with your encoding
 298     $config->set('HTML', 'Doctype', <strong>'HTML 4.01 Transitional'</strong>); // replace with your doctype
 299     $purifier = new HTMLPurifier($config);
 300
 301     $clean_html = $purifier->purify($dirty_html);
 302 ?&gt;</pre>
 303
 304 <p>
 305   People with HTML Purifier already in their path (<acronym>PEAR</acronym>,
 306   for example) can use:
 307 </p>
 308
 309 <pre>require_once 'HTMLPurifier.auto.php';</pre>
 310
 311 <p>
 312   For detailed installation instructions, read the
 313   <a href="http://repo.or.cz/w/htmlpurifier.git?a=blob;f=INSTALL;hb=v&htmlpurifier.current.version;"><code>INSTALL</code></a>
 314   document.
 315 </p>
 316
 317 <h2 id="MailingList">Mailing list</h2>
 318
 319 <p>
 320   You can be notified of new releases by a low-traffic announce list. Subscribe
 321   here:
 322 </p>
 323
 324 <form method="post" action="http://scripts.dreamhost.com/add_list.cgi">
 325    <div>
 326      <label for="name">Name</label>: <input type="text" name="name" id="name" />
 327      <label for="email">E-mail</label>: <input type="text" name="email" id="email" />
 328    </div>
 329    <div>
 330      <input type="submit" name="submit" value="Suscribe to Announcement List" />
 331      <input type="submit" name="unsub" value="Unsubscribe" />
 332    </div>
 333    <input type="hidden" name="list" value="admin@htmlpurifier.org" />
 334    <input type="hidden" name="domain" value="htmlpurifier.org" />
 335    <input type="hidden" name="emailit" value="1" />
 336 </form>
 337
 338 <p>
 339   We take your privacy very seriously and will not use emails submitted
 340   to this web form for any other purposes.
 341 </p>
 342
 343 <h2 id="History">History</h2>
 344
 345 <p>
 346   Previous releases can be obtained by browsing
 347   the <a href="releases/">release directory</a>
 348   or checking code out of the
 349   <a href="http://htmlpurifier.org/svnroot/htmlpurifier/tags/">tags/
 350   directory</a>.  However, they are not supported and should not be used
 351   in live environments. If you are having trouble upgrading, pop over
 352   to <a href="http://htmlpurifier.org/phorum/">the forums</a> and get help.
 353 </p>
 354
 355 </div>
 356 </div>
 357
 358 </body>
 359 </html>