How to use this documentation

Welcome to the OpenAthens Local Authentication (LA) homepage. Here you will find the list of contents for the OpenAthens LA installation and configuration documentation. At the bottom-right of every page within the documentation you will find a link back to this page (called 'OpenAthens LA Home'), which you should use if you become lost during the recommended navigation process. We do not recommend using the Contents as a means of navigating the documentation - please only link back to this page if you need to retrace your steps whilst following the recommended navigation procedure (as described in the OpenAthens LA - an introduction documentation).

PLEASE CHOOSE FROM THE FOLLOWING OPTIONS:

I would like to get started. Please take me to the OpenAthens LA - an introduction documentation

I would like to see the latest OpenAthens LA release notes

I already have OpenAthens LA installed and need to reference some advanced settings

Contents

Introductory and pre-installation pages

OpenAthens LA - an introduction

Preparations for installing OpenAthens LA – administrative

Preparations for installing OpenAthens LA – technical

Upgrading from earlier versions

Runtime installation - pre-built virtual images

Installing the OpenAthens LA Runtime using our pre-built virtual machine images

Configuring your network settings for the Runtime using a pre-built virtual machine image

Ensuring the Runtime software is up to date using a pre-built virtual machine image

Ensuring the server clock is correct when using a pre-built virtual machine image

Obtaining an SSL certificate for the Runtime when using a pre-built virtual machine image

Creating a self-signed SSL certificate for the Runtime when using a pre-built virtual machine image

Configuring HTTPS for the Runtime when using a pre-built virtual machine image

Runtime installation - physical or pre-existing virtual machine

Installing OpenAthens LA on a physical or existing virtual machine – repository preparation

Installing the Runtime on a physical or existing virtual machine

Configuring your network settings for the Runtime on a physical or existing virtual machine

Ensuring the server clock is correct on a physical or existing virtual machine

 Securing the Runtime on a physical or existing virtual machine

  Obtaining an SSL certificate for the Runtime on a physical or existing virtual machine

Creating a self-signed certificate for the Runtime on a physical or existing virtual machine

Configuring HTTPS for the Runtime on a physical or existing virtual machine

Administration Console - pre-built virtual machine images

Installing the OpenAthens LA Administration Console using our pre-built virtual machine images

Configuring your network settings for the Administration Console on a pre-built virtual machine image

Securing the Administration Console on a pre-built virtual machine image

Updating the Administration Console on a pre-built virtual machine image

Testing access to the Administration Console

Setting up the Administration Console

Connecting the Administration Console with Active Directory

Creating a simple authentication provider from a pre-built virtual machine installation

Connecting the Administration Console to the Runtime from a pre-built virtual machine installation

Administration Console - physical or existing virtual machines running CentOS or Red Hat

Installing the Administration Console on a physical or existing virtual machine using Cent OS or Red Hat

Configuring your network settings for the Administration Console on a Cent OS or Red Hat operating system

Updating the Administration Console on a Cent OS or Red Hat operating system

Securing your Administration Console on a Cent OS or Red Hat operating system

Testing access to the Administration Console using a Cent OS or Red Hat operating system

Setting up the Administration Console from a Cent OS or Red Hat installation

Connecting the Administration Console with Active Directory on a physical or existing virtual machine

 Creating a simple authentication provider for a physical or existing virtual machine installation

Creating a configuration for a physical or existing virtual machine installation

 Connecting your Administration Console to the Runtime from a physical or existing virtual machine installation

Administration Console - machines running Windows

Installing the OpenAthens LA Administration Console on Windows

Updating the Administration Console on Windows

Securing your Administration Console on a Windows server

Testing the Administration Console from a Windows installation’ documentation

Setting up the Administration Console from a physical or existing virtual machine installation

Connecting the Administration Console with Active Directory on a physical or existing virtual machine

 Creating a simple authentication provider for a physical or existing virtual machine installation

Creating a configuration for a physical or existing virtual machine installation

 Connecting your Administration Console to the Runtime from a physical or existing virtual machine installation

Federations and federated access management

Federations and federated access management

Connecting your OpenAthens LA system to a federation

Proxy module - same machine as Runtime using pre-built virtual machine image

Proxy module considerations

Setting up the proxy module configuration when the proxy is to be on the same machine as the Runtime

Updating the proxy software when it is on the same machine as your Runtime

Obtaining a wildcard SSL certificate when the proxy is on the same machine as your Runtime

Creating a self-signed Wildcard SSL certificate for the proxy server

Configuring HTTPS for the proxy module

Setting up the proxy site(s)

Proxy module - different machine to Runtime using pre-built virtual machine image

Installing the proxy module on a different machine to your Runtime Identity Provider using pre-built VM images

Connecting your Administration Console to the proxy module when a proxy is on a different machine to the Runtime

Updating the proxy software

Obtaining a wildcard SSL certificate for the proxy module

Creating a self-signed Wildcard SSL certificate for the proxy server

Configuring HTTPS for the proxy

Ensuring the proxy server clock is correct

Setting up the proxy site

Proxy module - different machine to Runtime using a physical or existing virtual machine

Installing the proxy module on a different machine to your Runtime using a physical or existing virtual machine

Connecting your Administration Console to the proxy module when the proxy is on a different (physical or existing virtual) machine to the Runtime’

Updating the proxy software

Obtaining a wildcard SSL certificate for the proxy module

Creating a self-signed Wildcard SSL certificate for the proxy server

Configuring HTTPS for the proxy

Ensuring the proxy server clock is correct

Setting up the proxy site

Using the OpenAthens Gateway with OpenAthens LA 

Accessing the OpenAthens Gateway using OpenAthens LA - Terminology

Accessing the OpenAthens Gateway using OpenAthens LA – introduction and registration

Adding OpenAthens metadata to the OpenAthens Gateway

Creating permission sets for the OpenAthens Gateway

Configuring permission sets in the Administration Console

Creating a test end-user for accessing MyAthens via the OpenAthens Gateway

Testing end-user access to resources available through the OpenAthens Gateway via MyAthens

Kerberos integration using OpenAthens LA

Integrating OpenAthens LA with Kerberos - an overview

Setting up OpenAthens LA to delegate authentication

 Post-installation and configuration

Administration Console navigation – an overview

Keeping the Runtime up to date on a pre-built virtual machine image

Keeping the Runtime up to date on a physical or existing virtual machine

Keeping the Administration Console up to date on a pre-built virtual machine image

Keeping the Administration Console up to date on a physical or existing virtual machine running CentOS or Red Hat

Keeping the Administration Console up to date on a physical or existing virtual machine running Windows

Complete these tasks to get started

• Edit this home page - Click Edit in the top right of this screen to customize your Space home page
• Create your first page - Click the Create button in the header to get started
• Brand your Space - Click Configure Sidebar in the left panel to update space details and logo
• Set permissions - Click Space Tools in the left sidebar to update permissions and give others access