node package manager

orion

Orion

A minimal, single-user deployment of Eclipse Orion. Orion provides an extensible IDE that runs in your browser. It's particularly good for writing Javascript.

Features

  • Basic file management
  • Source code editing
  • Install plugins to customize your environment
  • User preferences
  • Git support based on nodegit
  • Multi-user support (optional, requires MongoDB)

Usage

For full instructions, see the Getting Started guide.

Installation

  • To install the built server run npm install orion.
  • Alternatively, you can install from source by checking out the repo from GitHub and then running cd modules/orionode && npm install.
  • Orion has an optional dependency on the node-pty package, which is not installed by default. You can install this package with npm install node-pty. If this package is not installed then an error message will be displayed when the server is run, but will still run fine.

Nodegit Installation

During the installation from NPM, Nodegit will try to find binaries for your installed version of Node.js / operating system. If it has them, they will be downloaded and the installation will complete normally. If however, it does not have a pre-built version ready to go, Nodegit will start up its builder to try and create the binaries it requires. Depending on your operating system and build-time tools you have installed, this will complete normally and everything will work fine. If you are missing build tools that it needs to build its binaries, the install will fail.

If your build / install does fail, please read Nodegits' build page to make sure you have all the expected tools installed and try running npm install orion again.

Running the server

  1. Browse to the directory where you installed Orion, usually node_modules/orion/.
  2. Edit the orion.conf file. Uncomment the following line, replacing the password with something of your choice:
pwd=[secretpassword]

This prevents unauthorized access to your Orion server.

  1. Run npm start orion or node [node_modules]/orion/server.js.
  2. Go to http://localhost:8081 to use Orion. You will be prompted with a basic auth dialog; enter the password you chose earlier (leave the user name blank).

The port number can be changed by passing the --port argument or setting the PORT environment variable.

Global installation

If you installed Orion as a global package with npm install -g orion, you can run the command orion from any directory (rather than npm start orion as outlined above.) Orion will then start using your current directory (or a directory you specify on the command line) as the location. See the Getting Started guide for more details.

Multi-user server

By default the server runs in single-user mode. Set orion.single.user=false in the orion.conf file to enable multiple users. This requires a MongoDB installation.

Known Git issues

  • Cloning repos using the SSH protocol (ssh://) will not work out of the box due to a Nodegit issue. You can work around this by editing vendor/libgit2.gyp, obtaining a newer version of OpenSSL, and then rebuilding Nodegit from source.

Using Orion within a larger app

Use require('orion') to get access to our startServer function, which is suitable for use within a larger Express project:

var orion = require('orion');
var express = require('express');
var myapp = express()
            .use(orion({ workspaceDir: '.myworkspace' }))
            /* .use( additional handlers ) */

Running the tests

We use Mocha for our tests. Run npm test or mocha.

License

Dual-licensed under the Eclipse Public License v1.0 and the Eclipse Distribution License v1.0.