smallsolar
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Node.js JavaScript runtime ✨🐢🚀✨
35,344 Commits 52 Branches 855 Tags 2.6 GiB
JavaScript 61.7%
C++ 22.7%
Python 10.9%
C 3%
HTML 0.7%
Other 0.9%
Go to file
Tobias Nießen b2edcfee46 doc: remove statement about client private keys 
This statement was objectively false. Clients usually only need to
generate and/or own a private key if the server sends a
CertificateRequest during the TLS handshake, which is not a common case.

PR-URL: https://github.com/nodejs/node/pull/41505
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
 		2022-01-16 03:57:40 +01:00
.github build: fix workflow access to git history 2022-01-13 15:08:44 +00:00
benchmark benchmark: simplify http benchmarker regular expression 2022-01-11 22:57:30 -08:00
deps deps: upgrade npm to 8.3.1 2022-01-14 17:42:48 +00:00
doc doc: remove statement about client private keys 2022-01-16 03:57:40 +01:00
lib tls: move tls.parseCertString to end-of-life 2022-01-15 17:00:25 +01:00
src src: use `std::optional` for Worker thread id 2022-01-14 17:56:15 +01:00
test tls: move tls.parseCertString to end-of-life 2022-01-15 17:00:25 +01:00
tools tools: fix small not-quite-a-bug in find-inactive-tsc.mjs 2022-01-14 06:22:42 +00:00
typings typings: add types for symbol and accessor properties on `primordials` 2021-12-31 00:47:04 +01:00
.clang-format tools: add `make format-cpp` to run clang-format on C++ diffs 2018-08-03 19:40:23 +08:00
.cpplint tools: move cpplint configuration to .cpplint 2019-04-08 08:30:29 -04:00
.editorconfig tools: enforce use of single quotes in editorconfig 2020-11-12 06:19:49 +00:00
.eslintignore tools: re-implement lint-md without unified-args 2021-09-25 03:51:52 +00:00
.eslintrc.js tools: enable ESLint recommended configuration 2022-01-13 17:12:11 -08:00
.flake8 tools: python: ignore instead of select flake8 rules 2019-04-13 20:33:06 -04:00
.gitattributes build,win: fix Python detection on localized OS 2019-09-05 19:14:29 -07:00
.gitignore build: add OpenSSL gyp artifacts to .gitignore 2021-11-27 15:07:12 +00:00
.mailmap doc: update mailmap entries for mhdawson 2022-01-11 00:47:10 -08:00
.nycrc test: add windows and C++ coverage 2020-10-21 19:41:08 -07:00
.yamllint.yaml tools: extend default yamllint config 2021-09-21 17:03:51 +00:00
AUTHORS meta: update AUTHORS 2022-01-11 15:13:18 +00:00
BSDmakefile build: replace which with command -v 2020-11-19 19:33:28 +01:00
BUILDING.md doc: document support building with Python 3.10 on Windows 2021-12-10 11:21:37 +01:00
CHANGELOG.md 2022-01-10, Version 17.3.1 (Current) 2022-01-10 23:49:27 +00:00
CODE_OF_CONDUCT.md tools: avoid unnecessary escaping in markdown formatter 2021-10-31 09:36:05 -07:00
CONTRIBUTING.md tools: avoid unnecessary escaping in markdown formatter 2021-10-31 09:36:05 -07:00
GOVERNANCE.md meta: move to emeritus automatically after 18 months 2021-12-15 21:38:34 +00:00
LICENSE tools: remove Babel from license-builder.sh 2021-12-03 14:56:52 +00:00
Makefile build: start build on z/OS 2022-01-06 15:54:32 +00:00
README.md doc: add Mesteery to collaborators 2022-01-15 18:50:48 +01:00
SECURITY.md meta: increase security policy response targets 2021-11-27 20:20:36 -08:00
android-configure build: replace non-POSIX test -a|o 2021-05-21 15:47:16 -07:00
codecov.yml build: turn off Codecov comments 2020-10-26 03:56:13 -07:00
common.gypi deps: V8: cherry-pick 3b6b21f595f6 2022-01-14 16:41:42 +00:00
configure build: support Python 3.10.0 2021-10-06 17:07:07 -07:00
configure.py build: fix node build failures in WSL Ubuntu 2022-01-14 18:08:58 -05:00
glossary.md doc: use `HEAD` instead of `master` for links 2021-05-05 10:45:30 +02:00
node.gyp src: prevent extra copies of `TimerWrap::TimerCb` 2021-11-12 21:47:42 +00:00
node.gypi deps,test,src,doc,tools: update to OpenSSL 3.0 2021-10-11 06:28:08 +02:00
onboarding.md doc: fix typo in `onboarding.md` 2022-01-15 23:03:44 +00:00
tsconfig.json typings: add more bindings typings 2021-10-31 13:41:45 +01:00
vcbuild.bat tools: use jsdoc recommended rules 2021-12-04 19:04:05 -08:00

