INSTALL.md

Installation instructions

Installation is done in a few simple steps and only takes a minute to get running.

For more general information look at the README file or in the official documentation.

Table of Contents

• Dependencies
• Installation methods
  1. Standard Installation
  • *NIX
  • Windows
  2. Containers and Virtual Machines
  • Vagrant
  • Docker
  • NW.js
  3. Single-board-computers
  • Raspberry PI
  • Arduino
  • Intel Edison
  4. Linux distribution
• Setting up optional features

Dependencies

You only need these packages installed:

• git
• node (debian users also need nodejs-legacy)
• npm

Installation

OS.js runs on all patforms and web-servers. Choose one of the methods described below, then proceed to the run section.

Standard Installation

You can also find documentation on this on the official homepage.

If you want to install on your computer or server directly:

*NIX

See install-nix.md.

Windows

See install-windows.md.

Containers and Virtual Machines

If you want to install on your computer, but in an isolated environment (container)

Vagrant

See Vagrant.md.

Docker

See Docker.md.

NW.js

See NW.md.

Single-board-computers

You can also install/deploy OS.js on these platforms, but has some spesific documentation:

Raspberry PI

See platform-raspi.md.

Arduino

See platform-arduino.md.

Intel Edison

See platform-edison.md.

Linux distribution

OS.js can run as a Linux distribution on top of X11. See X11.md for more information.

Setting up optional features

Visit the official documentation for more information.