Jump to: navigation, search

Difference between revisions of "Orion/How Tos/Setup Orion Client Hosted Site on OrionHub"

< Orion‎ | How Tos
(New page: The site definition feature in Orion allows you to map folders in your workspace to a site definition, so that you can host a site within Orion. What's really cool about this is that you ...)
 
Line 1: Line 1:
 
The site definition feature in Orion allows you to map folders in your workspace to a site definition, so that you can host a site within Orion.  What's really cool about this is that you can use this feature to host sites from your Orion hub account.  For example, there is a hosted site running the Orion embedded editor example at http://mamacdon.orionhub.org:8080/examples/embeddededitor.html.
 
The site definition feature in Orion allows you to map folders in your workspace to a site definition, so that you can host a site within Orion.  What's really cool about this is that you can use this feature to host sites from your Orion hub account.  For example, there is a hosted site running the Orion embedded editor example at http://mamacdon.orionhub.org:8080/examples/embeddededitor.html.
 +
 +
== Setting up the Site ==
 +
To run something like the embedded editor example, you would need to host the orion editor, the rest of the orion client core code, and dojo. 
 +
 +
When hosting a site from your orionhub account, you cannot expect to make calls to the orionhub server to do things like retrieve files in your workspace.  This is because of the "same domain" restriction.  Hosted sites are located at *username.orionhub.org*, whereas the user's workspace server is running on *orionhub.org*.  However, this set up can still be very useful for running Orion client components such as the editor, outliner, content assist, custom dojo applications, etc.
 +
 +
To set up such a site, you need to do the following:
 +
 +
* Log in to Orionhub
 +
* Click on the "Repositories" link in the top of the navigator page.
 +
* On the repositories page, there is a button on the right hand side for cloning a git repository.  Clone the repository at http://git.eclipse.org/gitroot/e4/org.eclipse.orion.client.git.
 +
* Once the clone is complete, use the associated link button and link the clone to a folder called "orion-client" in the workspace.
 +
* From the navigator, import the dojo 1.5 zip file to "dojo/dojo-release-1.5.0" folder in workspace
 +
** You should now have folders like dojo/dojo-release-1.5.0/{dojo, dijit, dojox}
 +
* Click on the "Sites" link at the top of the navigator page to create a running site.
 +
** Mount the paths as follows
 +
<pre>
 +
===========================================================================================
 +
Workspace path                                            |  Mount at
 +
===========================================================================================
 +
/orion-client/bundles/org.eclipse.orion.client.core/static |  /
 +
/orion-client/bundles/org.eclipse.orion.client.editor/web  |  /editor
 +
/dojo/dojo-release-1.5.0                                  |  /org.dojotoolkit/
 +
===========================================================================================
 +
 +
Note: although the workspace paths are the important bit, you have to enter them in the
 +
Target column as suffixes of "X" and "Y", where X and Y are the shortnames of your
 +
orion-client and dojo projects.
 +
 +
</pre>
 +
* Launch the site, and point your browser at /examples/embeddededitor.html

Revision as of 13:10, 4 May 2011

The site definition feature in Orion allows you to map folders in your workspace to a site definition, so that you can host a site within Orion. What's really cool about this is that you can use this feature to host sites from your Orion hub account. For example, there is a hosted site running the Orion embedded editor example at http://mamacdon.orionhub.org:8080/examples/embeddededitor.html.

Setting up the Site

To run something like the embedded editor example, you would need to host the orion editor, the rest of the orion client core code, and dojo.

When hosting a site from your orionhub account, you cannot expect to make calls to the orionhub server to do things like retrieve files in your workspace. This is because of the "same domain" restriction. Hosted sites are located at *username.orionhub.org*, whereas the user's workspace server is running on *orionhub.org*. However, this set up can still be very useful for running Orion client components such as the editor, outliner, content assist, custom dojo applications, etc.

To set up such a site, you need to do the following:

  • Log in to Orionhub
  • Click on the "Repositories" link in the top of the navigator page.
  • On the repositories page, there is a button on the right hand side for cloning a git repository. Clone the repository at http://git.eclipse.org/gitroot/e4/org.eclipse.orion.client.git.
  • Once the clone is complete, use the associated link button and link the clone to a folder called "orion-client" in the workspace.
  • From the navigator, import the dojo 1.5 zip file to "dojo/dojo-release-1.5.0" folder in workspace
    • You should now have folders like dojo/dojo-release-1.5.0/{dojo, dijit, dojox}
  • Click on the "Sites" link at the top of the navigator page to create a running site.
    • Mount the paths as follows
===========================================================================================
 Workspace path                                             |   Mount at
===========================================================================================
 /orion-client/bundles/org.eclipse.orion.client.core/static |   /
 /orion-client/bundles/org.eclipse.orion.client.editor/web  |   /editor
 /dojo/dojo-release-1.5.0                                   |   /org.dojotoolkit/
===========================================================================================

Note: although the workspace paths are the important bit, you have to enter them in the 
Target column as suffixes of "X" and "Y", where X and Y are the shortnames of your 
orion-client and dojo projects.

  • Launch the site, and point your browser at /examples/embeddededitor.html