Skip to main content
Jump to: navigation, search

Orion/Documentation/User Guide/Getting started

This tutorial will get you started with using Orion, and provides a step by step walk-through of some of the core functionality.

Getting Orion

You have two choices to get started with Orion. The first is to create an account on the public server at OrionHub. To do this, visit OrionHub, click Create a new account and enter your information. An email will be sent to confirm your address. Once confirmed, return to OrionHub and log in.

The second method to get started is to download a standalone version of the server. For instructions, see Install Orion on Localhost.

Once you have successfully set up an account, you can proceed to the next step.

Logging into Orion

When you attempt to access a page that requires logging in, you'll be redirected to the Login Page and prompted for credentials.

Login Page

On your first visit to the login page, you can sign in using either of these ways:

  • Sign in using the username and password of your Orion account.
  • Sign in with a linked Google account. To link a Google account, use Orion's Settings page.
  • Sign in using a Mozilla Persona. To do this, your Persona email address must be the same as the email address you chose when creating your Orion account. You can sign up for a Persona here.

If you are accessing a server other than OrionHub or localhost, the server administrator may have disallowed you from creating an account on the Login Page. In that case, you'll have to ask the server administrator to create one for you.

After a successful login, you will be redirected to the home page, or whatever Orion page you were attempting to access.

Working with folders and files

In Orion, each user has a virtual root folder where various folders and files can be created. These files are maintained on the Orion server. The Navigator page is used to browse and modify your files.

Creating folders and files

First, make sure you're at the Navigator page by clicking the "hamburger" menu ("Hamburger" menu), and then clicking Navigator. The Navigator is the primary place where your files and folders will be shown. Because you haven't created any files or folders yet, the navigator is initially empty:

Orion Navigator, initial state

To start working with files and folders in Orion, create a folder by clicking the "New" menu menu and clicking New Folder:

Navigator Toolbar

To navigate, you can either expand the folders in-place (using the ► twisties), or you can click on the folder's name to drill into that folder. After you have drilled into a folder, you can navigate back up using the breadcrumb at the top of the page (pictured below). You can also use your browser's Back button, or a keyboard command (Alt+↑) to navigate up.

Navigator Breadcrumbs

Using the common banner

The banner provides access to common operations in Orion. The navigation menu (sometimes called the "hamburger") appears in the left side of the banner, and provides access to navigation links that take you to various pages in Orion, as well as related resources or tasks that are relevant to your current context. (For example, if you're viewing a folder inside a Git repository, a Git Log link will be shown. Clicking it takes you straight to the Git Log page for the folder.)

The right side of the banner provides a user menu containing Settings, Help, and other actions vaguely related to your user identity.

In the center of the banner, you'll find the breadcrumb, and the name of the resource being manipulated. (Some Orion pages will show a simple static title here, if you're not currently targeting any particular resource.)

Below the banner, the content of the page appears. The page toolbar contains commands. The commands act upon the current folder (unless you've made a selection in the file tree).

Common Banner

Here is a picture of the banner with the navigation and user menus expanded, to show the various links they offer:

Common banner with menus expanded

The New menu (New menu) contains commands for creating new files or folders, and the Actions menu (Actions menu) contains commands that apply to existing files or folders. The Go Up command lets you navigate up to the parent folder.

Files and folders may be selected by clicking their row in the tree, or by using the Ctrl and arrow keys on the keyboard. Once a selection has been made, the Actions menu will show commands that operate on the selected items (such as move, copy, and delete). If you have not made a selection, the Actions menu will show commands that act upon the folder you're currently viewing.

Navigator actions

Importing folders and files

There are many ways to import your files into Orion. You can upload a zip file, import via SFTP, or clone a Git repository.

To import files from your local file system into Orion, select one or more files on your computer and simply drag them into the file tree. You can also drag Zip files into the navigator. Orion will ask you if you want to unzip the folder. This is convenient for backing up and restoring your work.

Import by drag and drop

If your browser supports it, you can even drag and drop an entire folder from your OS file explorer into Orion:

Drag and drop a folder

Exporting folders and files

When you have worked with your code on Orion and are ready to export your work back to your local workstation, navigate to the folder you wish to export and choose the Export as Zip link.

Export as zip

The contents of the folder will be placed in a zip file, and that zip file will be downloaded using your browser's download manager.

Back to the top