README.md

   1
   2 Node.js
   3 =====
   4
   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)
   6
   7 This repository began as a GitHub fork of
   8 [joyent/node](https://github.com/joyent/node).
   9
  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
  14 Node.js.
  15
  16 ## Download
  17
  18 Binaries, installers, and source tarballs are available at
  19 <https://nodejs.org>.
  20
  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.
  24
  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.
  29
  30 **API documentation** is available in each release and nightly
  31 directory under _docs_. <https://nodejs.org/api/> points to the latest version.
  32
  33 ### Verifying Binaries
  34
  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:
  39
  40 ```
  41 $ grep node-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
  42 ```
  43
  44 _(Where "node-vx.y.z.tar.gz" is the name of the file you have
  45 downloaded)_
  46
  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.
  50
  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. Use a command such as this to
  54 import the keys:
  55
  56 ```
  57 $ gpg --keyserver pool.sks-keyservers.net \
  58   --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
  59 ```
  60
  61 _(Include each of the key fingerprints at the end of this command.)_
  62
  63 You can then use `gpg --verify SHASUMS256.txt.asc` to verify that the
  64 file has been signed by an authorized member of the Node.js team.
  65
  66 Once verified, use the SHASUMS256.txt.asc file to get the checksum for
  67 the binary verification command above.
  68
  69 ## Build
  70
  71 ### Unix / Macintosh
  72
  73 Prerequisites:
  74
  75 * `gcc` and `g++` 4.8 or newer, or
  76 * `clang` and `clang++` 3.4 or newer
  77 * Python 2.6 or 2.7
  78 * GNU Make 3.81 or newer
  79 * libexecinfo (FreeBSD and OpenBSD only)
  80
  81 ```text
  82 $ ./configure
  83 $ make
  84 $ [sudo] make install
  85 ```
  86
  87 If your Python binary is in a non-standard location or has a
  88 non-standard name, run the following instead:
  89
  90 ```text
  91 $ export PYTHON=/path/to/python
  92 $ $PYTHON ./configure
  93 $ make
  94 $ [sudo] make install
  95 ```
  96
  97 To run the tests:
  98
  99 ```text
 100 $ make test
 101 ```
 102
 103 To build the documentation:
 104
 105 ```text
 106 $ make doc
 107 ```
 108
 109 To read the documentation:
 110
 111 ```text
 112 $ man doc/node.1
 113 ```
 114
 115 To test if Node.js was built correctly:
 116
 117 ```
 118 $ node -e "console.log('Hello from node.js ' + process.version)"
 119 ```
 120
 121 ### Windows
 122
 123 Prerequisites:
 124
 125 * [Python 2.6 or 2.7](https://www.python.org/downloads/)
 126 * Visual Studio 2013 for Windows Desktop, or
 127 * Visual Studio Express 2013 for Windows Desktop
 128 * Basic Unix tools required for some tests,
 129   [Git for Windows](http://git-scm.com/download/win) includes Git Bash
 130   and tools which can be included in the global `PATH`.
 131
 132 ```text
 133 > vcbuild nosign
 134 ```
 135
 136 To run the tests:
 137
 138 ```text
 139 > vcbuild test
 140 ```
 141
 142 To test if Node.js was built correctly:
 143
 144 ```
 145 $ node -e "console.log('Hello from node.js ' + process.version)"
 146 ```
 147
 148 ### Android / Android based devices, aka. Firefox OS
 149
 150 Be sure you have downloaded and extracted [Android NDK]
 151 (https://developer.android.com/tools/sdk/ndk/index.html)
 152 before in a folder. Then run:
 153
 154 ```
 155 $ ./android-configure /path/to/your/android-ndk
 156 $ make
 157 ```
 158
 159 ### `Intl` (ECMA-402) support:
 160
 161 [Intl](https://github.com/joyent/node/wiki/Intl) support is not
 162 enabled by default.
 163
 164 #### "small" (English only) support
 165
 166 This option will build with "small" (English only) support, but
 167 the full `Intl` (ECMA-402) APIs.  With `--download=all` it will
 168 download the ICU library as needed.
 169
 170 Unix / Macintosh:
 171
 172 ```text
 173 $ ./configure --with-intl=small-icu --download=all
 174 ```
 175
 176 Windows:
 177
 178 ```text
 179 > vcbuild small-icu download-all
 180 ```
 181
 182 The `small-icu` mode builds with English-only data. You can add full
 183 data at runtime.
 184
 185 *Note:* more docs are on
 186 [the joyent/node wiki](https://github.com/joyent/node/wiki/Intl).
 187
 188 #### Build with full ICU support (all locales supported by ICU):
 189
 190 With the `--download=all`, this may download ICU if you don't have an
 191 ICU in `deps/icu`.
 192
 193 Unix / Macintosh:
 194
 195 ```text
 196 $ ./configure --with-intl=full-icu --download=all
 197 ```
 198
 199 Windows:
 200
 201 ```text
 202 > vcbuild full-icu download-all
 203 ```
 204
 205 #### Build with no Intl support `:-(`
 206
 207 The `Intl` object will not be available. This is the default at
 208 present, so this option is not normally needed.
 209
 210 Unix / Macintosh:
 211
 212 ```text
 213 $ ./configure --with-intl=none
 214 ```
 215
 216 Windows:
 217
 218 ```text
 219 > vcbuild intl-none
 220 ```
 221
 222 #### Use existing installed ICU (Unix / Macintosh only):
 223
 224 ```text
 225 $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
 226 ```
 227
 228 #### Build with a specific ICU:
 229
 230 You can find other ICU releases at
 231 [the ICU homepage](http://icu-project.org/download).
 232 Download the file named something like `icu4c-**##.#**-src.tgz` (or
 233 `.zip`).
 234
 235 Unix / Macintosh
 236
 237 ```text
 238 # from an already-unpacked ICU:
 239 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
 240
 241 # from a local ICU tarball
 242 $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
 243
 244 # from a tarball URL
 245 $ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
 246 ```
 247
 248 Windows
 249
 250 First unpack latest ICU to `deps/icu`
 251 [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
 252 as `deps/icu` (You'll have: `deps/icu/source/...`)
 253
 254 ```text
 255 > vcbuild full-icu
 256 ```
 257
 258 # Building Node.js with FIPS-compliant OpenSSL
 259
 260 NOTE: Windows is not yet supported
 261
 262 It is possible to build Node.js with
 263 [OpenSSL FIPS module](https://www.openssl.org/docs/fips/fipsnotes.html).
 264
 265 **Note** that building in this way does **not** allow you to
 266 claim that the runtime is FIPS 140-2 validated.  Instead you
 267 can indicate that the runtime uses a validated module.  See
 268 the [security policy]
 269 (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf)
 270 page 60 for more details.  In addition, the validation for
 271 the underlying module is only valid if it is deployed in
 272 accordance with its [security policy]
 273 (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf).
 274 If you need FIPS validated cryptography it is recommended that you
 275 read both the [security policy]
 276 (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf)
 277 and [user guide] (https://openssl.org/docs/fips/UserGuide-2.0.pdf).
 278
 279 Instructions:
 280
 281 1. Obtain a copy of openssl-fips-x.x.x.tar.gz.
 282    To comply with the security policy you must ensure the path
 283    through which you get the file complies with the requirements
 284    for a "secure intallation" as described in section 6.6 in
 285    the [user guide] (https://openssl.org/docs/fips/UserGuide-2.0.pdf).
 286    For evaluation/experimentation you can simply download and verify
 287    `openssl-fips-x.x.x.tar.gz` from https://www.openssl.org/source/
 288 2. Extract source to `openssl-fips` folder and `cd openssl-fips`
 289 3. `./config`
 290 4. `make`
 291 5. `make install`
 292    (NOTE: to comply with the security policy you must use the exact
 293    commands in steps 3-5 without any additional options as per
 294    Appendix A in the [security policy]
 295    (http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf).
 296    The only exception is that `./config no-asm` can be
 297    used in place of `./config` )
 298 6. Get into Node.js checkout folder
 299 7. `./configure --openssl-fips=/path/to/openssl-fips/installdir`
 300    For example on ubuntu 12 the installation directory was
 301    /usr/local/ssl/fips-2.0
 302 8. Build Node.js with `make -j`
 303 9. Verify with `node -p "process.versions.openssl"` (`1.0.2a-fips`)
 304
 305 ## Resources for Newcomers
 306
 307 * [CONTRIBUTING.md](./CONTRIBUTING.md)
 308 * [GOVERNANCE.md](./GOVERNANCE.md)
 309 * IRC:
 310   [#io.js on Freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4)
 311 * [nodejs/node on Gitter](https://gitter.im/nodejs/node)
 312
 313 ## Security
 314
 315 All security bugs in node.js are taken seriously and should be reported by
 316 emailing security@nodejs.org. This will be delivered to a subset of the project
 317 team who handle security issues. Please don't disclose security bugs
 318 public until they have been handled by the security team.
 319
 320 Your email will be acknowledged within 24 hours, and you’ll receive a more
 321 detailed response to your email within 48 hours indicating the next steps in
 322 handling your report.
 323
 324 ## Current Project Team Members
 325
 326 The Node.js project team comprises a group of core collaborators and a sub-group
 327 that forms the _Technical Steering Committee_ (TSC) which governs the project. For more
 328 information about the governance of the Node.js project, see
 329 [GOVERNANCE.md](./GOVERNANCE.md).
 330
 331 =======
 332 ### TSC (Technical Steering Committee)
 333
 334 * **Ben Noordhuis** &lt;info@bnoordhuis.nl&gt; ([@bnoordhuis](https://github.com/bnoordhuis))
 335 * **Bert Belder** &lt;bertbelder@gmail.com&gt; ([@piscisaureus](https://github.com/piscisaureus))
 336 * **Fedor Indutny** &lt;fedor.indutny@gmail.com&gt; ([@indutny](https://github.com/indutny))
 337 * **Trevor Norris** &lt;trev.norris@gmail.com&gt; ([@trevnorris](https://github.com/trevnorris))
 338 * **Chris Dickinson** &lt;christopher.s.dickinson@gmail.com&gt; ([@chrisdickinson](https://github.com/chrisdickinson))
 339   - Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
 340 * **Rod Vagg** &lt;rod@vagg.org&gt; ([@rvagg](https://github.com/rvagg))
 341   - Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
 342 * **Jeremiah Senkpiel** &lt;fishrock123@rocketmail.com&gt; ([@fishrock123](https://github.com/fishrock123))
 343   - Release GPG key: FD3A5288F042B6850C66B31F09FE44734EB7990E
 344 * **Colin Ihrig** &lt;cjihrig@gmail.com&gt; ([@cjihrig](https://github.com/cjihrig))
 345   - Release GPG key: 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
 346 * **Alexis Campailla** &lt;orangemocha@nodejs.org&gt; ([@orangemocha](https://github.com/orangemocha))
 347 * **Julien Gilli** &lt;jgilli@nodejs.org&gt; ([@misterdjules](https://github.com/misterdjules))
 348 * **James M Snell** &lt;jasnell@gmail.com&gt; ([@jasnell](https://github.com/jasnell))
 349 * **Steven R Loomis** &lt;srloomis@us.ibm.com&gt; ([@srl295](https://github.com/srl295))
 350 * **Michael Dawson** &lt;michael_dawson@ca.ibm.com&gt; ([@mhdawson](https://github.com/mhdawson))
 351 * **Shigeki Ohtsu** &lt;ohtsu@iij.ad.jp&gt; ([@shigeki](https://github.com/shigeki))
 352 * **Brian White** &lt;mscdex@mscdex.net&gt; ([@mscdex](https://github.com/mscdex))
 353
 354 ### Collaborators
 355
 356 * **Isaac Z. Schlueter** &lt;i@izs.me&gt; ([@isaacs](https://github.com/isaacs))
 357 * **Mikeal Rogers** &lt;mikeal.rogers@gmail.com&gt; ([@mikeal](https://github.com/mikeal))
 358 * **Thorsten Lorenz** &lt;thlorenz@gmx.de&gt; ([@thlorenz](https://github.com/thlorenz))
 359 * **Stephen Belanger** &lt;admin@stephenbelanger.com&gt; ([@qard](https://github.com/qard))
 360 * **Evan Lucas** &lt;evanlucas@me.com&gt; ([@evanlucas](https://github.com/evanlucas))
 361 * **Brendan Ashworth** &lt;brendan.ashworth@me.com&gt; ([@brendanashworth](https://github.com/brendanashworth))
 362 * **Vladimir Kurchatkin** &lt;vladimir.kurchatkin@gmail.com&gt; ([@vkurchatkin](https://github.com/vkurchatkin))
 363 * **Nikolai Vavilov** &lt;vvnicholas@gmail.com&gt; ([@seishun](https://github.com/seishun))
 364 * **Nicu Micleușanu** &lt;micnic90@gmail.com&gt; ([@micnic](https://github.com/micnic))
 365 * **Aleksey Smolenchuk** &lt;lxe@lxe.co&gt; ([@lxe](https://github.com/lxe))
 366 * **Sam Roberts** &lt;vieuxtech@gmail.com&gt; ([@sam-github](https://github.com/sam-github))
 367 * **Wyatt Preul** &lt;wpreul@gmail.com&gt; ([@geek](https://github.com/geek))
 368 * **Christian Tellnes** &lt;christian@tellnes.no&gt; ([@tellnes](https://github.com/tellnes))
 369 * **Robert Kowalski** &lt;rok@kowalski.gd&gt; ([@robertkowalski](https://github.com/robertkowalski))
 370 * **Julian Duque** &lt;julianduquej@gmail.com&gt; ([@julianduque](https://github.com/julianduque))
 371 * **Johan Bergström** &lt;bugs@bergstroem.nu&gt; ([@jbergstroem](https://github.com/jbergstroem))
 372 * **Roman Reiss** &lt;me@silverwind.io&gt; ([@silverwind](https://github.com/silverwind))
 373 * **Petka Antonov** &lt;petka_antonov@hotmail.com&gt; ([@petkaantonov](https://github.com/petkaantonov))
 374 * **Yosuke Furukawa** &lt;yosuke.furukawa@gmail.com&gt; ([@yosuke-furukawa](https://github.com/yosuke-furukawa))
 375 * **Alex Kocharin** &lt;alex@kocharin.ru&gt; ([@rlidwka](https://github.com/rlidwka))
 376 * **Christopher Monsanto** &lt;chris@monsan.to&gt; ([@monsanto](https://github.com/monsanto))
 377 * **Ali Ijaz Sheikh** &lt;ofrobots@google.com&gt; ([@ofrobots](https://github.com/ofrobots))
 378 * **Oleg Elifantiev** &lt;oleg@elifantiev.ru&gt; ([@Olegas](https://github.com/Olegas))
 379 * **Domenic Denicola** &lt;d@domenic.me&gt; ([@domenic](https://github.com/domenic))
 380 * **Rich Trott** &lt;rtrott@gmail.com&gt; ([@Trott](https://github.com/Trott))
 381 * **Сковорода Никита Андреевич** &lt;chalkerx@gmail.com&gt; ([@ChALkeR](https://github.com/ChALkeR))
 382 * **Sakthipriyan Vairamani** &lt;thechargingvolcano@gmail.com&gt; ([@thefourtheye](https://github.com/thefourtheye))
 383 * **Michaël Zasso** &lt;mic.besace@gmail.com&gt; ([@targos](https://github.com/targos))
 384 * **João Reis** &lt;reis@janeasystems.com&gt; ([@joaocgreis](https://github.com/joaocgreis))
 385
 386 Collaborators & TSC members follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
 387 maintaining the Node.js project.