- 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)
For full instructions, see the Getting Started guide.
- 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.
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
- Browse to the directory where you installed Orion, usually
- Edit the
orion.conffile. Uncomment the following line, replacing the password with something of your choice:
This prevents unauthorized access to your Orion server.
npm start orionor
- 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.
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.
By default the server runs in single-user mode. Set
orion.single.user=false in the
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
require('orion') to get access to our startServer function, which is suitable for use within a larger Express project:
var orion = ;var express = ;var myapp =/* .use( additional handlers ) */
Running the tests
We use Mocha for our tests. Run
npm test or