Context Navigation

OMERO.server Installation on Microsoft Windows

NOTE: If you are upgrading your OMERO.server installation you want to follow instructions on the OmeroUpgrade page.

NOTE: If you are attempting a UNIX Based Platform install (Linux, Mac OS X, etc.) please see the OmeroInstall page.

Prerequisites

PostgreSQL 8.1 or higher installed and configured to accept TCP connections

Yes, this is a higher prerequisite than the UNIX based operating systems. Only recently has PostgreSQL provided Windows service and UTF8 support availability in the default installation on Microsoft Windows. Win32 binary installers can be found on the PostgreSQL website and will be called something like postgresql-8.2.5-1.zip (for PostgreSQL 8.2.5).

NOTE: You must install PostgreSQL as a service if you want to follow this document, other PostgreSQL installation environments are supported but are outside the scope of this document.

NOTE: This document assumes a PostgreSQL 8.2 or higher install for ease of installation and documentation. PostgreSQL 8.1 installations are supported but are again, outside the scope of this document.

Java 1.5 SE Development Kit (JDK) or higher installed (http://java.sun.com/javase/downloads/index.jsp)

OMERO.server ZIP available from MilestoneDownloads

Pre-Installation

(This will require an "administrator" level account for which you know the password)

Create a non-superuser database user (make sure to note down the name and password) using pgAdmin III. You can find pgAdmin III on the Start Menu under Programs --> PostgreSQL 8.2 --> pgAdmin III:
1. Double-click on the PostgreSQL Database Server 8.2 and provide your postgres user login password

Right-click on Login Roles (or left-click on Login Roles and navigate to Edit --> New Object...) and select New Login Role...
Create a new role with the Role name omero and a Password omero

Right-click on Databases (or left-click on Databases and navigate to Edit --> New Object...) and select New Database...
Create a new database with the Name omero and Owner omero (this may take a few moments)

Create a directory for the OMERO binary data repository. NOTE: This is not where you want the OMERO application to be installed, it is a seperate directory that OMERO.server will use to store binary data. C:\OMERO is the default location and should be used unless you explicitly have a reason not to and know what you are doing.

Installation

Extract the OMERO ZIP and note its location

Edit the etc\local.properties file in the OMERO distribution based upon your database user and password choices
```
ex. C:\omero-3.0-Beta1\omero\etc\local.properties
```
- One property which it is often useful to change is the omero.data.dir value, which points to your OmeroBinaryRepository. However, when using "C:\" style file paths in a properties file, it is necessary to "escape" the backslashes. E.g.
```
omero.data.dir=D:\\bigdisk\\omero
```

The example local.properties file included in the OMERO.server distribution:

#
# Default OMERO local.properties file for distribution. Please see:
#
#  http://trac.openmicroscopy.org.uk/omero/wiki/OmeroInstall
#  http://trac.openmicroscopy.org.uk/omero/wiki/OmeroAndPostgres
#
# ________________________________
# Chris Allan <callan@blackcat.ca>
#

# ********
# ******** USER CONFIGURABLE OPTIONS
# ********

# OMERO "root" user's default password. Will be used for "setup-db".
omero.rootpass=omero

# OMERO server's database connection username. This should match up 
# with whatever you have set the database username.
hibernate.connection.username=omero

# OMERO server's database connection password. This should match up 
# with whatever you have set the database password.
hibernate.connection.password=omero

# OMERO server's database connection URL. This should match up with 
# "database.host" and "database.name" below.
hibernate.connection.url=jdbc\:postgresql\://localhost/omero3

# Database server hostname.
database.host=localhost

# Database instance name.
database.name=omero3

# OMERO binary repository directory. Defaults to /OMERO. Please see
# http://trac.openmicroscopy.org.uk/omero/wiki/OmeroBinaryRepository for
# more information.
omero.data.dir=/OMERO/

# ********
# ******** SYSTEM OPTIONS (DO NOT MODIFY UNLESS INSTRUCTED)
# ********

# JBoss server's hostname. It is unlikely this is something you will
# need to change.
server.host=localhost

# JBoss server's port. It is unlikely this is something you will
# need to change.you will want to change.
server.port=1099

# OMERO testing framework's default user. Unless you are performing
# tests as a developer you will not need to change this.
omero.user=omero

# OMERO testing framework's default password. Unless you are 
# performing tests as a developer you will not need to change this.
omero.pass=omero

# OMERO database profile. Do not change this.
omero.db.profile=psql

# Java compiler options.
javac.source=1.5
javac.target=1.5
javac.debug=on
javac.debuglevel=lines,vars,source

# ICE compilation options. Do not change.
no.ice=false
ice.home=/usr/share/Ice

# PostgreSQL profile setup. Do not change these.
hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
hibernate.connection.driver_class=org.postgresql.Driver

Initialize the OMERO database, deploy the OMERO EAR and start OMERO (Start --> Run... and Open: cmd.exe):

cd C:\omero-3.0-Beta2.3\omero 
set JBOSS_HOME=C:\omero-3.0-Beta2.3\jboss-4.2.1.GA 
java omero setup-db deploy
cd %JBOSS_HOME%\bin
run

Administration

Once you have deployed and started the server you can use your browser to access the OMERO WebAdmin administration interface (included with the bundled JBoss server) at:

http://localhost:8080/WebAdmin/

Assuming you're using the default local.properties file (also annotated above), the default username is root and the default password is omero:

Reconfiguration

If at any time you change the vales of of the property files contained under etc you will need to update the EAR file and redeploy, for example:

set JBOSS_HOME=C:\omero-3.0-Beta2.3\jboss-4.2.1.GA
java omero deploy

Update Notification

As of milestone:3.0-Beta2.3, your OMERO.server installation will check for updates each time it is started from the Open Microscopy Environment update server. If you wish to disable this functionality you should do so now as outlined on the UpgradeCheck page.

Security

It is now recommended that you read the OmeroSecurity page to get a good idea as to what you need to do to get OMERO clients speaking to your newly installed OMERO.server in accordance with your institution or company's security policy.

Troubleshooting

My OMERO install doesn't work! What do I do now!?! Examine OmeroTroubleshooting and if all else fails post a message to our ome-users mailing list discussed on the OmeroCommunity page.