|
| 1 | +# iojs |
| 2 | + |
| 3 | +[](https://registry.hub.docker.com/_/iojs/) |
| 4 | + |
| 5 | +[](https://github.com/iojs/docker-iojs) |
| 6 | +[](https://github.com/iojs/docker-iojs) |
| 7 | + |
| 8 | +The official iojs docker image, made with love by the iojs community. |
| 9 | + |
| 10 | +## What is iojs? |
| 11 | + |
| 12 | +*from [iojs.org/faq.html](https://iojs.org/faq.html)* |
| 13 | + |
| 14 | +io.js is a JavaScript platform built on Chrome's V8 runtime. This project began |
| 15 | +as a fork of Joyent's Node.js™ and is compatible with the npm ecosystem. |
| 16 | + |
| 17 | +Why? io.js aims to provide faster and predictable release cycles. It currently |
| 18 | +merges in the latest language, API and performance improvements to V8 while also |
| 19 | +updating libuv and other base libraries. |
| 20 | + |
| 21 | +This project aims to continue development of io.js under an "open governance |
| 22 | +model" as opposed to corporate stewardship. |
| 23 | + |
| 24 | +## Usage |
| 25 | + |
| 26 | +# How to use this image |
| 27 | + |
| 28 | +If you want to distribute your application on the docker registry, create a |
| 29 | +`Dockerfile` in the root of application directory: |
| 30 | + |
| 31 | +```Dockerfile |
| 32 | +FROM iojs:onbuild |
| 33 | + |
| 34 | +# Expose the ports that your app uses. For example: |
| 35 | +EXPOSE 8080 |
| 36 | +``` |
| 37 | + |
| 38 | +Then simply run: |
| 39 | + |
| 40 | +``` |
| 41 | +$ docker build -t iojs-app |
| 42 | +... |
| 43 | +$ docker run --rm -it iojs-app |
| 44 | +``` |
| 45 | + |
| 46 | +To run a single script, you can mount it in a volume under `/usr/src/app`. From |
| 47 | +the root of your application directory (assuming your script is named |
| 48 | +`index.js`): |
| 49 | + |
| 50 | +``` |
| 51 | +$ docker run -v ${PWD}:/usr/src/app -w /usr/src/app -it --rm iojs iojs index.js |
| 52 | +``` |
| 53 | + |
| 54 | +# Image Variants |
| 55 | + |
| 56 | +The `iojs` images come in many flavors, each designed for a specific use case. |
| 57 | + |
| 58 | +## `iojs:<version>` |
| 59 | + |
| 60 | +This is the defacto image. If you are unsure about what your needs are, you |
| 61 | +probably want to use this one. It is designed to be used both as a throw away |
| 62 | +container (mount your source code and start the container to start your app), |
| 63 | +as well as the base to build other images off of. This tag is based off of |
| 64 | +[`buildpack-deps`](https://registry.hub.docker.com/_/buildpack-deps/). |
| 65 | +`buildpack-deps` is designed for the average user of docker who has many images |
| 66 | +on their system. It, by design, has a large number of extremely common Debian |
| 67 | +packages. This reduces the number of packages that images that derive from it |
| 68 | +need to install, thus reducing the overall size of all images on your system. |
| 69 | + |
| 70 | +## `iojs:onbuild` |
| 71 | + |
| 72 | +This image makes building derivative images easier. For most use cases, |
| 73 | +creating a `Dockerfile` in the base of your project directory with the line |
| 74 | +`FROM iojs:onbuild` will be enough to create a stand-alone image for your |
| 75 | +project. |
| 76 | + |
| 77 | +## `iojs:slim` |
| 78 | + |
| 79 | +This image does not contain the common packages contained in the default tag |
| 80 | +and only contains the minimal packages needed to run `iojs`. Unless you are |
| 81 | +working in an environment where *only* the iojs image will be deployed and you |
| 82 | +have space constraints, we highly recommend using the default image of this |
| 83 | +repository. |
| 84 | + |
| 85 | +# License |
| 86 | + |
| 87 | +[License information](https://github.com/iojs/io.js/blob/master/LICENSE) for |
| 88 | +the software contained in this image. [License |
| 89 | +information](https://github.com/iojs/docker-iojs/blob/master/LICENSE) for the |
| 90 | +io.js Docker project. |
| 91 | + |
| 92 | +# Supported Docker versions |
| 93 | + |
| 94 | +This image is officially supported on Docker version 1.5.0. |
| 95 | + |
| 96 | +Support for older versions (down to 1.0) is provided on a best-effort basis. |
| 97 | + |
| 98 | +# People |
| 99 | + |
| 100 | +Current Project Team Members: |
| 101 | + |
| 102 | + * [@hmalphettes](https://www.github.com/hmalphettes) |
| 103 | + * [@jlmitch5](https://www.github.com/jlmitch5) |
| 104 | + * [@pesho](https://www.github.com/pesho) |
| 105 | + * [@Starefossen](https://www.github.com/starefossen) |
| 106 | + * [@wblankenship](https://www.github.com/wblankenship) |
0 commit comments