README.md

   1 Node.js
   2 =======
   3
   4 [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/nodejs/node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
   5
   6 Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js
   7 uses an event-driven, non-blocking I/O model that makes it lightweight and
   8 efficient. The Node.js package ecosystem, npm, is the largest ecosystem of open
   9 source libraries in the world.
  10
  11 The Node.js project is supported by the
  12 [Node.js Foundation](https://nodejs.org/en/foundation/). Contributions,
  13 policies and releases are managed under an
  14 [open governance model](./GOVERNANCE.md). We are also bound by a
  15 [Code of Conduct](./CODE_OF_CONDUCT.md).
  16
  17 If you need help using or installing Node.js, please use the
  18 [nodejs/help](https://github.com/nodejs/help) issue tracker.
  19
  20 ## Release Types
  21
  22 The Node.js project maintains multiple types of releases:
  23
  24 * **Stable**: Released from active development branches of this repository,
  25   versioned by [SemVer](http://semver.org/) and signed by a member of the
  26   [Release Team](#release-team).
  27   Code for Stable releases is organized in this repository by major version
  28   number, For example: [v4.x](https://github.com/nodejs/node/tree/v4.x).
  29   The major version number of Stable releases will increment every 6 months
  30   allowing for breaking changes to be introduced. This happens in April and
  31   October every year. Stable release lines beginning in October each year have
  32   a maximum support life of 8 months. Stable release lines beginning in April
  33   each year will convert to LTS (see below) after 6 months and receive further
  34   support for 30 months.
  35 * **LTS**: Releases that receive Long-term Support, with a focus on stability
  36   and security. Every second Stable release line (major version) will become an
  37   LTS line and receive 18 months of _Active LTS_ support and a further 12
  38   months of _Maintenance_. LTS release lines are given alphabetically
  39   ordered codenames, beginning with v4 Argon. LTS releases are less frequent
  40   and will attempt to maintain consistent major and minor version numbers,
  41   only incrementing patch version numbers. There are no breaking changes or
  42   feature additions, except in some special circumstances. More information
  43   can be found in the [LTS README](https://github.com/nodejs/LTS/).
  44 * **Nightly**: Versions of code in this repository on the current Stable
  45   branch, automatically built every 24-hours where changes exist. Use with
  46   caution.
  47
  48 ## Download
  49
  50 Binaries, installers, and source tarballs are available at
  51 <https://nodejs.org>.
  52
  53 **Stable** and **LTS** releases are available at
  54 <https://nodejs.org/download/release/>, listed under their version strings.
  55 The [latest](https://nodejs.org/download/release/latest/) directory is an
  56 alias for the latest Stable release. The latest LTS release from an LTS
  57 line is available in the form: latest-_codename_. For example:
  58 <https://nodejs.org/download/release/latest-argon>
  59
  60 **Nightly** builds are available at
  61 <https://nodejs.org/download/nightly/>, listed under their version
  62 string which includes their date (in UTC time) and the commit SHA at
  63 the HEAD of the release.
  64
  65 **API documentation** is available in each release and nightly
  66 directory under _docs_. <https://nodejs.org/api/> points to the API
  67 documentation of the latest stable version.
  68
  69 ### Verifying Binaries
  70
  71 Stable, LTS and Nightly download directories all contain a *SHASUM256.txt*
  72 file that lists the SHA checksums for each file available for
  73 download. To check that a downloaded file matches the checksum, run
  74 it through `sha256sum` with a command such as:
  75
  76 ```
  77 $ grep node-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
  78 ```
  79
  80 _(Where "node-vx.y.z.tar.gz" is the name of the file you have
  81 downloaded)_
  82
  83 Additionally, Stable and LTS releases (not Nightlies) have GPG signed
  84 copies of SHASUM256.txt files available as SHASUM256.txt.asc. You can use
  85 `gpg` to verify that the file has not been tampered with.
  86
  87 To verify a SHASUM256.txt.asc, you will first need to import all of
  88 the GPG keys of individuals authorized to create releases. They are
  89 listed at the bottom of this README under [Release Team](#release-team).
  90 Use a command such as this to import the keys:
  91
  92 ```
  93 $ gpg --keyserver pool.sks-keyservers.net \
  94   --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
  95 ```
  96
  97 _(See the bottom of this README for a full script to import active
  98 release keys)_
  99
 100 You can then use `gpg --verify SHASUMS256.txt.asc` to verify that the
 101 file has been signed by an authorized member of the Node.js team.
 102
 103 Once verified, use the SHASUMS256.txt.asc file to get the checksum for
 104 the binary verification command above.
 105
 106 ## Building Node.js
 107
 108 See [BUILDING.md](BUILDING.md) for instructions on how to build
 109 Node.js from source.
 110
 111
 112 ## Resources for Newcomers
 113
 114 * [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
 115 * [CONTRIBUTING.md](./CONTRIBUTING.md)
 116 * [GOVERNANCE.md](./GOVERNANCE.md)
 117 * IRC (general questions): [#node.js on Freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
 118 * IRC (node core development): [#node-dev on Freenode.net](http://webchat.freenode.net?channels=node-dev&uio=d4)
 119 * [nodejs/node on Gitter](https://gitter.im/nodejs/node)
 120
 121 ## Security
 122
 123 All security bugs in Node.js are taken seriously and should be reported by
 124 emailing security@nodejs.org. This will be delivered to a subset of the project
 125 team who handle security issues. Please don't disclose security bugs
 126 publicly until they have been handled by the security team.
 127
 128 Your email will be acknowledged within 24 hours, and you’ll receive a more
 129 detailed response to your email within 48 hours indicating the next steps in
 130 handling your report.
 131
 132 ## Current Project Team Members
 133
 134 The Node.js project team comprises a group of core collaborators and a sub-group
 135 that forms the _Core Technical Committee_ (CTC) which governs the project. For more
 136 information about the governance of the Node.js project, see
 137 [GOVERNANCE.md](./GOVERNANCE.md).
 138
 139 ### CTC (Core Technical Committee)
 140
 141 * [bnoordhuis](https://github.com/bnoordhuis) - **Ben Noordhuis** &lt;info@bnoordhuis.nl&gt;
 142 * [ChALkeR](https://github.com/ChALkeR) - **Сковорода Никита Андреевич** &lt;chalkerx@gmail.com&gt;
 143 * [chrisdickinson](https://github.com/chrisdickinson) - **Chris Dickinson** &lt;christopher.s.dickinson@gmail.com&gt;
 144 * [cjihrig](https://github.com/cjihrig) - **Colin Ihrig** &lt;cjihrig@gmail.com&gt;
 145 * [evanlucas](https://github.com/evanlucas) - **Evan Lucas** &lt;evanlucas@me.com&gt;
 146 * [fishrock123](https://github.com/fishrock123) - **Jeremiah Senkpiel** &lt;fishrock123@rocketmail.com&gt;
 147 * [indutny](https://github.com/indutny) - **Fedor Indutny** &lt;fedor.indutny@gmail.com&gt;
 148 * [jasnell](https://github.com/jasnell) - **James M Snell** &lt;jasnell@gmail.com&gt;
 149 * [misterdjules](https://github.com/misterdjules) - **Julien Gilli** &lt;jgilli@nodejs.org&gt;
 150 * [mscdex](https://github.com/mscdex) - **Brian White** &lt;mscdex@mscdex.net&gt;
 151 * [ofrobots](https://github.com/ofrobots) - **Ali Ijaz Sheikh** &lt;ofrobots@google.com&gt;
 152 * [orangemocha](https://github.com/orangemocha) - **Alexis Campailla** &lt;orangemocha@nodejs.org&gt;
 153 * [piscisaureus](https://github.com/piscisaureus) - **Bert Belder** &lt;bertbelder@gmail.com&gt;
 154 * [rvagg](https://github.com/rvagg) - **Rod Vagg** &lt;rod@vagg.org&gt;
 155 * [shigeki](https://github.com/shigeki) - **Shigeki Ohtsu** &lt;ohtsu@iij.ad.jp&gt;
 156 * [trevnorris](https://github.com/trevnorris) - **Trevor Norris** &lt;trev.norris@gmail.com&gt;
 157 * [Trott](https://github.com/Trott) - **Rich Trott** &lt;rtrott@gmail.com&gt;
 158
 159 ### Collaborators
 160
 161 * [AndreasMadsen](https://github.com/AndreasMadsen) - **Andreas Madsen** &lt;amwebdk@gmail.com&gt;
 162 * [benjamingr](https://github.com/benjamingr) - **Benjamin Gruenbaum** &lt;benjamingr@gmail.com&gt;
 163 * [brendanashworth](https://github.com/brendanashworth) - **Brendan Ashworth** &lt;brendan.ashworth@me.com&gt;
 164 * [calvinmetcalf](https://github.com/calvinmetcalf) - **Calvin Metcalf** &lt;calvin.metcalf@gmail.com&gt;
 165 * [claudiorodriguez](https://github.com/claudiorodriguez) - **Claudio Rodriguez** &lt;cjrodr@yahoo.com&gt;
 166 * [domenic](https://github.com/domenic) - **Domenic Denicola** &lt;d@domenic.me&gt;
 167 * [geek](https://github.com/geek) - **Wyatt Preul** &lt;wpreul@gmail.com&gt;
 168 * [iarna](https://github.com/iarna) - **Rebecca Turner** &lt;me@re-becca.org&gt;
 169 * [isaacs](https://github.com/isaacs) - **Isaac Z. Schlueter** &lt;i@izs.me&gt;
 170 * [jbergstroem](https://github.com/jbergstroem) - **Johan Bergström** &lt;bugs@bergstroem.nu&gt;
 171 * [joaocgreis](https://github.com/joaocgreis) - **João Reis** &lt;reis@janeasystems.com&gt;
 172 * [julianduque](https://github.com/julianduque) - **Julian Duque** &lt;julianduquej@gmail.com&gt;
 173 * [JungMinu](https://github.com/JungMinu) - **Minwoo Jung** &lt;jmwsoft@gmail.com&gt;
 174 * [lxe](https://github.com/lxe) - **Aleksey Smolenchuk** &lt;lxe@lxe.co&gt;
 175 * [matthewloring](https://github.com/matthewloring) - **Matthew Loring** &lt;mattloring@google.com&gt;
 176 * [mcollina](https://github.com/mcollina) - **Matteo Collina** &lt;matteo.collina@gmail.com&gt;
 177 * [mhdawson](https://github.com/mhdawson) - **Michael Dawson** &lt;michael_dawson@ca.ibm.com&gt;
 178 * [micnic](https://github.com/micnic) - **Nicu Micleușanu** &lt;micnic90@gmail.com&gt;
 179 * [mikeal](https://github.com/mikeal) - **Mikeal Rogers** &lt;mikeal.rogers@gmail.com&gt;
 180 * [monsanto](https://github.com/monsanto) - **Christopher Monsanto** &lt;chris@monsan.to&gt;
 181 * [Olegas](https://github.com/Olegas) - **Oleg Elifantiev** &lt;oleg@elifantiev.ru&gt;
 182 * [petkaantonov](https://github.com/petkaantonov) - **Petka Antonov** &lt;petka_antonov@hotmail.com&gt;
 183 * [phillipj](https://github.com/phillipj) - **Phillip Johnsen** &lt;johphi@gmail.com&gt;
 184 * [qard](https://github.com/qard) - **Stephen Belanger** &lt;admin@stephenbelanger.com&gt;
 185 * [rlidwka](https://github.com/rlidwka) - **Alex Kocharin** &lt;alex@kocharin.ru&gt;
 186 * [rmg](https://github.com/rmg) - **Ryan Graham** &lt;r.m.graham@gmail.com&gt;
 187 * [robertkowalski](https://github.com/robertkowalski) - **Robert Kowalski** &lt;rok@kowalski.gd&gt;
 188 * [romankl](https://github.com/romankl) - **Roman Klauke** &lt;romaaan.git@gmail.com&gt;
 189 * [saghul](https://github.com/saghul) - **Saúl Ibarra Corretgé** &lt;saghul@gmail.com&gt;
 190 * [sam-github](https://github.com/sam-github) - **Sam Roberts** &lt;vieuxtech@gmail.com&gt;
 191 * [seishun](https://github.com/seishun) - **Nikolai Vavilov** &lt;vvnicholas@gmail.com&gt;
 192 * [silverwind](https://github.com/silverwind) - **Roman Reiss** &lt;me@silverwind.io&gt;
 193 * [srl295](https://github.com/srl295) - **Steven R Loomis** &lt;srloomis@us.ibm.com&gt;
 194 * [targos](https://github.com/targos) - **Michaël Zasso** &lt;mic.besace@gmail.com&gt;
 195 * [tellnes](https://github.com/tellnes) - **Christian Tellnes** &lt;christian@tellnes.no&gt;
 196 * [thealphanerd](https://github.com/thealphanerd) - **Myles Borins** &lt;myles.borins@gmail.com&gt;
 197 * [thefourtheye](https://github.com/thefourtheye) - **Sakthipriyan Vairamani** &lt;thechargingvolcano@gmail.com&gt;
 198 * [thekemkid](https://github.com/thekemkid) - **Glen Keane** &lt;glenkeane.94@gmail.com&gt;
 199 * [thlorenz](https://github.com/thlorenz) - **Thorsten Lorenz** &lt;thlorenz@gmx.de&gt;
 200 * [tunniclm](https://github.com/tunniclm) - **Mike Tunnicliffe** &lt;m.j.tunnicliffe@gmail.com&gt;
 201 * [vkurchatkin](https://github.com/vkurchatkin) - **Vladimir Kurchatkin** &lt;vladimir.kurchatkin@gmail.com&gt;
 202 * [whitlockjc](https://github.com/whitlockjc) - **Jeremy Whitlock** &lt;jwhitlock@apache.org&gt;
 203 * [yosuke-furukawa](https://github.com/yosuke-furukawa) - **Yosuke Furukawa** &lt;yosuke.furukawa@gmail.com&gt;
 204 * [zkat](https://github.com/zkat) - **Kat Marchán** &lt;kzm@sykosomatic.org&gt;
 205
 206 Collaborators & CTC members follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
 207 maintaining the Node.js project.
 208
 209 ### Release Team
 210
 211 Releases of Node.js and io.js will be signed with one of the following GPG keys:
 212
 213 * **Chris Dickinson** &lt;christopher.s.dickinson@gmail.com&gt; `9554F04D7259F04124DE6B476D5A82AC7E37093B`
 214 * **Colin Ihrig** &lt;cjihrig@gmail.com&gt; `94AE36675C464D64BAFA68DD7434390BDBE9B9C5`
 215 * **Evan Lucas** &lt;evanlucas@me.com&gt; `B9AE9905FFD7803F25714661B63B535A4C206CA9`
 216 * **James M Snell** &lt;jasnell@keybase.io&gt; `71DCFD284A79C3B38668286BC97EC7A07EDE3FC1`
 217 * **Jeremiah Senkpiel** &lt;fishrock@keybase.io&gt; `FD3A5288F042B6850C66B31F09FE44734EB7990E`
 218 * **Myles Borins** &lt;myles.borins@gmail.com&gt; `C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8`
 219 * **Rod Vagg** &lt;rod@vagg.org&gt; `DD8F2338BAE7501E3DD5AC78C273792F7D83545D`
 220 * **Sam Roberts** &lt;octetcloud@keybase.io&gt; `0034A06D9D9B0064CE8ADF6BF1747F4AD2306D93`
 221
 222 The full set of trusted release keys can be imported by running:
 223
 224 ```
 225 gpg --keyserver pool.sks-keyservers.net --recv-keys 9554F04D7259F04124DE6B476D5A82AC7E37093B
 226 gpg --keyserver pool.sks-keyservers.net --recv-keys 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
 227 gpg --keyserver pool.sks-keyservers.net --recv-keys 0034A06D9D9B0064CE8ADF6BF1747F4AD2306D93
 228 gpg --keyserver pool.sks-keyservers.net --recv-keys FD3A5288F042B6850C66B31F09FE44734EB7990E
 229 gpg --keyserver pool.sks-keyservers.net --recv-keys 71DCFD284A79C3B38668286BC97EC7A07EDE3FC1
 230 gpg --keyserver pool.sks-keyservers.net --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
 231 gpg --keyserver pool.sks-keyservers.net --recv-keys C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8
 232 gpg --keyserver pool.sks-keyservers.net --recv-keys B9AE9905FFD7803F25714661B63B535A4C206CA9
 233 ```
 234
 235 See the section above on [Verifying Binaries](#verifying-binaries) for
 236 details on what to do with these keys to verify that a downloaded file is official.
 237
 238 Previous releases of Node.js have been signed with one of the following GPG
 239 keys:
 240
 241 * **Isaac Z. Schlueter** &lt;i@izs.me&gt; `93C7E9E91B49E432C2F75674B0A78B0A6C481CF6`
 242 * **Julien Gilli** &lt;jgilli@fastmail.fm&gt; `114F43EE0176B71C7BC219DD50A3051F888C628D`
 243 * **Timothy J Fontaine** &lt;tjfontaine@gmail.com&gt; `7937DFD2AB06298B2293C3187D33FF9D0246406D`