Jump to: navigation, search

Difference between revisions of "HowTo:Install UBIK Web Service"

 
(38 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Prior to the installation of an {{UBIK}} Web Service make sure to have a [http://www.iis.net/ Microsoft Internet Information Server (IIS)] available and configured accordingly. If not read the instructions how to [[Install_Microsoft_IIS|install]] and [[Configure_Microsoft_IIS_for_UBIK|configure]] an IIS for {{UBIK}}.
+
Prior to the installation of an {{UBIK Web Service}} make sure to have a [http://www.iis.net/ Microsoft Internet Information Server (IIS)] available and configured accordingly. If not read the instructions how to [[HowTo:Install_Microsoft_IIS|install]] and [[HowTo:Configure_Microsoft_IIS_for_UBIK|configure]] an IIS for {{UBIK}}.
  
−
== Installing {{UBIK}} Content Web Service ==
+
== {{UBIK}} Content Web Service ''UBIKContent.svc'' ==
−
# Creating a new directory in the ''wwwroot'' directory of the IIS installation (default: c:\inetpub\wwwroot)
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
−
# Copying the components of the {{UBIK}} Web Service into the (new) directory
+
# Copy the components of the {{UBIK}} Web Service into the (new) directory
−
# [[UBIK_Web_Service_Configuration|Configure]] the web service by changing parameters in the ''web.config'' file
+
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
−
# Create a new web applicaton as described [[UBIK_Web_Service#Create_new_Web_Application|here]]
+
# [[Web_Service_Configuration|Configure]] the authentication mode of the web service using either
 +
#* [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]] or
 +
#* [[HowTo:Configure_LAS_Authentication|Local]] or [[HowTo:Configure_LAS_Authentication|Global Application Service]]
  
−
== Installing {{UBIK}} Authentication Web Service ==
+
== {{UBIK}} Authentication Web Service ''USAM.svc''==
 +
If authentication should happen via a distinctive [[USAM]] web service
 +
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
 +
# Copy the components of the {{UBIK}} Web Service into the (new) directory
 +
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
 +
# [[Web_Service_Configuration|Configure]] the authentication mode of the USAM web service using [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]]
  
−
== Configuration of the Web Server ==
+
== {{UBIK}} Push Web Service ''UBIKPush.svc'' ==
−
The web server can be configured using the ''Internet Information Services (IIS) Manager'' console, which gets installed automatically. The console provides a graphical user interface to manage and configure the web server accordingly to the {{UBIK}} web service.
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
−
 
+
# Copy the components of the {{UBIK}} Web Service into the (new) directory
−
<gallery widths="400" heights="400" >
+
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
−
File:UI_10_IIS_Manager.png|1 - IIS Manager
+
# [[Web_Service_Configuration|Configure]] the authentication mode of the web service using either
−
</gallery>
+
#* [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]] or
−
 
+
#* [[HowTo:Configure_LAS_Authentication|Local]] or [[HowTo:Configure_LAS_Authentication|Global Application Service]]
−
=== Add Application Pool ===
+
−
An application pool is a group of one or more URLs that are served by a worker process or a set of worker processes. Application pools set boundaries for the applications they contain, which means that any applications that are running outside a given application pool cannot affect the applications in the application pool.
+
−
 
+
−
<gallery widths="400" heights="400" >
+
−
File:UI Application Pool.01.png|1 - Application Pool
+
−
File:UI Application Pool.02.png|2 - Application Pool
+
−
File:UI Application Pool.03.png|3 - Application Pool
+
−
</gallery>
+
−
 
+
−
=== Certificate ===
+
−
The web service communicates with the {{UBIK}} client via an secured connection, which requires a SSL certificate on the server and client side. Use a public key certificate from a certificate authority or a self-signed certificate, both will work for {{UBIK}}. A new self-signed certificate can be created in the ''Internet Information Server (IIS) Manager'', exported using the export function and sent to the development team. As already mentioned, the client has to know this certificate as well, hence it need to be integrated it into the mobile application.
+
−
 
+
−
{{Attention|{{UBIK}} requires a valid certificate for SSL encryption!}}
+
−
 
+
−
<gallery widths="400" heights="400" >
+
−
File:UI Certificate.01.png|1 - IIS Configuration
+
−
File:UI Certificate.02.png|2 - Installed certificates
+
−
File:UI Certificate.03.png|3 - Create self-signed certificate
+
−
File:UI Certificate.05.png|4 - Import certificate
+
−
File:UI Certificate.04.png|5 - Installed certificates
+
−
</gallery>
+
−
 
+
−
=== Bindings ===
+
−
Web sites and services have something called ''Server Bindings'' which represent the underlying address, port, and potentially a host header that the website is accessed using. The {{UBIK}} client accesses the web service via a secured port (https), where it is necessary to configure the appropriate certificate.
+
−
 
+
−
====For Android Clients====
+
−
<gallery widths="400" heights="400" >
+
−
File:UI Binding.01.png|1 - Binding
+
−
File:UI Binding.02.png|2 - Binding
+
−
File:UI Binding.03.png|3 - Binding
+
−
File:UI Binding.04.png|4 - Binding
+
−
</gallery>
+
−
 
+
−
====For Windows 8.1 Clients====
+
−
<gallery widths="400" heights="400" >
+
−
File:UI Binding.01.png|1 - Binding
+
−
File:UI_Binding_Win8.02.png|2 - Binding
+
−
File:UI_Binding_Win8.01.png|3 - Binding
+
−
File:UI_Binding_Win8.02.png|4 - Binding
+
−
</gallery>
+
−
 
+
−
=== Create new Web Application ===
+
−
In the ''IIS Manager'' expand the ''Default Web Site'' node and navigate through the folder structure to the folder containing the {{UBIK}} web service components.
+
−
 
+
−
<gallery widths="400" heights="400" >
+
−
File:UI New Service.01.png|1 - New Service
+
−
File:UI_New Service.02.png‎|2 - New Service
+
−
File:UI_New Service.03.png‎|3 - New Service
+
−
File:UI_New Service.04.png‎|4 - New Service
+
−
File:UI_New Service.05.png‎|5 - New Service
+
−
File:UI_New Service.06.png‎|6 - New Service
+
−
File:UI_New Service.07.png|7 - New Service
+
−
File:UI_New Service.08.png|8 - New Service
+
−
File:UI_New Service.09.png|9 - New Service
+
−
</gallery>
+
−
 
+
−
=== Optional: Local IIS User ===
+
−
Create and use a local user on the web server if no appropriate domain-user is available.
+
−
 
+
−
<gallery widths="400" heights="400" >
+
−
File:UI_Local_IIS_user.01.png|1 - Local IIS-user
+
−
File:UI_Local_IIS_user.02.png‎|2 - Local IIS-user
+
−
File:UI_Local_IIS_user.03.png‎|3 - Local IIS-user
+
−
File:UI_Local_IIS_user.04.png‎|4 - Local IIS-user
+
−
File:UI_Local_IIS_user.05.png‎|5 - Local IIS-user
+
−
File:UI_Local_IIS_user.06.png‎|6 - Local IIS-user
+
−
File:UI_Local_IIS_user.07.png|7 - Local IIS-user
+
−
File:UI_Local_IIS_user.08.png‎|8 - Local IIS-user
+
−
File:UI_Local_IIS_user.09.png‎|9 - Local IIS-user
+
−
</gallery>
+
−
 
+
−
== Additional prerequisites ==
+
−
* Ensure that the service ports are not blocked by a firewall.
+
−
* Ensure that port forwarding is established if needed (e.g. for Microsoft Azure Virtual Computers or servers behind a gateway)
+
−
 
+
−
== Testing the Web Service ==
+
−
Test the web service by entering the following URL in a browser:
+
−
<code>
+
−
https://<SERVER-IP>/<PATH-TO-UBIK-WEBSERVICE>/UBIKContent.svc/GetVersion
+
−
</code>
+
  
 
== See also ==
 
== See also ==
−
* [[Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
+
* [[Web_Service_Configuration|Web Service Configuration]]
−
* [[UBIK_Web_Service_Configuration|{{UBIK}} Web Service Configuration]]
+
* [[HowTo:Install Microsoft IIS]]
−
* [[Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
+
* [[HowTo:Configure_Microsoft_IIS_for_UBIK]]
 +
* [[USAM]]
  
−
[[Category:UBIK Web Service]]
+
[[Category:How-To|Install UBIK Web Service]]
−
[[Category:Installing]]
+
[[Category:Web service|Install UBIK Web Service]]

Latest revision as of 09:49, 4 August 2015

Prior to the installation of an UBIK® Web Service make sure to have a Microsoft Internet Information Server (IIS) available and configured accordingly. If not read the instructions how to install and configure an IIS for UBIK®.

UBIK® Content Web Service UBIKContent.svc

  1. Create a new directory in the wwwroot directory of the IIS installation (default: c:\inetpub\wwwroot)
  2. Copy the components of the UBIK® Web Service into the (new) directory
  3. Create a new web applicaton as described here
  4. Configure the authentication mode of the web service using either

UBIK® Authentication Web Service USAM.svc

If authentication should happen via a distinctive USAM web service

  1. Create a new directory in the wwwroot directory of the IIS installation (default: c:\inetpub\wwwroot)
  2. Copy the components of the UBIK® Web Service into the (new) directory
  3. Create a new web applicaton as described here
  4. Configure the authentication mode of the USAM web service using Single Local Application

UBIK® Push Web Service UBIKPush.svc

  1. Create a new directory in the wwwroot directory of the IIS installation (default: c:\inetpub\wwwroot)
  2. Copy the components of the UBIK® Web Service into the (new) directory
  3. Create a new web applicaton as described here
  4. Configure the authentication mode of the web service using either

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=HowTo:Install_UBIK_Web_Service&oldid=17031"