Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Orion/How Tos/Install Orion on Localhost
Contents
Downloading and running Orion
- Download M4 for your platform from the download page
- Unzip the M4 zip file to a folder on your computer.
Note: Be sure to choose a folder that you have write access to. - Make sure you have Java installed - the server is implemented in Java. (Does 'java -version' print something like: java version "1.6.0_22"?)
- Launch the Orion server:
- Linux: Run
eclipse\eclipse
. - Mac OS X: Double-click
eclipse/eclipse
. - Windows: Double-click
eclipse\eclipse.exe
.
- Linux: Run
- Now the server is running on port 8080. (If you want it to use a different port, change the setting in the eclipse.ini file. On Mac OS X, you will have to right-click on eclipse/eclipse and select "Show Package Contents", then navigate into Contents/MacOS.)
- Point your web browser to http://localhost:8080/.
- You'll be directed to the Orion login screen:
From here you can create a new account for yourself on your local Orion server, or connect Orion to an existing Google, Yahoo, AOL or myOpenID account instead.
Using Orion
Linking to existing content
You can try out Orion's text editing features by editing existing files on your computer. Here's how:
- Open the
eclipse\eclipse.ini
file in a text editor. - In the
-vmargs
section, add a line similar to this:-
-Dorg.eclipse.e4.webide.server.allowedPathPrefixes=C:\Users\myusername\Documents\Code,C:\Myprojects\OrionFiles
This sets the JVM system propertyorg.eclipse.e4.webide.server.allowedPathPrefixes
, which tells the Orion server what local paths may be accessed by web users. Its value is a comma-separated list of absolute paths. (Remember that any Orion user who logs into your server will have this access, so don't point it to something sensitive.)
Note that this option has been renamed since M4 - if you are running the M4 download, use -Dorg.eclipse.e4.webide.server.allowedPathPrefixes=some_path, but when using later builds, use -Dorg.eclipse.orion.server.core.allowedPathPrefixes=some_path.
-
- Relaunch the Orion server.
- Log in and click the "Link Folder" or "Link Project" button on the toolbar.
- Type in a name for the link, and in the Server path: field, enter the path to the folder you want to link to (it must be a subdirectory of one of the paths you supplied in Step 2). Then click OK.
- You should now be able to browse and edit the contents of the folder from the Orion UI.
Stopping the server
- Go to the OSGi console window that opened when you launched the server.
- Type
close
and press Enter.
Managing files and folders
From the table view:
- To create a new folder, click the New Folder button on the toolbar.
- To create a new file, first drill into a folder by clicking on its name.
- Then you'll see the New File button appear on the toolbar. Click it to create a new file in the folder.
- To start editing a file, click its name.
From the tree view:
- To create or delete files or folders, right-click an item in the tree and use the context menu.
- To start editing a file, click the icon beside its name.