Installing Separate OAuth Server

The Aras OAuth server is an authorization server designed to handle the OAuth 2.0 protocol. You can install the Aras OAuth server on a different server than the Aras Innovator server which is suitable for a cluster environment.

Use the following procedure to install the OAuth server separately and then configure other Aras servers to use it:

1. Select the OAuth Server feature and click Next.

Figure 31.

The following screen appears.

Figure 32.

1. Specify the OAuth Server name, the password for the OAuth certificates and the Application Server URL.

   • OAuth Server Name: enter a name of an Aras OAuth Server instance that you want to install. It should be the name of the application installed in IIS.
   • Password for OAuth Certificates: enter a password to protect the certificate private keys. The password can only contain alphanumeric symbols (a-z, A-Z, 0-9) and any of the standard printable ASCII characters (:_#$%&<> and others). The password cannot contain spaces.
   • Application Server URL: since OAuth Server is not a standalone application and is useful only along with the Aras Innovator Server, this field allows you to specify the Application Server URL for the instance of Aras Innovator you are going to use with this OAuth Server. The Application Server URL is of the following format:

   http://<servername>/<web_alias>/Server/InnovatorServer.aspx

   Where:

   1. <servername> is the name of the server where the Innovator Server is running. For example, if running on the local machine, this is localhost
   2. <web_alias> is the name of the Aras Innovator Server Virtual Directory. This is the same Web Alias as specified in the section Server Web Alias Setup.
2. Complete the installation.

Once you have installed the OAuth Server, you will need to complete the installation of the other Application servers and specify the required information for connecting to the OAuth Server.

Install the Aras Agent Service or the Aras Innovator Server and configure them on a separately installed instance of the Aras OAuth server:

1. You should deselect the OAuth Server feature and press Next.

   

   

   Figure 33.

   The following screen appears.

   

   

   Figure 34.

2. Enter the following information:

   • External OAuth Server URL: URL used by other OAuth components to access the previously installed Aras OAuth server. The URL has the following format:

     http://<servername>/<oauth_server_name>

     where:

     • <servername>is the name of the server where the OAuth server is running. The name of the server should be accessible from the external host, so “localhost” and other loopback addresses are not appropriate for servername.
     • <oauth_server_name>is the name of the Aras OAuth Server Virtual Directory. This is the same OAuth Server Name that you specified in the previous screen.
   • Password for OAuth Certificates: enter the password to access private certificates (.pfx) from the Local Path for Certificates folder.
   • Local Path for Certificates Folder: the full local path to the OAuth Certificate folder or to a copy of this folder where OAuth certificates were generated during the separate installation of the OAuth Server. The certificate folder must contain all the necessary certificates before this installation.
3. You may check Configure OAuth componentslater manually and continue with the installation. This will require changing the OAuth.config files and deploying certificates manually.