5 [![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)
7 This repository began as a GitHub fork of
8 [joyent/node](https://github.com/joyent/node).
10 Node.js contributions, releases, and contributorship are under an
11 [open governance model](./GOVERNANCE.md).
12 We intend to land, with increasing regularity, releases which are
13 compatible with the npm ecosystem that has been built to date for
18 Binaries, installers, and source tarballs are available at
21 **Releases** are available at <https://nodejs.org/dist/>, listed under
22 their version string. The <https://nodejs.org/dist/latest/> symlink
23 will point to the latest release directory.
25 **Nightly** builds are available at
26 <https://nodejs.org/download/nightly/>, listed under their version
27 string which includes their date (in UTC time) and the commit SHA at
28 the HEAD of the release.
30 **API documentation** is available in each release and nightly
31 directory under _docs_. <https://nodejs.org/api/> points to the latest version.
33 ### Verifying Binaries
35 Release and nightly download directories all contain a *SHASUM256.txt*
36 file that lists the SHA checksums for each file available for
37 download. To check that a downloaded file matches the checksum, run
38 it through `sha256sum` with a command such as:
41 $ grep node-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
44 _(Where "node-vx.y.z.tar.gz" is the name of the file you have
47 Additionally, releases (not nightlies) have GPG signed copies of
48 SHASUM256.txt files available as SHASUM256.txt.asc. You can use `gpg`
49 to verify that the file has not been tampered with.
51 To verify a SHASUM256.txt.asc, you will first need to import all of
52 the GPG keys of individuals authorized to create releases. They are
53 listed at the bottom of this README under [Release Team](#release-team).
54 Use a command such as this to import the keys:
57 $ gpg --keyserver pool.sks-keyservers.net \
58 --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
61 _(See the bottom of this README for a full script to import active
64 You can then use `gpg --verify SHASUMS256.txt.asc` to verify that the
65 file has been signed by an authorized member of the Node.js team.
67 Once verified, use the SHASUMS256.txt.asc file to get the checksum for
68 the binary verification command above.
76 * `gcc` and `g++` 4.8 or newer, or
77 * `clang` and `clang++` 3.4 or newer
79 * GNU Make 3.81 or newer
80 * libexecinfo (FreeBSD and OpenBSD only)
88 If your Python binary is in a non-standard location or has a
89 non-standard name, run the following instead:
92 $ export PYTHON=/path/to/python
104 To build the documentation:
110 To read the documentation:
116 To test if Node.js was built correctly:
119 $ node -e "console.log('Hello from node.js ' + process.version)"
126 * [Python 2.6 or 2.7](https://www.python.org/downloads/)
127 * Visual Studio 2013 for Windows Desktop, or
128 * Visual Studio Express 2013 for Windows Desktop
129 * Basic Unix tools required for some tests,
130 [Git for Windows](http://git-scm.com/download/win) includes Git Bash
131 and tools which can be included in the global `PATH`.
143 To test if Node.js was built correctly:
146 $ node -e "console.log('Hello from node.js ' + process.version)"
149 ### Android / Android based devices, aka. Firefox OS
151 Be sure you have downloaded and extracted [Android NDK]
152 (https://developer.android.com/tools/sdk/ndk/index.html)
153 before in a folder. Then run:
156 $ ./android-configure /path/to/your/android-ndk
160 ### `Intl` (ECMA-402) support:
162 [Intl](https://github.com/nodejs/node/wiki/Intl) support is not
165 #### "small" (English only) support
167 This option will build with "small" (English only) support, but
168 the full `Intl` (ECMA-402) APIs. With `--download=all` it will
169 download the ICU library as needed.
174 $ ./configure --with-intl=small-icu --download=all
180 > vcbuild small-icu download-all
183 The `small-icu` mode builds with English-only data. You can add full
186 *Note:* more docs are on
187 [the node wiki](https://github.com/nodejs/node/wiki/Intl).
189 #### Build with full ICU support (all locales supported by ICU):
191 With the `--download=all`, this may download ICU if you don't have an
197 $ ./configure --with-intl=full-icu --download=all
203 > vcbuild full-icu download-all
206 #### Build with no Intl support `:-(`
208 The `Intl` object will not be available. This is the default at
209 present, so this option is not normally needed.
214 $ ./configure --with-intl=none
223 #### Use existing installed ICU (Unix / Macintosh only):
226 $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
229 #### Build with a specific ICU:
231 You can find other ICU releases at
232 [the ICU homepage](http://icu-project.org/download).
233 Download the file named something like `icu4c-**##.#**-src.tgz` (or
239 # from an already-unpacked ICU:
240 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
242 # from a local ICU tarball
243 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
246 $ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
251 First unpack latest ICU to `deps/icu`
252 [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
253 as `deps/icu` (You'll have: `deps/icu/source/...`)
259 # Building Node.js with FIPS-compliant OpenSSL
261 NOTE: Windows is not yet supported
263 It is possible to build Node.js with
264 [OpenSSL FIPS module](https://www.openssl.org/docs/fips/fipsnotes.html).
266 **Note** that building in this way does **not** allow you to
267 claim that the runtime is FIPS 140-2 validated. Instead you
268 can indicate that the runtime uses a validated module. See
269 the [security policy]
270 (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf)
271 page 60 for more details. In addition, the validation for
272 the underlying module is only valid if it is deployed in
273 accordance with its [security policy]
274 (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf).
275 If you need FIPS validated cryptography it is recommended that you
276 read both the [security policy]
277 (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf)
278 and [user guide] (https://openssl.org/docs/fips/UserGuide-2.0.pdf).
282 1. Obtain a copy of openssl-fips-x.x.x.tar.gz.
283 To comply with the security policy you must ensure the path
284 through which you get the file complies with the requirements
285 for a "secure installation" as described in section 6.6 in
286 the [user guide] (https://openssl.org/docs/fips/UserGuide-2.0.pdf).
287 For evaluation/experimentation you can simply download and verify
288 `openssl-fips-x.x.x.tar.gz` from https://www.openssl.org/source/
289 2. Extract source to `openssl-fips` folder and `cd openssl-fips`
293 (NOTE: to comply with the security policy you must use the exact
294 commands in steps 3-5 without any additional options as per
295 Appendix A in the [security policy]
296 (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf).
297 The only exception is that `./config no-asm` can be
298 used in place of `./config` )
299 6. Get into Node.js checkout folder
300 7. `./configure --openssl-fips=/path/to/openssl-fips/installdir`
301 For example on ubuntu 12 the installation directory was
302 /usr/local/ssl/fips-2.0
303 8. Build Node.js with `make -j`
304 9. Verify with `node -p "process.versions.openssl"` (`1.0.2a-fips`)
306 ## Resources for Newcomers
308 * [CONTRIBUTING.md](./CONTRIBUTING.md)
309 * [GOVERNANCE.md](./GOVERNANCE.md)
311 [#io.js on Freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4)
312 * [nodejs/node on Gitter](https://gitter.im/nodejs/node)
316 All security bugs in node.js are taken seriously and should be reported by
317 emailing security@nodejs.org. This will be delivered to a subset of the project
318 team who handle security issues. Please don't disclose security bugs
319 public until they have been handled by the security team.
321 Your email will be acknowledged within 24 hours, and you’ll receive a more
322 detailed response to your email within 48 hours indicating the next steps in
323 handling your report.
325 ## Current Project Team Members
327 The Node.js project team comprises a group of core collaborators and a sub-group
328 that forms the _Technical Steering Committee_ (TSC) which governs the project. For more
329 information about the governance of the Node.js project, see
330 [GOVERNANCE.md](./GOVERNANCE.md).
332 ### TSC (Technical Steering Committee)
334 * [bnoordhuis](https://github.com/bnoordhuis) - **Ben Noordhuis** <info@bnoordhuis.nl>
335 * [chrisdickinson](https://github.com/chrisdickinson) - **Chris Dickinson** <christopher.s.dickinson@gmail.com>
336 * [cjihrig](https://github.com/cjihrig) - **Colin Ihrig** <cjihrig@gmail.com>
337 * [fishrock123](https://github.com/fishrock123) - **Jeremiah Senkpiel** <fishrock123@rocketmail.com>
338 * [indutny](https://github.com/indutny) - **Fedor Indutny** <fedor.indutny@gmail.com>
339 * [jasnell](https://github.com/jasnell) - **James M Snell** <jasnell@gmail.com>
340 * [misterdjules](https://github.com/misterdjules) - **Julien Gilli** <jgilli@nodejs.org>
341 * [mscdex](https://github.com/mscdex) - **Brian White** <mscdex@mscdex.net>
342 * [orangemocha](https://github.com/orangemocha) - **Alexis Campailla** <orangemocha@nodejs.org>
343 * [piscisaureus](https://github.com/piscisaureus) - **Bert Belder** <bertbelder@gmail.com>
344 * [rvagg](https://github.com/rvagg) - **Rod Vagg** <rod@vagg.org>
345 * [shigeki](https://github.com/shigeki) - **Shigeki Ohtsu** <ohtsu@iij.ad.jp>
346 * [trevnorris](https://github.com/trevnorris) - **Trevor Norris** <trev.norris@gmail.com>
350 * [brendanashworth](https://github.com/brendanashworth) - **Brendan Ashworth** <brendan.ashworth@me.com>
351 * [ChALkeR](https://github.com/ChALkeR) - **Сковорода Никита Андреевич** <chalkerx@gmail.com>
352 * [domenic](https://github.com/domenic) - **Domenic Denicola** <d@domenic.me>
353 * [evanlucas](https://github.com/evanlucas) - **Evan Lucas** <evanlucas@me.com>
354 * [geek](https://github.com/geek) - **Wyatt Preul** <wpreul@gmail.com>
355 * [isaacs](https://github.com/isaacs) - **Isaac Z. Schlueter** <i@izs.me>
356 * [jbergstroem](https://github.com/jbergstroem) - **Johan Bergström** <bugs@bergstroem.nu>
357 * [joaocgreis](https://github.com/joaocgreis) - **João Reis** <reis@janeasystems.com>
358 * [julianduque](https://github.com/julianduque) - **Julian Duque** <julianduquej@gmail.com>
359 * [lxe](https://github.com/lxe) - **Aleksey Smolenchuk** <lxe@lxe.co>
360 * [mhdawson](https://github.com/mhdawson) - **Michael Dawson** <michael_dawson@ca.ibm.com>
361 * [micnic](https://github.com/micnic) - **Nicu Micleușanu** <micnic90@gmail.com>
362 * [mikeal](https://github.com/mikeal) - **Mikeal Rogers** <mikeal.rogers@gmail.com>
363 * [monsanto](https://github.com/monsanto) - **Christopher Monsanto** <chris@monsan.to>
364 * [ofrobots](https://github.com/ofrobots) - **Ali Ijaz Sheikh** <ofrobots@google.com>
365 * [Olegas](https://github.com/Olegas) - **Oleg Elifantiev** <oleg@elifantiev.ru>
366 * [petkaantonov](https://github.com/petkaantonov) - **Petka Antonov** <petka_antonov@hotmail.com>
367 * [qard](https://github.com/qard) - **Stephen Belanger** <admin@stephenbelanger.com>
368 * [rlidwka](https://github.com/rlidwka) - **Alex Kocharin** <alex@kocharin.ru>
369 * [robertkowalski](https://github.com/robertkowalski) - **Robert Kowalski** <rok@kowalski.gd>
370 * [sam-github](https://github.com/sam-github) - **Sam Roberts** <vieuxtech@gmail.com>
371 * [seishun](https://github.com/seishun) - **Nikolai Vavilov** <vvnicholas@gmail.com>
372 * [silverwind](https://github.com/silverwind) - **Roman Reiss** <me@silverwind.io>
373 * [srl295](https://github.com/srl295) - **Steven R Loomis** <srloomis@us.ibm.com>
374 * [targos](https://github.com/targos) - **Michaël Zasso** <mic.besace@gmail.com>
375 * [tellnes](https://github.com/tellnes) - **Christian Tellnes** <christian@tellnes.no>
376 * [thefourtheye](https://github.com/thefourtheye) - **Sakthipriyan Vairamani** <thechargingvolcano@gmail.com>
377 * [thlorenz](https://github.com/thlorenz) - **Thorsten Lorenz** <thlorenz@gmx.de>
378 * [Trott](https://github.com/Trott) - **Rich Trott** <rtrott@gmail.com>
379 * [tunniclm](https://github.com/tunniclm) - **Mike Tunnicliffe** <m.j.tunnicliffe@gmail.com>
380 * [vkurchatkin](https://github.com/vkurchatkin) - **Vladimir Kurchatkin** <vladimir.kurchatkin@gmail.com>
381 * [yosuke-furukawa](https://github.com/yosuke-furukawa) - **Yosuke Furukawa** <yosuke.furukawa@gmail.com>
383 Collaborators & TSC members follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
384 maintaining the Node.js project.
388 Releases of Node.js and io.js will be signed with one of the following GPG keys:
390 * **Chris Dickinson** <christopher.s.dickinson@gmail.com>: `9554F04D7259F04124DE6B476D5A82AC7E37093B`
391 * **Colin Ihrig** <cjihrig@gmail.com> `94AE36675C464D64BAFA68DD7434390BDBE9B9C5`
392 * **Sam Roberts** <octetcloud@keybase.io> `0034A06D9D9B0064CE8ADF6BF1747F4AD2306D93`
393 * **Jeremiah Senkpiel** <fishrock@keybase.io> `FD3A5288F042B6850C66B31F09FE44734EB7990E`
394 * **James M Snell** <jasnell@keybase.io> `71DCFD284A79C3B38668286BC97EC7A07EDE3FC1`
395 * **Rod Vagg** <rod@vagg.org> `DD8F2338BAE7501E3DD5AC78C273792F7D83545D`
397 The full set of trusted release keys can be imported by running:
400 gpg --keyserver pool.sks-keyservers.net --recv-keys 9554F04D7259F04124DE6B476D5A82AC7E37093B
401 gpg --keyserver pool.sks-keyservers.net --recv-keys 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
402 gpg --keyserver pool.sks-keyservers.net --recv-keys 0034A06D9D9B0064CE8ADF6BF1747F4AD2306D93
403 gpg --keyserver pool.sks-keyservers.net --recv-keys FD3A5288F042B6850C66B31F09FE44734EB7990E
404 gpg --keyserver pool.sks-keyservers.net --recv-keys 71DCFD284A79C3B38668286BC97EC7A07EDE3FC1
405 gpg --keyserver pool.sks-keyservers.net --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
408 See the section above on [Verifying Binaries](#verifying-binaries) for
409 details on what to do with these keys to verify that a downloaded file is official.
411 Previous releases of Node.js have been signed with one of the following GPG
414 * Julien Gilli <jgilli@fastmail.fm> `114F43EE0176B71C7BC219DD50A3051F888C628D`
415 * Timothy J Fontaine <tjfontaine@gmail.com> `7937DFD2AB06298B2293C3187D33FF9D0246406D`
416 * Isaac Z. Schlueter <i@izs.me> `93C7E9E91B49E432C2F75674B0A78B0A6C481CF6`