Issue all of the following commands in Windows using the Administrator user account. |
Install all Windows updates before commencing. |
When following the instructions given in this manual, it is advisable to type the commands manually instead of copy/pasting them. This is because sometimes characters may be lost or modified in the copying process. |
Make sure you have Java installed and JAVA_HOME set according to the Installation requirements.
Unzip the Zip archive into the C:\Program Files\Ubisecure
folder.
Right click on the file ubilogin-sso-8.x.x.xxxx.zip
and choose Extract All…
Enter the directory C:\Program Files\Ubisecure
and click Next.
Windows 2012: Open the command prompt using Run as Administrator mode. Administrative rights are required in order to install the required system services. See Figure 1.
Figure 1. Installations must use Run as administrator |
Copy the configuration template to the C:\Program Files\Ubisecure\ubilogin-sso\ubilogin
folder:
cd "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin" copy config\win32.config . |
Open win32.config
file in a text editor. Modify the public visible URL address of the Ubisecure SSO deployment, which is set with key uas.url
. The installation is accessible from the local machine only if the value is left to localhost
. The resulting line for uas.url
might look like the following:
uas.url = https://sso.example.com:8443 |
Before saving the changes modify additional Accounting Service related settings. |
Example of modified Accounting Service related settings:
accounting.url = https://manage.example.com accounting.proxy.local.url = https://localhost:8442 accounting.datasource.url = jdbc:postgresql://databasehost:5432/accountingdb accounting.datasource.username = accounting_user accounting.datasource.password = Wsop%6deE65-_ftl+tY |
Create the configuration files with the setup.cmd
script:
cd "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin" .\setup.cmd |
New LDAP passwords are generated every time the setup command is executed. For this reason, the |
Since SSO version 8.4 with Accounting Service feature access to PostgreSQL database is required for the service to run. If you have already installed Ubisecure CustomerID you can use the existing PostgreSQL installation but you need to create a specific database for this purpose. The necessary tables are automatically created during the initial startup of the Accounting Service.
See PostgreSQL preparation on Windows for more information and steps to accomplish.
Before continuing with the installation which will start the Accounting Service you need to enter and save the secret key contents in the location referred by accounting.secret-key-location
in win32.config
. See Accounting Service security about the usage of the key for pseudonymisation. The page contains a suggested script to create a secure enough secret in the default location.
You may also customise other Accounting Service configuration settings for your needs, which is recommended. See Accounting Service additional configuration about the properties to set.
When customising edit this file which is copied from the installation package by the setup script: If the file were not present copy the default file from this directory: |
Install ADAM or AD LDS as Ubisecure Directory according to your platform:
C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\ldap\adam\adaminstall.txt
Now run the adaminstall.cmd
script to automatically configure ADAM or AD LDS and start it:
cd "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\ldap\adam" .\adaminstall.cmd |
Server signing and decryption key management was updated for SSO 8.9 and the initial signing and decryption key generated during SSO setup must be imported manually in the new location in Ubilogin Directory.
|
Run the Tomcat install script to install the Ubisecure SSO Tomcat as a service. Since v. 8.4 also the Accounting Service shall be installed as such a service.
cd "C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\config\tomcat" .\install.cmd |
The install script does the following:
/accounting/config
directory.Accounting
under System
site with an OAuth 2.0 application named Accounting
. This application is needed for the secured endpoints to access Accounting Service data. The application is allowed to a group named Accounting Users
. The System Administrator
user is by default added to this group but you can configure the users otherwise once Ubisecure SSO is running, see SSO Management UI Groups.win32.config
file before continuing. see Change configuration settings during installation process in Windows. See also Troubleshooting Accounting Service.Accounting Service should always be running before SSO is started or otherwise SSO log will be filled with errors but still keeps running if there is enough disk space. SSO can recover without a restart from Accounting Service restart if necessary. |
Continue on the page Installation finalisation to verify that the installation was successful.