The Linux installation package has been specifically built to make installation and configuration as simple as possible.

After installation Zegami will be up and running and ready to create collections. While most common deployments will be satisfied with the default settings, more complicated scenarios may require additional configuration.

Installation

The installer has been tested with Ubuntu 16.04 and CentOS 7. If installing on CentOS, some additional setup may be required if the networking does not work, see Preparing A CentOS VM to install Zegami.

Once the install package has been downloaded, extract it using the archive manager on your OS or at the command line with:

tar -xvf zegami-linux.tgz

For Ubuntu 16.04 and CentOS 7, the installation package, once extracted, contains an installation script called linux-install.sh. This can be used for automatic installation of packages, a webserver (nginx), MongoDB and the uWSGI python server.

Once extracted run the following to start the installation process.

sudo bash linux-install.sh

There are a set of options which can be configured on install of Zegami. These can be altered in the file zegamiscripts/settings.sh before you run the installer.

The installation process will install the Zegami appication to /opt/zegami, create a collection data directory at /zegami and configure related permissions.

It will then start all Zegami related services, create an initial test collection and set up the initial admin user. Once installation is complete the final output with initial users details will be displayed like the following.

...
zegami_nginx: started
zegami_uwsgi: started
zegami_services: started
settings up demo collection

====== Collections ======
found 2 lines
Demo collection created succesfully

====== Creating Collection ======

Name: xenopus
Url: /xenopus
ID: 57a476ac2cff4d7bb61df22c
Total Items: 324
Last Processed: 2016-08-05 12:21:24.304798
Data Source URL: /api/collections/57a476ac2cff4d7bb61df22c/datasource.tsv
Deep Zoom URL:   /api/collections/57a476ac2cff4d7bb61df22c/dz/57a476ac2cff4d7bb61df22d/collection.json
Snapshot URL:    /api/collections/57a476ac2cff4d7bb61df22c
Setting the demo.html file
settings setup

User successfully created

=========================================================
A user has been created to access the administration portal
Your username is admin158
Your password is ODVlM2U2NDHl

The Zegami service consists of 5 python processes that are marshalled by the supervisord process control tool. Logging and data processing are grouped as one process so 4 of these services currently have their own config files for supervisor. These config files are put in place during the installation in the default supervisor configuration folder (/etc/supervisor/conf.d).

You can verify that the 4 processes are up and running typing the following at the terminal:

sudo supervisorctl

This should look as follows:

sudo supervisorctl
zegami_nginx                     RUNNING   pid 5271, uptime 8:40:23
zegami_services                  RUNNING   pid 5272, uptime 8:40:23
zegami_uwsgi                     RUNNING   pid 5273, uptime 8:40:23
supervisor> 

At the supervisorctl prompt you can see a realtime view of the logs from a process by running:

tail -f zegami_nginx

For more information on how Supervisor has been configured see Linux Configuration

Installation Complete

If installation completed successfully and the services have been confirmed as running then you can launch Zegami by navigating to http://localhost.

Full or Trial License Web interface (Zegami Manager)

If you have a full or trial license you will see a username and password at the end of the installation output that looks like this:

User successfully created
=========================================================
A user has been created to access the administration portal
Your username is admin158
Your password is ODVlM2U2NDHl

The username and password are diplayed in the terminal. in the example above the username is admin158 and the password is ODVlM2U2NDHl.

Use these to log in to the administration portal via the login form at http://localhost.

Install complete

Once you have logged in you will see the demo collection. In order to create another se the documnetaion at Creating a collection on the CLI.

Web interface for CLI installs (Academic License)

Upon launch of the index page from an academic license install you will see the standard web server index page including demo.html.

You can see the demo collection by clicking on demo.html otherwise to create a collection see the documentation on Creating a collection on the CLI.

Before running the CLI for the first time the PATH needs to be set to the zegami python interpreter. Which can be set by running export PATH="/opt/zegami_python/anaconda/bin:$PATH". This will be done automatically if you open a new terminal window.

Zegami Server Configuration

By default, the Zegami server will be running once installed. Further details on how the server can be configured are located in Server Configuration

Authentication Security

If using the LocalAuth authentication plugin, please ensure to configure SSL for encryption of payload data. This is done automatically as part of the install process. If you would like to it again with different details or add a comercial SSL certificate, the details can be changed in hte below script and it can be run again as shown.

To create a self signed certificate run the folowing:

cd zegamiscripts
sudo su -c "bash create_ssl_certificate.sh" zegami