Setup Webservices

Requirements

Installation Requirements

• Windows Server 2016 or later is required
• Microsoft SQL Server 2016 or later
  • SQL Server Express can be installed during the main installation.
  • A database must already be created.
  • A user with DB Owner permissions on that database is required.
• Alias or (sub)domain for the server.
• Trusted SSL certificate for the alias or (sub)domain:
  • Must meet current security standards.
  • Should be installed in the Windows Certificate Store.
• Accurate server time configuration (using NTP is recommended).
• IIS installation with the Default Website accessible via HTTPS:
  • Setup via HTTP is not supported.
• TURN/STUN server may be required for BBV, depending on your local network.
• Keycloak 25.x Server must be pre-installed:
  • Refer to the [Keycloak Installation Guide] if needed.

Installation

We recommend using a guided installation with CAXperts for UPV Webservices. Please contact support@caxperts.com for information

In case an SQL Server is available deselect the SQL Server Express Installation. It is also possible to use an SQLite database but this is discouradged. Click afterwards on Next.

Click on Next.

For installation you need to accept the EULA and click Next.

Chose a suitable installation path and click on Next.

Select which type of Database you want to use. If you have SQL Server or SQL Server Express installed selected Microsoft SQL Server and click Next.

Enter the Licensekey provided to you and a client description and click on Next.

Choose an existing IIS website or create a new one. In most cases using the default website is recommended. Click on Next.

The only setting that needs to be changed is the Hostname. This should be https://<alias/(sub)domain>/UpvWebServices.

If you intend to use Browser based viewing you need to enter a shared secred that is used between the Renderserver(s) and the Web Service. Enter this shared secret into Aignaling API Credentials.

Depending on if you use Browser Based Viewing and a TURN or STUN server you need to configure it in here

Configure the SQL Server connection. Enter the server address, the superadmin username and password

Dont deploy example Data

To start the installation click on Install

After the installation is finished click on Finish

Accessing Webservices

Goto the keycloak installation and update the defaultadmin password in the realm you specified Goto https://<alias/(sub)domain>/UpvWebServices and login via defaultadmin and your defined password

You can add additional users via the webinterface or link to a SSO provider.

Security

As with every web server, we recommend to keep it updated with the newest security fixes.

Switch of “outdated/unsecure” protocols legacy TLS