This page explains the steps necessary to get set up for self-hosting on [http://orion.eclipse.org orion.eclipse.org]. This server is being used by the Orion committers to work on Orion itself.

+

== Self Hosting ==

+

''Self hosting'' means running a [[Orion/Documentation/User_Guide/Getting_started#Launching_your_project_as_a_website|site configuration]] on an Orion server that will host the Orion client code at a different URL, while proxying server API requests to the running server at the original URL.

−

#Log into [http://boris.orion.eclipse.org:8080 boris.orion.eclipse.org:8080]. Reload three times to get the links in the header. (three times? you must be kidding me!)<br>[The reason for logging into Orion at the subdomain is because the user profile page at orion.eclipse.org itself is broken.]

+

It provides a convenient way to run the latest Orion client code without having to set up an Eclipse development workspace, or frequently download new builds. It also protects you from destroying your editing environment when you are editing the Orion client code itself. For example, if you make a change that breaks the Orion editor, you can fall back to the "outer" site, revert the change, then return to your self-hosted "inner" site.

−

#Go to your user profile page. Enter your committer email and name at the bottom and save. This is important to do first so that Git commits are made using your username so that they can be pushed back to git.eclipse.org.

+

−

#Log out of boris.orion.eclipse.org and log into [http://orion.eclipse.org orion.eclipse.org]. You may have to clear local storage and reload three times again. (seriously? you gotta be kidding again!)

+

== Instructions ==

−

#Go to the navigator and create a new top-level folder called orion-client. Hover over the link for the folder, or click on it, to find out its internal name (something like "/file/x").

+

This section explains the steps necessary to get set up for self-hosting on [http://orion.eclipse.org orion.eclipse.org]. This server is being used by the Orion committers to work on Orion itself. Non-committers can follow the same steps: just replace any mention of orion.eclipse.org with [http://orionhub.org OrionHub], or your locally-running server, like <tt>http://localhost:8080</tt>.

−

#Delete the .git subdirectory that is created inside your new folder. (See https://bugs.eclipse.org/bugs/show_bug.cgi?id=346905 for details).

+

−

#Click on "Repositories" in the header, then on "Clone" in the toolbar. In the first field, enter ssh://myCommitterId@git.eclipse.org/gitroot/e4/org.eclipse.orion.client.git (replacing your committer id of course), and in the second field, enter /file/x, replacing x with the internal name of the folder you created. (internal name of the folder? why must this be so hard?)

+

=== Creating self hosting site ===

−

#You will get a prompt asking you for your eclipse.org account name and ssh password. The toolbar area will let you know when the clone is done.

+

#Log into [http://orion.eclipse.org orion.eclipse.org].

−

#Go back to the Navigator, and confirm that the repository has been cloned properly.

+

#Go to your user profile page. Enter your committer email and name in the Git section and save. This is important to do first so that Git commits are made using your committer username and can therefore be pushed back to git.eclipse.org.

−

#Log out and log back into [http://boris.orion.eclipse.org:8080 boris.orion.eclipse.org:8080]. Creating the site configuration is another thing that had a bug on orion.eclipse.org that is fixed in the inner.

+

#Click on '''Repositories''' in the top banner, then click '''Clone Repository''' in the toolbar. In the URL field, enter

−

#Click on the "Sites" link in the header, and create a new site configuration. Enter any name. On the page for the site configuration, click on the dropdown and then '''while holding the Shift key''' select the top-level folder that you just cloned into. This hidden feature will create the necessary entries for self-hosting.

#Wait for a moment while the repository is cloned. The toolbar area will let you know when it's done.

+

#Go back to the Navigator, and verify that a new folder was created called <tt>org.eclipse.orion.client</tt>, and that it contains the Orion client code.

+

#Click on the '''Sites''' link in the header, and create a new site configuration. Enter any name and press Ok.

+

#On the page for the site configuration, click on the "Convert to Self-Hosting" in the top banner. When a dialog comes up asking to "Choose Orion Source Folder" pick <tt>org.eclipse.orion.client</tt> from the list and select "Ok".

+

#Choose "Save" from the top banner.

+

#You should be able to choose "Start" from the top banner

+

#*The site will be launched with a name like <tt>[sitename].orion.eclipse.org:8080</tt> or <tt>127.0.0.2:8080</tt> if you're running a local server.

+

#*If you're running a local server and you receive a "No more hosts available" error, you need to [[Orion/Server_admin_guide#Hosting_locally|follow the instructions here]], restart your server, then repeat this step.

+

#Log into the new site, using the same credentials as in Step 1.

+

#You're all set :-)

+

+

=== Updating client code ===

+

# Using the Orion Git tools, pull the latest code from the <tt>master</tt> branch of the <tt>org.eclipse.orion.client</tt> repository.

+

# You're done. The next time you load a page on your self-hosted site, it will be running the latest code.

+

+

== Limitations ==

+

*From time to time, changes are made to ''both'' the Orion server and client code as new features are added. In these cases, the latest client code from Git may fail to work with an older server. To resolve this, you'll have to upgrade your Orion server by downloading a new build. Make sure to copy the [[Orion/Server_admin_guide|<tt>serverworkspace</tt> directory]] from your old server, so you can pick up working from where you left off.

+

*You cannot manage site configurations from a self-hosted site. You'll need to return to the outer server (orion.eclipse.org, orionhub.org, or whatever) to do this. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=369433 Bug 369433].

+

+

== Recovering from breakage ==

+

As you hack on Orion code from your self-hosted site, you may accidentally make a catastrophic change, such that you aren't able to open the editor to revert it.

+

In this case, just return to the "outer" server (orion.eclipse.org, orionhub.org, or whatever) and revert the change from there. Reload your self-hosted site and you should be able to continue working.

+

+

== More ==

+

While working on Orion, you may want to install some additional plugins. See the links below for catalogs of available plugins.

Revision as of 15:28, 6 November 2013

Contents

Self Hosting

Self hosting means running a site configuration on an Orion server that will host the Orion client code at a different URL, while proxying server API requests to the running server at the original URL.

It provides a convenient way to run the latest Orion client code without having to set up an Eclipse development workspace, or frequently download new builds. It also protects you from destroying your editing environment when you are editing the Orion client code itself. For example, if you make a change that breaks the Orion editor, you can fall back to the "outer" site, revert the change, then return to your self-hosted "inner" site.

Instructions

This section explains the steps necessary to get set up for self-hosting on orion.eclipse.org. This server is being used by the Orion committers to work on Orion itself. Non-committers can follow the same steps: just replace any mention of orion.eclipse.org with OrionHub, or your locally-running server, like http://localhost:8080.

Creating self hosting site

Go to your user profile page. Enter your committer email and name in the Git section and save. This is important to do first so that Git commits are made using your committer username and can therefore be pushed back to git.eclipse.org.

Click on Repositories in the top banner, then click Clone Repository in the toolbar. In the URL field, enter

Wait for a moment while the repository is cloned. The toolbar area will let you know when it's done.

Go back to the Navigator, and verify that a new folder was created called org.eclipse.orion.client, and that it contains the Orion client code.

Click on the Sites link in the header, and create a new site configuration. Enter any name and press Ok.

On the page for the site configuration, click on the "Convert to Self-Hosting" in the top banner. When a dialog comes up asking to "Choose Orion Source Folder" pick org.eclipse.orion.client from the list and select "Ok".

Choose "Save" from the top banner.

You should be able to choose "Start" from the top banner

The site will be launched with a name like [sitename].orion.eclipse.org:8080 or 127.0.0.2:8080 if you're running a local server.

If you're running a local server and you receive a "No more hosts available" error, you need to follow the instructions here, restart your server, then repeat this step.

Log into the new site, using the same credentials as in Step 1.

You're all set :-)

Updating client code

Using the Orion Git tools, pull the latest code from the master branch of the org.eclipse.orion.client repository.

You're done. The next time you load a page on your self-hosted site, it will be running the latest code.

Limitations

From time to time, changes are made to both the Orion server and client code as new features are added. In these cases, the latest client code from Git may fail to work with an older server. To resolve this, you'll have to upgrade your Orion server by downloading a new build. Make sure to copy the serverworkspace directory from your old server, so you can pick up working from where you left off.

You cannot manage site configurations from a self-hosted site. You'll need to return to the outer server (orion.eclipse.org, orionhub.org, or whatever) to do this. See Bug 369433.

Recovering from breakage

As you hack on Orion code from your self-hosted site, you may accidentally make a catastrophic change, such that you aren't able to open the editor to revert it.
In this case, just return to the "outer" server (orion.eclipse.org, orionhub.org, or whatever) and revert the change from there. Reload your self-hosted site and you should be able to continue working.

More

While working on Orion, you may want to install some additional plugins. See the links below for catalogs of available plugins.