README.md

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