README.md

Node.js

Node.js is an open-source, cross-platform, JavaScript runtime environment.

For information on using Node.js, see the Node.js Website.

The Node.js project uses an open governance model. The OpenJS Foundation provides support for the project.

This project has a Code of Conduct.

Table of contents

Support

Looking for help? Check out the instructions for getting support.

Release types

  • Current: Under active development. Code for the Current release is in the branch for its major version number (for example, v15.x). Node.js releases a new major version every 6 months, allowing for breaking changes. This happens in April and October every year. Releases appearing each October have a support life of 8 months. Releases appearing each April convert to LTS (see below) each October.
  • LTS: Releases that receive Long Term Support, with a focus on stability and security. Every even-numbered major version will become an LTS release. LTS releases receive 12 months of Active LTS support and a further 18 months of Maintenance. LTS release lines have alphabetically-ordered code names, beginning with v4 Argon. There are no breaking changes or feature additions, except in some special circumstances.
  • Nightly: Code from the Current branch built every 24-hours when there are changes. Use with caution.

Current and LTS releases follow Semantic Versioning. A member of the Release Team signs each Current and LTS release. For more information, see the Release README.

Download

Binaries, installers, and source tarballs are available at https://nodejs.org/en/download/.

Current and LTS releases

https://nodejs.org/download/release/

The latest directory is an alias for the latest Current release. The latest-codename directory is an alias for the latest release from an LTS line. For example, the latest-fermium directory contains the latest Fermium (Node.js 14) release.

Nightly releases

https://nodejs.org/download/nightly/

Each directory name and filename contains a date (in UTC) and the commit SHA at the HEAD of the release.

API documentation

Documentation for the latest Current release is at https://nodejs.org/api/. Version-specific documentation is available in each release directory in the docs subdirectory. Version-specific documentation is also at https://nodejs.org/download/docs/.

Verifying binaries

Download directories contain a SHASUMS256.txt file with SHA checksums for the files.

To download SHASUMS256.txt 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 -

For Current and LTS, the GPG detached signature of SHASUMS256.txt is in SHASUMS256.txt.sig. You can use it with gpg to verify the integrity of SHASUMS256.txt. You will first need to import the GPG keys of individuals authorized to create releases. 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.

Next, download the SHASUMS256.txt.sig for the release:

$ curl -O https://nodejs.org/dist/vx.y.z/SHASUMS256.txt.sig

Then use gpg --verify SHASUMS256.txt.sig SHASUMS256.txt to verify the file's signature.

Building Node.js

See BUILDING.md for instructions on how to build Node.js from source and a list of supported platforms.

Security

For information on reporting security vulnerabilities in Node.js, see SECURITY.md.

Contributing to Node.js

Current project team members

For information about the governance of the Node.js project, see GOVERNANCE.md.

TSC (Technical Steering Committee)

Emeriti

TSC emeriti

Collaborators

Emeriti

Collaborator emeriti

Collaborators follow the Collaborator Guide in maintaining the Node.js project.

Triagers

Release keys

Primary GPG keys for Node.js Releasers (some Releasers sign with subkeys):

To import the full set of trusted release keys (including subkeys possibly used to sign releases):

gpg --keyserver pool.sks-keyservers.net --recv-keys 4ED778F539E3634C779C87C6D7062848A1AB005C
gpg --keyserver pool.sks-keyservers.net --recv-keys 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
gpg --keyserver pool.sks-keyservers.net --recv-keys 74F12602B6F1C4E913FAA37AD3A89613643B6201
gpg --keyserver pool.sks-keyservers.net --recv-keys 71DCFD284A79C3B38668286BC97EC7A07EDE3FC1
gpg --keyserver pool.sks-keyservers.net --recv-keys 8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600
gpg --keyserver pool.sks-keyservers.net --recv-keys C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8
gpg --keyserver pool.sks-keyservers.net --recv-keys C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C
gpg --keyserver pool.sks-keyservers.net --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
gpg --keyserver pool.sks-keyservers.net --recv-keys A48C2BEE680E841632CD4E44F07496B3EB3C1762
gpg --keyserver pool.sks-keyservers.net --recv-keys 108F52B48DB57BB0CC439B2997B01419BD92F80A
gpg --keyserver pool.sks-keyservers.net --recv-keys B9E2F5981AA6E0CD28160D9FF13993A75599653C

See the section above on Verifying Binaries for how to use these keys to verify a downloaded file.

Other keys used to sign some previous releases

License

Node.js is available under the MIT license. Node.js also includes external libraries that are available under a variety of licenses. See LICENSE for the full license text.