Installation of OneSpan User Websites on Microsoft Windows

OneSpan User Websites can be installed and automatically configured with the provided setup package, i.e. the OneSpan User Websites Setup (Microsoft Installer package, .msi).

The OneSpan User Websites Setup includes an embedded Apache Tomcat web server. If you want to use an existing web server, you need to deploy OneSpan User Websites manually (see Deploy and configure OneSpan User Websites manually (Optional)).

OneSpan User Websites can be installed with the following options:

  • Local. OneSpan User Websites and OneSpan Authentication Server are installed on the same server.
  • Remote. OneSpan User Websites is installed and deployed standalone, i.e. OneSpan Authentication Server and OneSpan User Websites are installed on separate servers.

Before you begin

  • Ensure that you have successfully installed OneSpan Authentication Server.
  • Ensure that at least one of the default ports used by Apache Tomcat is not used by another program, i.e. port 8443 or 9443. The setup package tests if the ports are in use and automatically binds Apache Tomcat to the first unused port.
  • Ensure that you are logged on with a user account that has sufficient administration privileges on the machine to run the installation.

Installation of OneSpan User Websites on Microsoft Windows

To install OneSpan User Websites on Microsoft Windows (locally)

  1. Insert the OneSpan Authentication Server product CD and change to the following folder: cd_drive\OneSpan User Websites\Software\Windows.
  2. Launch the OneSpan User Websites Setup (onespan-user-websites_3.25.0_x64.msi).

    1. Click Next to begin.
    2. Read the OneSpan User Websites license agreement, select I accept the terms in the license agreement, and click Next.
    3. (OPTIONAL) Specify the destination folder.

      The default destination folder is %PROGRAMFILES%\OneSpan\User Websites.

    4. Select the program features that you want to install (see OneSpan User Websites program features).

      OneSpan User Websites program features
      Feature name Description
      Java Runtime Environment

      Required. Installs an embedded version of Java Runtime Environment (Azul Zulu), required by Apache Tomcat and the OneSpan Web Configuration Tool.

      Apache Tomcat Required. Installs an embedded version of the Apache Tomcat web server, required by the websites.
      OneSpan Web Configuration Tool Required. Installs the OneSpan Web Configuration Tool.
      Virtual Mobile Authenticator OTP Request Website

      Optional. Installs the Virtual Mobile Authenticator OTP Request Website.

      At least one website must be installed.

      User Self-Management Website

      Optional. Installs the User Self-Management Website.

      At least one website must be installed.

    5. Click Install to start the installation.

      OneSpan User Websites is being installed. If OneSpan Authentication Server has already been installed, OneSpan User Websites is configured to use the local OneSpan Authentication Server instance automatically. If OneSpan Authentication Server has not been installed, OneSpan User Websites remains unconfigured and you need to configure it manually (see Additional tasks).

    6. Click Finish to close the OneSpan User Websites Setup.

To install OneSpan User Websites on Microsoft Windows (remotely)

  1. On the remote server, open a Command Prompt window.
  2. Change to the folder on the product CD where the OneSpan User Websites Setup is located, i.e. cd_drive\OneSpan User Websites\Software\Windows.
  3. Type the following command:

    msiexec /i onespan-user-websites_3.25.0_x64.msi SERVER_LOCATION=server_location SERVER_PORT=server_port

    where:

    • server_location is the server name or IP address of the OneSpan Authentication Server instance.
    • server_port is the server port of the OneSpan Authentication Server instance, usually 8888.

    OneSpan User Websites is installed with the specified server parameters to configure the connection to the OneSpan Authentication Server instance.

    If a connection to the OneSpan Authentication Server instance cannot be established, OneSpan User Websites is installed but not configured.

Additional tasks

If the OneSpan User Websites Setup does not detect OneSpan Authentication Server, OneSpan User Websites is not configured. If you install OneSpan Authentication Server on the same computer later, you need to configure OneSpan User Websites after the installation manually.

To configure OneSpan User Websites manually

  1. Open a Command Prompt window and change to the OneSpan User Websites installation folder, by default %PROGRAMFILES%\OneSpan\User Websites.
  2. Run the following command:

    admintool type website autoadd nameurl

    where:

    • website is the website to configure, i.e. selfmgmt for User Self-Management Website and votp for Virtual Mobile Authenticator OTP Request Website. If you deploy both websites, you need to run the command twice with different parameters for type.
    • name is the parameter to set an instance of OneSpan Authentication Server as primary or backup server. Possible values are primary or backup.
    • url is the IP address including the SOAP port of the OneSpan Authentication Server instance in URL format, e.g. https://10.2.2.15:8888.

A server record for OneSpan Authentication Server is created. Any available SSL certificates are added to the OneSpan User Websites trust store.

Next steps

  • If required, verify and perform any post-installation task that is necessary to complete the installation.