mirror of
https://github.com/nodejs/node.git
synced 2024-11-30 07:27:22 +01:00
8c48a26459
PR-URL: https://github.com/nodejs/node/pull/6227 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
256 lines
14 KiB
Markdown
256 lines
14 KiB
Markdown
Node.js
|
||
=======
|
||
|
||
[](https://gitter.im/nodejs/node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
|
||
Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js
|
||
uses an event-driven, non-blocking I/O model that makes it lightweight and
|
||
efficient. The Node.js package ecosystem, npm, is the largest ecosystem of open
|
||
source libraries in the world.
|
||
|
||
The Node.js project is supported by the
|
||
[Node.js Foundation](https://nodejs.org/en/foundation/). Contributions,
|
||
policies and releases are managed under an
|
||
[open governance model](./GOVERNANCE.md). We are also bound by a
|
||
[Code of Conduct](./CODE_OF_CONDUCT.md).
|
||
|
||
If you need help using or installing Node.js, please use the
|
||
[nodejs/help](https://github.com/nodejs/help) issue tracker.
|
||
|
||
## Release Types
|
||
|
||
The Node.js project maintains multiple types of releases:
|
||
|
||
* **Stable**: Released from active development branches of this repository,
|
||
versioned by [SemVer](http://semver.org/) and signed by a member of the
|
||
[Release Team](#release-team).
|
||
Code for Stable releases is organized in this repository by major version
|
||
number, For example: [v4.x](https://github.com/nodejs/node/tree/v4.x).
|
||
The major version number of Stable releases will increment every 6 months
|
||
allowing for breaking changes to be introduced. This happens in April and
|
||
October every year. Stable release lines beginning in October each year have
|
||
a maximum support life of 8 months. Stable release lines beginning in April
|
||
each year will convert to LTS (see below) after 6 months and receive further
|
||
support for 30 months.
|
||
* **LTS**: Releases that receive Long-term Support, with a focus on stability
|
||
and security. Every second Stable release line (major version) will become an
|
||
LTS line and receive 18 months of _Active LTS_ support and a further 12
|
||
months of _Maintenance_. LTS release lines are given alphabetically
|
||
ordered codenames, beginning with v4 Argon. LTS releases are less frequent
|
||
and will attempt to maintain consistent major and minor version numbers,
|
||
only incrementing patch version numbers. There are no breaking changes or
|
||
feature additions, except in some special circumstances. More information
|
||
can be found in the [LTS README](https://github.com/nodejs/LTS/).
|
||
* **Nightly**: Versions of code in this repository on the current Stable
|
||
branch, automatically built every 24-hours where changes exist. Use with
|
||
caution.
|
||
|
||
## Download
|
||
|
||
Binaries, installers, and source tarballs are available at
|
||
<https://nodejs.org>.
|
||
|
||
**Stable** and **LTS** releases are available at
|
||
<https://nodejs.org/download/release/>, listed under their version strings.
|
||
The [latest](https://nodejs.org/download/release/latest/) directory is an
|
||
alias for the latest Stable release. The latest LTS release from an LTS
|
||
line is available in the form: latest-_codename_. For example:
|
||
<https://nodejs.org/download/release/latest-argon>
|
||
|
||
**Nightly** builds are available at
|
||
<https://nodejs.org/download/nightly/>, listed under their version
|
||
string which includes their date (in UTC time) and the commit SHA at
|
||
the HEAD of the release.
|
||
|
||
**API documentation** is available in each release and nightly
|
||
directory under _docs_. <https://nodejs.org/api/> points to the API
|
||
documentation of the latest stable version.
|
||
|
||
### Verifying Binaries
|
||
|
||
Stable, LTS and Nightly download directories all contain a *SHASUM256.txt*
|
||
file that lists the SHA checksums for each file available for
|
||
download.
|
||
|
||
The *SHASUM256.txt* can be downloaded using curl.
|
||
|
||
```
|
||
$ curl -O https://nodejs.org/dist/vx.y.z/SHASUMS256.txt
|
||
```
|
||
|
||
To check that a downloaded file matches the checksum, run
|
||
it through `sha256sum` with a command such as:
|
||
|
||
```
|
||
$ grep node-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
|
||
```
|
||
|
||
_(Where "node-vx.y.z.tar.gz" is the name of the file you have
|
||
downloaded)_
|
||
|
||
Additionally, Stable and LTS releases (not Nightlies) have GPG signed
|
||
copies of SHASUM256.txt files available as SHASUM256.txt.asc. You can use
|
||
`gpg` to verify that the file has not been tampered with.
|
||
|
||
To verify a SHASUM256.txt.asc, you will first need to import all of
|
||
the GPG keys of individuals authorized to create releases. They are
|
||
listed at the bottom of this README under [Release Team](#release-team).
|
||
Use a command such as this to import the keys:
|
||
|
||
```
|
||
$ gpg --keyserver pool.sks-keyservers.net \
|
||
--recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
|
||
```
|
||
|
||
_(See the bottom of this README for a full script to import active
|
||
release keys)_
|
||
|
||
You can then use `gpg --verify SHASUMS256.txt.asc` to verify that the
|
||
file has been signed by an authorized member of the Node.js team.
|
||
|
||
Once verified, use the SHASUMS256.txt.asc file to get the checksum for
|
||
the binary verification command above.
|
||
|
||
## Building Node.js
|
||
|
||
See [BUILDING.md](BUILDING.md) for instructions on how to build
|
||
Node.js from source.
|
||
|
||
|
||
## Resources for Newcomers
|
||
|
||
* [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
|
||
* [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||
* [GOVERNANCE.md](./GOVERNANCE.md)
|
||
* IRC (general questions): [#node.js on Freenode.net](https://webchat.freenode.net?channels=node.js&uio=d4)
|
||
* IRC (node core development): [#node-dev on Freenode.net](https://webchat.freenode.net?channels=node-dev&uio=d4)
|
||
* [nodejs/node on Gitter](https://gitter.im/nodejs/node)
|
||
|
||
## Security
|
||
|
||
All security bugs in Node.js are taken seriously and should be reported by
|
||
emailing security@nodejs.org. This will be delivered to a subset of the project
|
||
team who handle security issues. Please don't disclose security bugs
|
||
publicly until they have been handled by the security team.
|
||
|
||
Your email will be acknowledged within 24 hours, and you’ll receive a more
|
||
detailed response to your email within 48 hours indicating the next steps in
|
||
handling your report.
|
||
|
||
## Current Project Team Members
|
||
|
||
The Node.js project team comprises a group of core collaborators and a sub-group
|
||
that forms the _Core Technical Committee_ (CTC) which governs the project. For more
|
||
information about the governance of the Node.js project, see
|
||
[GOVERNANCE.md](./GOVERNANCE.md).
|
||
|
||
### CTC (Core Technical Committee)
|
||
|
||
* [bnoordhuis](https://github.com/bnoordhuis) - **Ben Noordhuis** <info@bnoordhuis.nl>
|
||
* [ChALkeR](https://github.com/ChALkeR) - **Сковорода Никита Андреевич** <chalkerx@gmail.com>
|
||
* [chrisdickinson](https://github.com/chrisdickinson) - **Chris Dickinson** <christopher.s.dickinson@gmail.com>
|
||
* [cjihrig](https://github.com/cjihrig) - **Colin Ihrig** <cjihrig@gmail.com>
|
||
* [evanlucas](https://github.com/evanlucas) - **Evan Lucas** <evanlucas@me.com>
|
||
* [fishrock123](https://github.com/fishrock123) - **Jeremiah Senkpiel** <fishrock123@rocketmail.com>
|
||
* [indutny](https://github.com/indutny) - **Fedor Indutny** <fedor.indutny@gmail.com>
|
||
* [jasnell](https://github.com/jasnell) - **James M Snell** <jasnell@gmail.com>
|
||
* [mhdawson](https://github.com/mhdawson) - **Michael Dawson** <michael_dawson@ca.ibm.com>
|
||
* [misterdjules](https://github.com/misterdjules) - **Julien Gilli** <jgilli@nodejs.org>
|
||
* [mscdex](https://github.com/mscdex) - **Brian White** <mscdex@mscdex.net>
|
||
* [ofrobots](https://github.com/ofrobots) - **Ali Ijaz Sheikh** <ofrobots@google.com>
|
||
* [orangemocha](https://github.com/orangemocha) - **Alexis Campailla** <orangemocha@nodejs.org>
|
||
* [piscisaureus](https://github.com/piscisaureus) - **Bert Belder** <bertbelder@gmail.com>
|
||
* [rvagg](https://github.com/rvagg) - **Rod Vagg** <rod@vagg.org>
|
||
* [shigeki](https://github.com/shigeki) - **Shigeki Ohtsu** <ohtsu@iij.ad.jp>
|
||
* [trevnorris](https://github.com/trevnorris) - **Trevor Norris** <trev.norris@gmail.com>
|
||
* [Trott](https://github.com/Trott) - **Rich Trott** <rtrott@gmail.com>
|
||
|
||
### Collaborators
|
||
|
||
* [addaleax](https://github.com/addaleax) - **Anna Henningsen** <anna@addaleax.net>
|
||
* [AndreasMadsen](https://github.com/AndreasMadsen) - **Andreas Madsen** <amwebdk@gmail.com>
|
||
* [benjamingr](https://github.com/benjamingr) - **Benjamin Gruenbaum** <benjamingr@gmail.com>
|
||
* [brendanashworth](https://github.com/brendanashworth) - **Brendan Ashworth** <brendan.ashworth@me.com>
|
||
* [calvinmetcalf](https://github.com/calvinmetcalf) - **Calvin Metcalf** <calvin.metcalf@gmail.com>
|
||
* [claudiorodriguez](https://github.com/claudiorodriguez) - **Claudio Rodriguez** <cjrodr@yahoo.com>
|
||
* [domenic](https://github.com/domenic) - **Domenic Denicola** <d@domenic.me>
|
||
* [geek](https://github.com/geek) - **Wyatt Preul** <wpreul@gmail.com>
|
||
* [iarna](https://github.com/iarna) - **Rebecca Turner** <me@re-becca.org>
|
||
* [isaacs](https://github.com/isaacs) - **Isaac Z. Schlueter** <i@izs.me>
|
||
* [iWuzHere](https://github.com/iWuzHere) - **Imran Iqbal** <imran@imraniqbal.org>
|
||
* [jbergstroem](https://github.com/jbergstroem) - **Johan Bergström** <bugs@bergstroem.nu>
|
||
* [joaocgreis](https://github.com/joaocgreis) - **João Reis** <reis@janeasystems.com>
|
||
* [julianduque](https://github.com/julianduque) - **Julian Duque** <julianduquej@gmail.com>
|
||
* [JungMinu](https://github.com/JungMinu) - **Minwoo Jung** <jmwsoft@gmail.com>
|
||
* [lxe](https://github.com/lxe) - **Aleksey Smolenchuk** <lxe@lxe.co>
|
||
* [matthewloring](https://github.com/matthewloring) - **Matthew Loring** <mattloring@google.com>
|
||
* [mcollina](https://github.com/mcollina) - **Matteo Collina** <matteo.collina@gmail.com>
|
||
* [micnic](https://github.com/micnic) - **Nicu Micleușanu** <micnic90@gmail.com>
|
||
* [mikeal](https://github.com/mikeal) - **Mikeal Rogers** <mikeal.rogers@gmail.com>
|
||
* [monsanto](https://github.com/monsanto) - **Christopher Monsanto** <chris@monsan.to>
|
||
* [Olegas](https://github.com/Olegas) - **Oleg Elifantiev** <oleg@elifantiev.ru>
|
||
* [petkaantonov](https://github.com/petkaantonov) - **Petka Antonov** <petka_antonov@hotmail.com>
|
||
* [phillipj](https://github.com/phillipj) - **Phillip Johnsen** <johphi@gmail.com>
|
||
* [qard](https://github.com/qard) - **Stephen Belanger** <admin@stephenbelanger.com>
|
||
* [rlidwka](https://github.com/rlidwka) - **Alex Kocharin** <alex@kocharin.ru>
|
||
* [rmg](https://github.com/rmg) - **Ryan Graham** <r.m.graham@gmail.com>
|
||
* [robertkowalski](https://github.com/robertkowalski) - **Robert Kowalski** <rok@kowalski.gd>
|
||
* [romankl](https://github.com/romankl) - **Roman Klauke** <romaaan.git@gmail.com>
|
||
* [saghul](https://github.com/saghul) - **Saúl Ibarra Corretgé** <saghul@gmail.com>
|
||
* [sam-github](https://github.com/sam-github) - **Sam Roberts** <vieuxtech@gmail.com>
|
||
* [santigimeno](https://github.com/santigimeno) - **Santiago Gimeno** <santiago.gimeno@gmail.com>
|
||
* [seishun](https://github.com/seishun) - **Nikolai Vavilov** <vvnicholas@gmail.com>
|
||
* [silverwind](https://github.com/silverwind) - **Roman Reiss** <me@silverwind.io>
|
||
* [srl295](https://github.com/srl295) - **Steven R Loomis** <srloomis@us.ibm.com>
|
||
* [stefanmb](https://github.com/stefanmb) - **Stefan Budeanu** <stefan@budeanu.com>
|
||
* [targos](https://github.com/targos) - **Michaël Zasso** <mic.besace@gmail.com>
|
||
* [tellnes](https://github.com/tellnes) - **Christian Tellnes** <christian@tellnes.no>
|
||
* [thealphanerd](https://github.com/thealphanerd) - **Myles Borins** <myles.borins@gmail.com>
|
||
* [thefourtheye](https://github.com/thefourtheye) - **Sakthipriyan Vairamani** <thechargingvolcano@gmail.com>
|
||
* [thekemkid](https://github.com/thekemkid) - **Glen Keane** <glenkeane.94@gmail.com>
|
||
* [thlorenz](https://github.com/thlorenz) - **Thorsten Lorenz** <thlorenz@gmx.de>
|
||
* [tunniclm](https://github.com/tunniclm) - **Mike Tunnicliffe** <m.j.tunnicliffe@gmail.com>
|
||
* [vkurchatkin](https://github.com/vkurchatkin) - **Vladimir Kurchatkin** <vladimir.kurchatkin@gmail.com>
|
||
* [whitlockjc](https://github.com/whitlockjc) - **Jeremy Whitlock** <jwhitlock@apache.org>
|
||
* [yosuke-furukawa](https://github.com/yosuke-furukawa) - **Yosuke Furukawa** <yosuke.furukawa@gmail.com>
|
||
* [zkat](https://github.com/zkat) - **Kat Marchán** <kzm@sykosomatic.org>
|
||
|
||
Collaborators & CTC members follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
|
||
maintaining the Node.js project.
|
||
|
||
### Release Team
|
||
|
||
Releases of Node.js and io.js will be signed with one of the following GPG keys:
|
||
|
||
* **Chris Dickinson** <christopher.s.dickinson@gmail.com> `9554F04D7259F04124DE6B476D5A82AC7E37093B`
|
||
* **Colin Ihrig** <cjihrig@gmail.com> `94AE36675C464D64BAFA68DD7434390BDBE9B9C5`
|
||
* **Evan Lucas** <evanlucas@me.com> `B9AE9905FFD7803F25714661B63B535A4C206CA9`
|
||
* **James M Snell** <jasnell@keybase.io> `71DCFD284A79C3B38668286BC97EC7A07EDE3FC1`
|
||
* **Jeremiah Senkpiel** <fishrock@keybase.io> `FD3A5288F042B6850C66B31F09FE44734EB7990E`
|
||
* **Myles Borins** <myles.borins@gmail.com> `C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8`
|
||
* **Rod Vagg** <rod@vagg.org> `DD8F2338BAE7501E3DD5AC78C273792F7D83545D`
|
||
* **Sam Roberts** <octetcloud@keybase.io> `0034A06D9D9B0064CE8ADF6BF1747F4AD2306D93`
|
||
|
||
The full set of trusted release keys can be imported by running:
|
||
|
||
```
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys 9554F04D7259F04124DE6B476D5A82AC7E37093B
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys 0034A06D9D9B0064CE8ADF6BF1747F4AD2306D93
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys FD3A5288F042B6850C66B31F09FE44734EB7990E
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys 71DCFD284A79C3B38668286BC97EC7A07EDE3FC1
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8
|
||
gpg --keyserver pool.sks-keyservers.net --recv-keys B9AE9905FFD7803F25714661B63B535A4C206CA9
|
||
```
|
||
|
||
See the section above on [Verifying Binaries](#verifying-binaries) for
|
||
details on what to do with these keys to verify that a downloaded file is official.
|
||
|
||
Previous releases of Node.js have been signed with one of the following GPG
|
||
keys:
|
||
|
||
* **Isaac Z. Schlueter** <i@izs.me> `93C7E9E91B49E432C2F75674B0A78B0A6C481CF6`
|
||
* **Julien Gilli** <jgilli@fastmail.fm> `114F43EE0176B71C7BC219DD50A3051F888C628D`
|
||
* **Timothy J Fontaine** <tjfontaine@gmail.com> `7937DFD2AB06298B2293C3187D33FF9D0246406D`
|