Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Orion/Server admin guide

This page contains information on managing an Orion server.

Operating the server

Starting the server

The server is started by simply invoking the "eclipse" executable (eclipse.exe on Windows, "eclipse" on Unix platforms). Starting the OSGI console by passing the "-console" argument is also recommended:

 eclipse -console

Stopping the server

To stop the server, go to the OSGi console and type "close". You can also simply kill the server process, but an orderly shutdown is always recommended to ensure all data is correctly persisted.

Configuring the server

Changing the port

By default Orion will run on port 8080. To change the port, edit the file eclipse/eclipse.ini, and change the value of the "org.eclipse.equinox.http.jetty.http.port" system property.

Creating an admin user

No accounts are built into the Orion server by default. This avoids a vulnerability caused by well-known users and passwords that administrators neglect to change. While a small-scale server might not require an admin user at all, it is useful to create an admin account for larger-scale user management (seeing list of all users, adding/deleting users, etc). To create an admin account launch the server with a special system property specifying the admin password:

 eclipse -vmargs -Dorion.storage.admin.default.password="mypassword"

This will cause an administrator account to be created as the server starts up. The admin user name is "admin" and the password will be the value specified by the system property. Once the admin account has been created, the system property is no longer required on startup (the admin password can be changed later by logging in as the administrator and going to the profile management page).

Creating and deleting users

Users can be created and deleted by visiting the user management page at "/manage-users.html". For example a server on your own machine can be managed from http://localhost:8080/manage-users.html. Click the button Orion-new-user.gif to create a new user. To delete a user, click the Orion-delete-png.png button in the "Action" column next to the user to be deleted.

You can also create a user via the Orion server API. Use curl or another utility to send a POST request to "/users". The form requires the following parameters: "login" (user login id), "password" (initial password) and "passwordConf" (confirm password).

Back to the top