Jump to: navigation, search

Difference between revisions of "Orion/How Tos/Install Orion on Localhost"

< Orion‎ | How Tos
m (Downloading and Running Orion on Localhost)
m (Downloading Orion)
 
(16 intermediate revisions by 8 users not shown)
Line 1: Line 1:
= Downloading and Running Orion on Localhost=
+
This page explains how to download, install, and run Orion on your local machine.
# Download Orion for your platform from the [http://download.eclipse.org/e4/orion/ download page]. Choose the most recent Stable Build.
+
 
# Unzip the zip file to a folder on your computer.<br/>'''Note:''' Be sure to choose a folder that you have write access to.
+
== Downloading Orion  ==
# Make sure you have Java installed - the server is implemented in Java. (Does 'java -version' print something like: java version "1.6.0_22"?)
+
 
 +
#Download Orion for your platform from the [http://download.eclipse.org/orion/ download page]. Choose the most recent Stable Build.  
 +
#Unzip the zip file to a folder on your computer.<br>'''Note:''' Be sure to choose a folder that you have write access to.<br> '''Mac OS X:''' use the command line unzip. If you use the "Archive Utility", make sure that you "''Allow Applications Downloaded form: Anywhere''" in (System Preferences-&gt;Security &amp; Privacy-&gt;General)
 +
 
 +
== Starting the server ==
 +
# Make sure you have Java installed - the server is implemented in Java and '''requires''' Java SE 6. (Does 'java -version' print something like: java version "1.6.0_22"?). You also need a modern HTML5-capable browser. We recommend Firefox 15 or greater, Chrome 21 or greater, or Internet Explorer 10 or greater.
 
# Launch the Orion server:
 
# Launch the Orion server:
#* '''Linux:''' Run <code>eclipse\eclipse</code>.
+
#* '''Linux:''' Run <code>eclipse/orion</code>.
#* '''Mac OS X:''' Double-click <code>eclipse/eclipse</code>.
+
#* '''Mac OS X:''' Double-click <code>eclipse/orion</code>.
#* '''Windows:''' Double-click <code>eclipse\eclipse.exe</code>.<br>Once you launch the Orion server, the server console should start.<br>[[Image:Orion_Console.png]]
+
#* '''Windows:''' Double-click <code>eclipse\orion.exe</code>.<p>Once you launch the Orion server, the server console should start.</p>[[Image:Orion_Console.png|Orion Server Console]]
# 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.)
+
# Now the server is running on port 8080. (If you want it to use a different port, change the setting in the orion.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/ http://localhost:8080/].
 
# Point your web browser to [http://localhost:8080/ http://localhost:8080/].
# You'll be directed to the Orion login screen:<br/>[[Image:Orion_Create_Account.png]]<br/>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.
+
# You'll be directed to the Orion login screen:<br/>[[Image:Orion_Create_Account.png|Orion Login Screen]]<br/>From here you can create a new account for yourself on your local Orion server, or connect Orion to an existing Google or Mozilla Persona account instead (both these two options require an initial Orion account).
 +
 
 +
== Stopping the server ==
 +
# Go to the server console window that opened when you launched the server.
 +
# Type <code>close</code> and press Enter.
 +
 
  
 
= Using Orion =
 
= Using Orion =
 +
== Getting started ==
 +
After you've got Orion installed and running, read [[Orion/Documentation/User Guide/Getting started | Getting started with Orion]] for a brief tour of the user interface and basic features.
 +
 
== Linking to existing content ==
 
== Linking to existing content ==
You can try out Orion's text editing features by editing existing files on your computer. Here's how:
+
You can try out Orion's text editing features by editing existing files on your computer.  
# Open the <code>eclipse\eclipse.ini</code> file in a text editor.
+
# In the <code>-vmargs</code> section, add a line similar to this:
+
#* <code>-Dorg.eclipse.orion.server.core.allowedPathPrefixes=C:\Users\myusername\Documents\Code,C:\Myprojects\OrionFiles</code><br/>This sets the JVM system property <code>org.eclipse.orion.server.core.allowedPathPrefixes</code>, 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.)<br><br>''Note that this option was named differently prior to M5.'' If you are running M4, use -Dorg.eclipse.e4.webide.server.allowedPathPrefixes=some_path. For all newer builds, including M5, 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 ==
+
# Configure the allowed local paths the Orion server can access. See the [[Orion/Server_admin_guide#Configuring_paths_where_users_can_store_files| Server administration guide]] for details on how to configure what directories are available to the Orion server.
# Go to the OSGi console window that opened when you launched the server.
+
# Log in and click the "Link Folder" button on the toolbar.
# Type <code>close</code> and press Enter.
+
# 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).  
 +
# Click OK.
 +
# You should now be able to browse and edit the contents of the folder from the Orion UI.
  
 
<!--
 
<!--
Line 46: Line 54:
  
  
[[Category:Orion/How To|Running 0.2 M4]][[Category:Orion|Running 0.2 M4]]
+
[[Category:Orion/How To|Running]][[Category:Orion|Running]]

Latest revision as of 12:40, 27 April 2013

This page explains how to download, install, and run Orion on your local machine.

Downloading Orion

  1. Download Orion for your platform from the download page. Choose the most recent Stable Build.
  2. Unzip the zip file to a folder on your computer.
    Note: Be sure to choose a folder that you have write access to.
    Mac OS X: use the command line unzip. If you use the "Archive Utility", make sure that you "Allow Applications Downloaded form: Anywhere" in (System Preferences->Security & Privacy->General)

Starting the server

  1. Make sure you have Java installed - the server is implemented in Java and requires Java SE 6. (Does 'java -version' print something like: java version "1.6.0_22"?). You also need a modern HTML5-capable browser. We recommend Firefox 15 or greater, Chrome 21 or greater, or Internet Explorer 10 or greater.
  2. Launch the Orion server:
    • Linux: Run eclipse/orion.
    • Mac OS X: Double-click eclipse/orion.
    • Windows: Double-click eclipse\orion.exe.

      Once you launch the Orion server, the server console should start.

      Orion Server Console
  3. Now the server is running on port 8080. (If you want it to use a different port, change the setting in the orion.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.)
  4. Point your web browser to http://localhost:8080/.
  5. You'll be directed to the Orion login screen:
    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 or Mozilla Persona account instead (both these two options require an initial Orion account).

Stopping the server

  1. Go to the server console window that opened when you launched the server.
  2. Type close and press Enter.


Using Orion

Getting started

After you've got Orion installed and running, read Getting started with Orion for a brief tour of the user interface and basic features.

Linking to existing content

You can try out Orion's text editing features by editing existing files on your computer.

  1. Configure the allowed local paths the Orion server can access. See the Server administration guide for details on how to configure what directories are available to the Orion server.
  2. Log in and click the "Link Folder" button on the toolbar.
  3. 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).
  4. Click OK.
  5. You should now be able to browse and edit the contents of the folder from the Orion UI.