OpenAthens LA support will end on 31 March 2020

Search

Skip to end of metadata
Go to start of metadata

These instructions represent what will usually be the case when an updated version of the software is available. Should there be anything special or specific to do, such as a security patch to a specific component, the service desk will supply instructions.

With versions of 2.2.0 or above you can simply upgrade in place via Yum - either just the OpenAthens packages by themselves (recommended), or the whole system. With earlier versions such as 2.0 and 2.1 you need to migrate to new servers as that upgrade cannot be done via Yum. The administration console will tell you which version you are running under the Help > About menu item.

In all cases, and as with all software,it is a good idea to back up your data first. In the administration console go to Tools > Backup to download a zip file of your administration settings. For the runtime server, having your virtual infrastructure take a snapshot is recommended.

All the software is available from our service desk.


  • if your current configuration contains invalid or unresolvable metadata there may be problems after upgrade.
  • if your current publication history has any problems (e.g. cannot roll back) there will be problems after upgrade.

Upgrading from a 2.2.0 or newer version of OpenAthens LA

Basic steps in order:

Runtime server(s):

  1. Log into the server as a user with administrative permissions (e.g. 'maint') and run the yum update command.

    sudo yum update

    After checking which updates are available, the system will ask if this is ok. Enter Y to proceed.

    The command above will update the entire server.  Taking a snapshot first is recommended in case of unforeseen problems.

    To update only the OpenAthens LA packages, use the command sudo yum update openathensla-runtime.

    If you encounter any dependency errors during the upgrade, see: Updates to run on a new install on the old 2.2 base.

  2. Restart Apache plus the OpenAthens & Memcache daemons, making sure to do Apache (httpd) last. There will be messages displayed on screen between each command. These should all end in 'OK':

    sudo service openathensd restart
    sudo service memcached restart
    sudo service httpd restart

Service info: If you have load balanced runtimes and upgrade them one at a time there should be no break in service for end-users. If you use a single runtime there will be a break in service. Depending on the upgrade this could be anywhere from a few seconds whilst some services restart, to a few minutes if you need to reinstall a package. 

Administration console (Linux):

  1. Log into the server and run the yum update command.

    sudo yum update openathensla-admin

    The command above will update the entire server.  Taking a snapshot first is recommended in case of unforeseen problems.

    To update only the OpenAthens LA packages, use the command sudo yum update openathensla-admin.

  2. Restart the admin console service

    sudo service openathensla-admin restart
  3. Log into the web interface and reattach your runtime(s) after they've been updated.

  4. (Optional) download another backup of your console settings (tools menu > backup)

  5. Publish

Service info: Administrative users will lose any unsaved work. End users' sessions will not be affected. 

Administration console (Windows):

  1. Download the latest MSI installer and install over your existing instance. Depending on what has been updated, the installer may require you to un-install the existing console first or upgrade Java. Do not manually remove any files or folders from the installation directory.

  2. Restart the OpenAthensLA service via services.msc

  3. Log into the web interface and reattach your runtime(s) after they've been updated.

  4. (Optional) download another backup of your console settings (tools menu > backup)

  5. Publish

Service info: Administrative users will lose any unsaved work. End users will not be affected.


  • No labels