Orionode is a minimal, single-user sever deployment of Orion used for Node development with Orion's editing environment.

+

Orion provides a minimal, single-user server deployment of Orion written in JavaScript that runs on [http://nodejs.org Node.js]. This implementation of Orion supports developing your own Node applications with Orion's editing environment.

==Features==

==Features==

+

The JavaScript Orion server implementation is still very early access. There are many rough edges and missing features compared to the full Java-based Orion server. The JavaScript-based Orion server currently supports:

#[[Orion/Getting_the_source#Getting_the_source_onto_your_computer|Get the Orion source]]. You only need to get the [http://git.eclipse.org/c/orion/org.eclipse.orion.client.git client source].

+

You can obtain Orionode through npm (the easiest way) or by checking out its source repo and running it. Checking out the source is mainly of interest to developers wishing to work on or extend the Orion node server. For details on this approach see the Orion developer [[Orion/Getting_the_source#Node.js_on_local_computer| wiki page]].

−

#Open a command shell and change directory to '''org.eclipse.orion.client/modules/orionode'''.

+

−

#Run <code>npm install</code> command to automatically download Orionode's dependencies. This will take a few minutes.

+

=== Installing with npm ===

−

#Verify the default path of npm-cli.js.

+

To install Orion with the Node Package Manager (npm), simply run the following command from the shell:

−

##In the same directory, open the server.conf file. The default value of npm_path is <code>../lib/node_modules/npm/bin/npm-cli.js</code>. This is the npm module path to support npm command. Make sure if this default path is correct, relative to the node executable in your environment.

+

<code> npm install orion</code>

−

##If you installed a recent version of Node.js, npm should be installed automatically. The default value of npm_path should work in most cases.

+

This will install Orionode into a <code>node_modules</code> subdirectory of your working directory.

−

##How to confirm: For instance, if you are using Bash just type <code>which npm</code> and see where the command is. The command should eventually use the npm-cli.js file. Make sure your npm-cli.js matches the npm_path value. If not, then change the npm-path value to match your environment. It can be either an absolute path or a path relative to your node executable.

+

* If you're not interested in developing the Orionode server, add the <code>--production</code> flag for a slightly smaller download.

−

#Create a one-line "password.txt" file containing a secret password. If you do not want a separate file for password, you can still define that in the server.conf or just leave the pwd value as empty.

+

−

#Launch the Orionode server.

+

=== Starting and stopping the server ===

−

#* If you installed by checking out the Git repo, run this command from a shell <code>node server.js [-p port] [-w directory] [-password password.txt]</code>.

+

# Launch Orion by running:<br><code>npm start orion</code>

−

#* If you're not passing any command-line arguments to the server, you can just use <b>npm start</b>.

+

#* If you need to pass [[#Server_command_line_arguments|command line arguments]] to the server, run the server.js file directly:<br><code>node node_modules/orion/server.js [arguments]</code>

−

#Go to http://localhost:8081 (or whatever port you chose) in your web browser to start using Orionode.

+

# Go to http://localhost:8081 (or whatever port you provided in the server arguments) in your web browser to start using Orionode.

+

# Stop the server by sending a kill signal from the console (typically Ctrl+C)

+

+

=== The orion.conf file ===

+

You can pass arguments to the server by editing the <code>orion.conf</code> file. It is found in the directory where you installed Orion (when installing from npm, this is typically <code>node_modules/orion/</code>).

+

+

===== Password =====

+

Add a line in your <code>orion.conf</code> file that looks like this:

+

pwd=mysecretpassword

+

+

===== Node inspector web port =====

+

Orion on Node runs a node inspector process with the "--web-port" arguments to avoid conflicting port number with others. The default port number is 8900 but you can change it in the conf file. The port number will be represented in the debug URL link like: yourOrionServer:node_inspector_port/debug?port=yourDebugPort

+

node_inspector_port=myPreferredPortNumber

+

+

===== Workspace =====

+

Edit the <code>orion.conf</code> file and change the <code>workspace</code> option to point to a directory in your user space. If not specified, a default <code>.workspace</code> directory will be created in the Orion install directory. For example:

+

workspace=/home/pi/Workspace/

+

+

===== Making sure Orion can launch npm =====

+

Orion on Node lets you use <code>npm</code> commands in the Orion shell to manage the dependencies of a project you're writing. To do this, the server makes a guess about the path where the npm internals (specifically, <code>npm-cli.js</code>) are located on your computer. If you installed a recent version of Node.js, npm should be installed automatically and the guess should work. If you installed npm separately, this guess may be wrong. If you see an error message when launching the server or when you try to run npm commands in the Orion shell, it means the server failed to guess where npm lives, so you have to specify the path to <code>npm-cli.js</code> yourself:

+

+

#Find out where npm lives on your computer (npm must be in your PATH environment variable for this to work). From a command shell, run:

+

#* On Windows: <code>where npm</code>

+

#* On Mac OS/Linux: <code>which npm</code>

+

#* The returned path will be a shell script (or a symbolic link to a script) that launches <code>npm-cli.js</code>. The path to <code>npm-cli.js</code> is what we need. Open up the script in a text editor, and copy the path of <code>npm-cli.js</code>.

+

#In the server directory, open the <code>orion.conf</code> file. You'll find a <code>npm_path</code> option (by default its value is empty).

+

#Set the value of <code>npm_path</code> option equal to the path to <code>npm-cli.js</code>.

+

#* You can provide the path as an absolute path, or a path relative to your node executable.

+

#Start or restart the server. If you do not see any "npm" errors printed to the console, your npm path is set properly.

== Server command line arguments ==

== Server command line arguments ==

−

All these arguments are optional.

+

When launching the server manually through node.js (<code>node [orion install dir]/server.js</code>), a number of optional arguments can be provided:

; <code>-p</code> or <code>-port</code>

; <code>-p</code> or <code>-port</code>

: The port that the Orion server will listen on. Defaults to 8081.

: The port that the Orion server will listen on. Defaults to 8081.

; <code>-pwd</code> or <code>-password</code>

; <code>-pwd</code> or <code>-password</code>

−

: Path to a file containing a password. If provided, Orionode will enforce HTTP Basic Authentication with the password (the auth 'User' field is ignored -- Orionode only verifies the password). Use caution: if you don't provide a password file, '''no authentication''' is used (so anyone request can read and write your files!).

+

: Path to a file containing a password. If provided, Orionode will enforce HTTP Basic Authentication with the password (the auth 'User' field is ignored -- Orionode only verifies the password). Use caution: if you don't provide a password file, '''no authentication''' is used (so anyone can access your Orionode server and read and write your files!).

; <code>-w</code> or <code>-workspace</code>

; <code>-w</code> or <code>-workspace</code>

−

: The target directory for reading and writing files. Will be created if it doesn't exist. Defaults to a subdirectory named .workspace in the repository folder.

+

: The target directory for reading and writing files. Will be created if it doesn't exist. Defaults to a subdirectory named <code>.workspace</code> in the server directory. This option can also be set in your [[#The orion.conf file|orion.conf file]].

; <code>-dev</code>

; <code>-dev</code>

: Starts the server in development mode. In this mode, some client-side code is not cached by the browser, to ease development.

: Starts the server in development mode. In this mode, some client-side code is not cached by the browser, to ease development.

; <code>-log</code>

; <code>-log</code>

: Logs each request served to standard output.

: Logs each request served to standard output.

+

Arguments passed on the command line override arguments set in the orion.conf file, when both are provided.

== Developing a node.js application ==

== Developing a node.js application ==

−

Now in the browser you can start to develop your node.js applications. Orionode uses the same client code as Orion does. Refer to [[Orion/Documentation/User_Guide|Orion user guide]] for the client usage. Please note that the sites and git pages are not available in Orionode. Here is a typical workflow:

+

Now in the browser you can start to develop your node.js applications. Orionode uses largely the UI you're accustomed to from Orion. (Refer to [[Orion/Documentation/User_Guide|Orion user guide]] for basic instructions). Please note that the Sites and Git pages are not available in Orionode. Here is a typical workflow:

#Use <code>node stop PID</code> ot stop an application if you want to force it to stop.

+

#Use <code>node stop [PID]</code> to stop an application if you want to force it to stop.

== Debugging a node.js application ==

== Debugging a node.js application ==

−

You can use Orionode to debug your node.js application. If you have exisiting node.js applications, make sure the code is under a subfolder in the -w option when you start Orionnode. This will give you easy access to your node.js apps from within Orionode.

+

You can use Orionode to debug your node.js application. If you have existing node.js applications, make sure the code is under a subfolder of the workspace (path provided by the -w option when you start Orionnode). This will give you easy access to your node.js apps from within Orionode.

You can also create a new node.js application in your workspace.

You can also create a new node.js application in your workspace.

#After Orionode starts, open the shell page and use help to see what commands are available.

#After Orionode starts, open the shell page and use help to see what commands are available.

The debug interface currently only works with Webkit browsers (Chrome, Safari).

−

By default the pages served up by Orionode are not concatenated or minified, so they will load rather slowly. You can mitigate this by running the client-side build. To do this, just run <code>build.js</code>, found in the <code>build</code> directory:

+

−

+

−

orionode $ node ./build/build.js

+

−

-------------------------------------------------------

+

−

[lots of output]

+

−

orionode $

+

−

+

−

Clear your browser cache. The next time you load Orionode, it should be much faster.

+

== Other ways of using Orionode ==

== Other ways of using Orionode ==

Line 87:

Line 108:

* See the [https://bugs.eclipse.org/bugs/buglist.cgi?list_id=4064489&classification=Eclipse&query_format=advanced&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&component=Node&product=Orion list of open bugs].

* See the [https://bugs.eclipse.org/bugs/buglist.cgi?list_id=4064489&classification=Eclipse&query_format=advanced&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&component=Node&product=Orion list of open bugs].

* There is no way to provide standard input to a running Node.js app.

* There is no way to provide standard input to a running Node.js app.

−

* No source control integration yet. E.g.: Git support.

+

* There is no source control integration yet. E.g.: Git support.

+

+

== See also ==

+

* [[Orion/Node/Developing|Developing the Node server]]

−

[[Category:Orion|Getting Started with Orion node]]

+

[[Category:Orion|N]]

+

[[Category:Orion/Node|G]]

Revision as of 15:28, 30 October 2013

Orion provides a minimal, single-user server deployment of Orion written in JavaScript that runs on Node.js. This implementation of Orion supports developing your own Node applications with Orion's editing environment.

Features

The JavaScript Orion server implementation is still very early access. There are many rough edges and missing features compared to the full Java-based Orion server. The JavaScript-based Orion server currently supports:

Requirements

Getting Orionode and starting it

You can obtain Orionode through npm (the easiest way) or by checking out its source repo and running it. Checking out the source is mainly of interest to developers wishing to work on or extend the Orion node server. For details on this approach see the Orion developer wiki page.

Installing with npm

To install Orion with the Node Package Manager (npm), simply run the following command from the shell:
npm install orion
This will install Orionode into a node_modules subdirectory of your working directory.

If you're not interested in developing the Orionode server, add the --production flag for a slightly smaller download.

Starting and stopping the server

Launch Orion by running:npm start orion

If you need to pass command line arguments to the server, run the server.js file directly:node node_modules/orion/server.js [arguments]

Go to http://localhost:8081 (or whatever port you provided in the server arguments) in your web browser to start using Orionode.

Stop the server by sending a kill signal from the console (typically Ctrl+C)

The orion.conf file

You can pass arguments to the server by editing the orion.conf file. It is found in the directory where you installed Orion (when installing from npm, this is typically node_modules/orion/).

Password

Add a line in your orion.conf file that looks like this:

pwd=mysecretpassword

Node inspector web port

Orion on Node runs a node inspector process with the "--web-port" arguments to avoid conflicting port number with others. The default port number is 8900 but you can change it in the conf file. The port number will be represented in the debug URL link like: yourOrionServer:node_inspector_port/debug?port=yourDebugPort

node_inspector_port=myPreferredPortNumber

Workspace

Edit the orion.conf file and change the workspace option to point to a directory in your user space. If not specified, a default .workspace directory will be created in the Orion install directory. For example:

workspace=/home/pi/Workspace/

Making sure Orion can launch npm

Orion on Node lets you use npm commands in the Orion shell to manage the dependencies of a project you're writing. To do this, the server makes a guess about the path where the npm internals (specifically, npm-cli.js) are located on your computer. If you installed a recent version of Node.js, npm should be installed automatically and the guess should work. If you installed npm separately, this guess may be wrong. If you see an error message when launching the server or when you try to run npm commands in the Orion shell, it means the server failed to guess where npm lives, so you have to specify the path to npm-cli.js yourself:

Find out where npm lives on your computer (npm must be in your PATH environment variable for this to work). From a command shell, run:

On Windows: where npm

On Mac OS/Linux: which npm

The returned path will be a shell script (or a symbolic link to a script) that launches npm-cli.js. The path to npm-cli.js is what we need. Open up the script in a text editor, and copy the path of npm-cli.js.

In the server directory, open the orion.conf file. You'll find a npm_path option (by default its value is empty).

Set the value of npm_path option equal to the path to npm-cli.js.

You can provide the path as an absolute path, or a path relative to your node executable.

Start or restart the server. If you do not see any "npm" errors printed to the console, your npm path is set properly.

Server command line arguments

When launching the server manually through node.js (node [orion install dir]/server.js), a number of optional arguments can be provided:

-p or -port

The port that the Orion server will listen on. Defaults to 8081.

-pwd or -password

Path to a file containing a password. If provided, Orionode will enforce HTTP Basic Authentication with the password (the auth 'User' field is ignored -- Orionode only verifies the password). Use caution: if you don't provide a password file, no authentication is used (so anyone can access your Orionode server and read and write your files!).

-w or -workspace

The target directory for reading and writing files. Will be created if it doesn't exist. Defaults to a subdirectory named .workspace in the server directory. This option can also be set in your orion.conf file.

-dev

Starts the server in development mode. In this mode, some client-side code is not cached by the browser, to ease development.

-log

Logs each request served to standard output.

Arguments passed on the command line override arguments set in the orion.conf file, when both are provided.

Developing a node.js application

Now in the browser you can start to develop your node.js applications. Orionode uses largely the UI you're accustomed to from Orion. (Refer to Orion user guide for basic instructions). Please note that the Sites and Git pages are not available in Orionode. Here is a typical workflow:

Use the Navigator and Edit pages to create and edit your folders and node applications.

Go to the Shell page.

cd to the folder where your application lives.

Use npm install to install your dependency packages if needed. You can use basically all the npm arguments here.

Use node start yourApp.js to start your application.

Use node list to monitor any long-running applications you've started.

Use node stop [PID] to stop an application if you want to force it to stop.

Debugging a node.js application

You can use Orionode to debug your node.js application. If you have existing node.js applications, make sure the code is under a subfolder of the workspace (path provided by the -w option when you start Orionnode). This will give you easy access to your node.js apps from within Orionode.
You can also create a new node.js application in your workspace.

After Orionode starts, open the shell page and use help to see what commands are available.

cd to the folder where your application lives.

Use node debug yourApp.js givenPort to start your app in debug mode. You can start multiple apps in debug mode by repeating this step.

In the return value of the node debug command, you will see a "Debug URL", which you can click to start debugging your app.

The debug interface currently only works with Webkit browsers (Chrome, Safari).

Other ways of using Orionode

You can use Orionode as a file server, to access your local files from http://www.orionhub.org/ (or any other Orion installation). All you need is
Orionode and a publicly-accessible URL pointing to your local Orionode server.