OMERO.server installation on CentOS 7¶
This is an example walkthrough for installing OMERO on CentOS 7, using a dedicated system user, and should be read in conjunction with OMERO.web administration. You can use this as a guide for setting up your own test server. For production use you should also read the pages listed under Optimizing Server Configuration. This guide will install Python 3.6.
This guide describes how to install using the recommended versions for Java, Ice, PostgreSQL. This should be read in conjunction with Version requirements.
This guide does not describe how to install OMERO.web. To deploy OMERO.web, please read OMERO.web installation on CentOS 7 and IcePy 3.6.
These instructions assume your Linux distribution is configured with a UTF-8 locale (this is normally the default).
For convenience in this walkthrough, we will use the omero system user and the main OMERO configuration options have
been defined as environment variables. When following this walkthrough you can
either use your own values, or alternatively source settings.env
:
OMERO_DB_USER=db_user
OMERO_DB_PASS=db_password
OMERO_DB_NAME=omero_database
OMERO_ROOT_PASS=omero_root_password
OMERO_DATA_DIR=/OMERO
# Location of the OMERO.server
OMERODIR=/opt/omero/server/OMERO.server
# Location of the virtual environment for omero-py
VENV_SERVER=/opt/omero/server/venv3
export OMERO_DB_USER OMERO_DB_PASS OMERO_DB_NAME OMERO_ROOT_PASS OMERO_DATA_DIR
export PGPASSWORD="$OMERO_DB_PASS"
export OMERODIR
PATH=$VENV_SERVER/bin:$PATH
export PATH
Installing prerequisites¶
The following steps are run as root.
Install Java 11, Ice 3.6.5 and PostgreSQL 11:
To install Java 11 and other dependencies:
yum -y install epel-release
yum -y install unzip wget bc
# install Java
yum -y install java-11-openjdk
# install dependencies
yum -y install python3
To install Ice 3.6.5:
curl -sL https://zeroc.com/download/Ice/3.6/el7/zeroc-ice3.6.repo > \
/etc/yum.repos.d/zeroc-ice3.6.repo
yum -y install ice-all-runtime
To install PostgreSQL 11:
yum -y install https://yum.postgresql.org/11/redhat/rhel-7-x86_64/pgdg-redhat11-11-2.noarch.rpm
yum -y install postgresql11-server postgresql11
PGSETUP_INITDB_OPTIONS=--encoding=UTF8 /usr/pgsql-11/bin/postgresql-11-setup initdb
sed -i.bak -re 's/^(host.*)ident/\1md5/' /var/lib/pgsql/11/data/pg_hba.conf
systemctl start postgresql-11.service
systemctl enable postgresql-11.service
Note
if you are installing PostgreSQL in a Docker container, some of the commands above will not work. For more details check step01_centos7_pg_deps.sh
Create an omero system user, and a directory for the OMERO repository:
useradd -mr omero
# Give a password to the omero user
# e.g. passwd omero
chmod a+X ~omero
mkdir -p "$OMERO_DATA_DIR"
chown omero "$OMERO_DATA_DIR"
Create a database user and initialize a new database for OMERO:
echo "CREATE USER $OMERO_DB_USER PASSWORD '$OMERO_DB_PASS'" | su - postgres -c psql
su - postgres -c "createdb -E UTF8 -O '$OMERO_DB_USER' '$OMERO_DB_NAME'"
psql -P pager=off -h localhost -U "$OMERO_DB_USER" -l
Installing OMERO.server¶
The following step is run as root.
We recommend to create a virtual environment and install the Ice Python binding using pip
:
# Create a virtual env and activate it
python3 -mvenv $VENV_SERVER
# Install the Ice Python binding
$VENV_SERVER/bin/pip install https://github.com/ome/zeroc-ice-py-centos7/releases/download/0.2.1/zeroc_ice-3.6.5-cp36-cp36m-linux_x86_64.whl
Install omero-py
:
# Install omero-py
$VENV_SERVER/bin/pip install "omero-py>=5.6.dev4"
Download and unzip OMERO.server:
cd /opt/omero/server
SERVER=https://downloads.openmicroscopy.org/omero/5.6/server-ice36.zip
wget -q $SERVER -O OMERO.server-ice36.zip
unzip -q OMERO.server*
Change the ownership of the OMERO.server directory and create a symlink:
# change ownership of the folder
chown -R omero OMERO.server-*
ln -s OMERO.server-*/ OMERO.server
The following steps are run as the omero system user.
The variable OMERODIR
set in settings.env
above must point to the location where OMERO.server is installed.
e.g. OMERODIR=/path_to_omero_server/OMERO.server
.
Note that this script requires the same environment variables that were set earlier in settings.env, so you may need to copy and/or source this file as the omero user.
Configure the server:
omero config set omero.data.dir "$OMERO_DATA_DIR"
omero config set omero.db.name "$OMERO_DB_NAME"
omero config set omero.db.user "$OMERO_DB_USER"
omero config set omero.db.pass "$OMERO_DB_PASS"
omero db script -f $OMERODIR/db.sql --password "$OMERO_ROOT_PASS"
psql -h localhost -U "$OMERO_DB_USER" "$OMERO_DB_NAME" < $OMERODIR/db.sql
Running OMERO.server¶
The following steps are run as the omero system user.
OMERO should now be set up. To start the server run:
omero admin start
In addition omero-systemd.service
is available should you wish to start OMERO automatically.
Securing OMERO¶
The following steps are run as root.
If multiple users have access to the machine running OMERO you should restrict access to OMERO.server’s configuration and runtime directories, and optionally the OMERO data directory:
chmod go-rwx $OMERODIR/etc $OMERODIR/var
# Optionally restrict access to the OMERO data directory
# chmod go-rwx "$OMERO_DATA_DIR"