README.md

   1 # HHVM
   2
   3 [HHVM page](http://hhvm.com) |
   4 [Hacklang page](http://hacklang.org) |
   5 [General group](https://www.facebook.com/groups/hhvm.general/) |
   6 [Dev group](https://www.facebook.com/groups/hhvm.dev/) |
   7 [Twitter](http://twitter.com/HipHopVM)
   8
   9 HHVM (aka the HipHop Virtual Machine) is an open-source virtual machine designed for executing programs written in [Hack](http://hacklang.org) and PHP. HHVM uses a just-in-time compilation approach to achieve superior performance while maintaining the flexibility that PHP developers are accustomed to. To date, HHVM (and its predecessor HPHPc before it) has realized over a 9x increase in web request throughput and over a 5x reduction in memory consumption for Facebook compared with the PHP 5.2 engine + APC.
  10
  11 HHVM should be used together with a FastCGI-based webserver like [nginx](https://github.com/facebook/hhvm/wiki/FastCGI#making-it-work-with-nginx) or [apache](https://github.com/facebook/hhvm/wiki/FastCGI#making-it-work-with-apache).
  12
  13 ## Reporting and Fixing Security Issues
  14
  15 Please do not open GitHub issues or pull requests - this makes the problem
  16 immediately visible to everyone, including malicious actors. Security issues in
  17 HHVM can be safely reported via HHVM's Whitehat Bug Bounty program:
  18
  19 https://www.facebook.com/whitehat
  20
  21 Facebook's security team will triage your report and determine whether or not
  22 is it eligible for a bounty under our program.
  23
  24 ## FAQ
  25
  26 Our [FAQ](https://github.com/facebook/hhvm/wiki/FAQ) has answers to many common questions about HHVM, from [general questions](https://github.com/facebook/hhvm/wiki/FAQ#general) to questions geared towards those that want to [use](https://github.com/facebook/hhvm/wiki/FAQ#users) or [contribute](https://github.com/facebook/hhvm/wiki/FAQ#contributors) to HHVM.
  27
  28
  29 ## Installing
  30
  31 If you're new, try our [getting started overview](https://github.com/facebook/hhvm/wiki/Getting-Started).
  32
  33 You can install a [prebuilt package](https://github.com/facebook/hhvm/wiki/Prebuilt%20Packages%20for%20HHVM) or [compile from source](https://github.com/facebook/hhvm/wiki/Building%20and%20Installing%20HHVM).
  34
  35
  36 ## Running
  37
  38 You can run standalone programs just by passing them to hhvm: `hhvm my_script.php`.
  39
  40 If you want to host a website:
  41 * Install your favorite webserver
  42 * Install our [package](https://github.com/facebook/hhvm/wiki/Prebuilt%20Packages%20for%20HHVM)
  43 * Start your webserver
  44 * Run `sudo /etc/init.d/hhvm start`
  45 * Visit your site at http://.../index.php
  46
  47 Our [getting started overview](https://github.com/facebook/hhvm/wiki/Getting-Started) provides a slightly more detailed introduction as well as links to more information.
  48
  49
  50 ## Contributing
  51
  52 We'd love to have your help in making HHVM better. If you're interested, please read our [guide to contributing](CONTRIBUTING.md).
  53
  54 ## License
  55
  56 HHVM is licensed under the PHP and Zend licenses except as otherwise noted.
  57
  58 The Hack typechecker (`hphp/hack`) is licensed under the BSD license (`hphp/hack/LICENSE`) with an additional grant of patent rights (`hphp/hack/PATENTS`) except as otherwise noted.
  59
  60
  61 ## Reporting Crashes
  62
  63 See [Reporting Crashes](https://github.com/facebook/hhvm/wiki/Reporting-Crashes) for helpful tips on how to report crashes in an actionable manner.