nodejs/README.md

io.js


This repository began as a GitHub fork of joyent/node.

io.js contributions, releases, and contributorship are under an open governance model. We intend to land, with increasing regularity, releases which are compatible with the npm ecosystem that has been built to date for Node.js.

Is it io.js or IO.js or iojs or IOjs or iOjS?

The official name is io.js, which should never be capitalized, especially not at the start of a sentence, unless it is being displayed in a location that is customarily all-caps (such as the title of man pages).

Download

Binaries, installers, and source tarballs are available at https://iojs.org.

Releases are available at https://iojs.org/dist/, listed under their version string. The https://iojs.org/dist/latest/ symlink will point to the latest release directory.

Nightly builds are available at https://iojs.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://iojs.org/api/ points to the latest version.

Verifying Binaries

Release and nightly download directories all contain a SHASUM256.txt file that lists the SHA checksums for each file available for download. To check that a downloaded file matches the checksum, run it through sha256sum with a command such as:

$ grep iojs-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -

(Where "iojs-vx.y.z.tar.gz" is the name of the file you have downloaded)

Additionally, 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. Use a command such as this to import the keys:

$ gpg --keyserver pool.sks-keyservers.net \
  --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D

(Include each of the key fingerprints at the end of this command.)

You can then use gpg --verify SHASUMS256.txt.asc to verify that the file has been signed by an authorized member of the io.js team.

Once verified, use the SHASUMS256.txt.asc file to get the checksum for the binary verification command above.

Build

Unix / Macintosh

Prerequisites:

• gcc and g++ 4.8 or newer, or
• clang and clang++ 3.4 or newer
• Python 2.6 or 2.7
• GNU Make 3.81 or newer
• libexecinfo (FreeBSD and OpenBSD only)

$ ./configure
$ make
$ [sudo] make install

If your Python binary is in a non-standard location or has a non-standard name, run the following instead:

$ export PYTHON=/path/to/python
$ $PYTHON ./configure
$ make
$ [sudo] make install

To run the tests:

$ make test

To build the documentation:

$ make doc

To read the documentation:

$ man doc/iojs.1

To test if io.js was built correctly:

$ iojs -e "console.log('Hello from io.js ' + process.version)"

Windows

Prerequisites:

• Python 2.6 or 2.7
• Visual Studio 2013 for Windows Desktop, or
• Visual Studio Express 2013 for Windows Desktop
• Basic Unix tools required for some tests, Git for Windows includes Git Bash and tools which can be included in the global PATH.

> vcbuild nosign

To run the tests:

> vcbuild test

To test if io.js was built correctly:

$ iojs -e "console.log('Hello from io.js ' + process.version)"

Android / Android based devices, aka. Firefox OS

Be sure you have downloaded and extracted [Android NDK] (https://developer.android.com/tools/sdk/ndk/index.html) before in a folder. Then run:

$ ./android-configure /path/to/your/android-ndk
$ make

Intl (ECMA-402) support:

Intl support is not enabled by default.

"small" (English only) support

This option will build with "small" (English only) support, but the full Intl (ECMA-402) APIs. With --download=all it will download the ICU library as needed.

Unix / Macintosh:

$ ./configure --with-intl=small-icu --download=all

Windows:

> vcbuild small-icu download-all

The small-icu mode builds with English-only data. You can add full data at runtime.

Note: more docs are on the joyent/node wiki.

Build with full ICU support (all locales supported by ICU):

With the --download=all, this may download ICU if you don't have an ICU in deps/icu.

Unix / Macintosh:

$ ./configure --with-intl=full-icu --download=all

Windows:

> vcbuild full-icu download-all

Build with no Intl support :-(

The Intl object will not be available. This is the default at present, so this option is not normally needed.

Unix / Macintosh:

$ ./configure --with-intl=none

Windows:

> vcbuild intl-none

Use existing installed ICU (Unix / Macintosh only):

$ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu

Build with a specific ICU:

You can find other ICU releases at the ICU homepage. Download the file named something like icu4c-**##.#**-src.tgz (or .zip).

Unix / Macintosh

# from an already-unpacked ICU:
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu

# from a local ICU tarball
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz

# from a tarball URL
$ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz

Windows

First unpack latest ICU to deps/icu icu4c-##.#-src.tgz (or .zip) as deps/icu (You'll have: deps/icu/source/...)

> vcbuild full-icu

Building io.js with FIPS-compliant OpenSSL

NOTE: Windows is not yet supported

It is possible to build io.js with OpenSSL FIPS module.

Instructions:

1. Download and verify openssl-fips-x.x.x.tar.gz from https://www.openssl.org/source/
2. Extract source to openssl-fips folder
3. cd openssl-fips && ./config fipscanisterbuild --prefix=`pwd`/out (NOTE: On OS X, you may want to run ./Configure darwin64-x86_64-cc --prefix=`pwd`/out if you are going to build x64-mode io.js)
4. make -j && make install
5. Get into io.js checkout folder
6. ./configure --openssl-fips=/path/to/openssl-fips/out
7. Build io.js with make -j
8. Verify with node -p "process.versions.openssl" (1.0.2a-fips)

Resources for Newcomers

• CONTRIBUTING.md
• GOVERNANCE.md
• IRC: #io.js on Freenode.net
• iojs/io.js on Gitter

Security

All security bugs in io.js are taken seriously and should be reported by emailing security@iojs.org. This will be delivered to a subset of the project team who handle security issues. Please don't disclose security bugs public 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 io.js project team comprises a group of core collaborators and a sub-group that forms the Technical Steering Committee (TSC) which governs the project. For more information about the governance of the io.js project, see GOVERNANCE.md.

=======

TSC (Technical Steering Committee)

• Ben Noordhuis <info@bnoordhuis.nl> (@bnoordhuis)
• Bert Belder <bertbelder@gmail.com> (@piscisaureus)
• Fedor Indutny <fedor.indutny@gmail.com> (@indutny)
• Trevor Norris <trev.norris@gmail.com> (@trevnorris)
• Chris Dickinson <christopher.s.dickinson@gmail.com> (@chrisdickinson)
  • Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
• Rod Vagg <rod@vagg.org> (@rvagg)
  • Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
• Jeremiah Senkpiel <fishrock123@rocketmail.com> (@fishrock123)
  • Release GPG key: FD3A5288F042B6850C66B31F09FE44734EB7990E
• Colin Ihrig <cjihrig@gmail.com> (@cjihrig)
  • Release GPG key: 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
• Alexis Campailla <orangemocha@nodejs.org> (@orangemocha)
• Julien Gilli <jgilli@nodejs.org> (@misterdjules)
• James M Snell <jasnell@gmail.com> (@jasnell)
• Steven R Loomis <srloomis@us.ibm.com> (@srl295)
• Michael Dawson <michael_dawson@ca.ibm.com> (@mhdawson)
• Shigeki Ohtsu <ohtsu@iij.ad.jp> (@shigeki)
• Brian White <mscdex@mscdex.net> (@mscdex)

Collaborators

• Isaac Z. Schlueter <i@izs.me> (@isaacs)
• Mikeal Rogers <mikeal.rogers@gmail.com> (@mikeal)
• Thorsten Lorenz <thlorenz@gmx.de> (@thlorenz)
• Stephen Belanger <admin@stephenbelanger.com> (@qard)
• Evan Lucas <evanlucas@me.com> (@evanlucas)
• Brendan Ashworth <brendan.ashworth@me.com> (@brendanashworth)
• Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com> (@vkurchatkin)
• Nikolai Vavilov <vvnicholas@gmail.com> (@seishun)
• Nicu Micleușanu <micnic90@gmail.com> (@micnic)
• Aleksey Smolenchuk <lxe@lxe.co> (@lxe)
• Sam Roberts <vieuxtech@gmail.com> (@sam-github)
• Wyatt Preul <wpreul@gmail.com> (@geek)
• Christian Tellnes <christian@tellnes.no> (@tellnes)
• Robert Kowalski <rok@kowalski.gd> (@robertkowalski)
• Julian Duque <julianduquej@gmail.com> (@julianduque)
• Johan Bergström <bugs@bergstroem.nu> (@jbergstroem)
• Roman Reiss <me@silverwind.io> (@silverwind)
• Petka Antonov <petka_antonov@hotmail.com> (@petkaantonov)
• Yosuke Furukawa <yosuke.furukawa@gmail.com> (@yosuke-furukawa)
• Alex Kocharin <alex@kocharin.ru> (@rlidwka)
• Christopher Monsanto <chris@monsan.to> (@monsanto)
• Ali Ijaz Sheikh <ofrobots@google.com> (@ofrobots)
• Oleg Elifantiev <oleg@elifantiev.ru> (@Olegas)
• Domenic Denicola <d@domenic.me> (@domenic)
• Rich Trott <rtrott@gmail.com> (@Trott)
• Сковорода Никита Андреевич <chalkerx@gmail.com> (@ChALkeR)
• Sakthipriyan Vairamani <thechargingvolcano@gmail.com> (@thefourtheye)
• Michaël Zasso <mic.besace@gmail.com> (@targos)
• João Reis <reis@janeasystems.com> (@joaocgreis)

Collaborators & TSC members follow the COLLABORATOR_GUIDE.md in maintaining the io.js project.