Installation

Installation

 Stop Server

First open the IIS-Manager on Microsoft Server.
 
 
Click on 'aquaAPIPool' and stop it with the button on the right side first.
After that please stop 'aquaFileServerPool', 'aquaWebservicePool' and 'aquaWebNGAppPool'.
Your Server is stopped now.
 

2. Configuration

2.1 Add Service Provider to your SAML instance
In order to be able to redirect to aqua after successful SAML-Login, it is required to add aqua as a Service Provider to your SAML-instance. Please ask your SAML-Administrator or check the User Manual of your SAML server if you do not know how to do it for your SAML server.
Please find below the proper URLs of aqua for configuring your SAML instance. AssertionConsumerService is an obligatory parameter for SAML so that SAML knows the location for redirect after successful login. SingleLogoutService is optional and only needed if you want SAML to be able to logout a given user from aqua.
 
AssertionConsumerService
http(s)://<aquawebServerUrl>/aquawebng/Account/saml2-acs
SingleLogoutService
http(s)://<aquawebServerUrl>/aquawebng/Account/saml2-logout
 
Furthermore, please download and save the IdP metadata file of your SAML instance to a local folder on aqua Backend server and aqua Web server. It will be required for configuring aqua Backend and aqua Web. A sample of an IdP-metadata file can be found here.
 
2.2 Configure Backend
Open Web.config file of aqua Backend. It is usually located here:
C:\Program Files\andagon GmbH\aqua For IIS\Web\Webservice
Please add the following settings to <appSettings> section:
SAML.FederationMetadataPath
Path to IdP-metadata file that must be retrieved from your SAML instance (the metadata-file specifies important properties of your SAML-IdP, e.g. the SingleSignOnService or Certificates)
SAML.UsernameAttribute
Defines the attribute of the SAML response that provides the aqua username (see Section 2.2 for an example where to find this attribute, “uid” is just an example)
Example:
  ...
  <appSettings>
    ...
    <add key="SAML.FederationMetadataPath" value="C:\Path\to\saml-idp-metadata.xml" />
    <add key="SAML.UsernameAttribute" value="uid" />
    ...
  </appSettings>
  ...
 
Save and close Web.config
 
2.3 Configure aqua Web
Open aquaWebNG.config file of aqua Web. It is usually located here:
C:\Program Files\andagon GmbH\aquaWebNG\aquaWebNG
Please add the following settings to <aquaWebNGConfig> section:
SAML.FederationMetadataPath
Path to IdP-metadata file that must be retrieved from your SAML instance (the metadata-file specifies important properties of your SAML-IdP, e.g. the SingleSignOnService or Certificates)
SAML.AquaSPEntityId
Defines the service provider’s entity ID on your SAML instance
Example:
  ...
  <aquaWebNGConfig>
    ...
    <add key="SAML.FederationMetadataPath" value="C:\Path\to\saml-idp-metadata.xml" />
    <add key="SAML.AquaSPEntityId" value="aqua-saml-sp" />
    ...
  </aquaWebNGConfig>
  ...
 
 

3 Start aqua Server

After configuration, you can start your aqua server. Go back to IIS-Manager and start 'aquaAPIPool', 'aquaFileServerPool', 'aquaWebservicePool' and 'aquaWebNGAppPool'.
 

    • Related Articles

    • Web Client Installation

      In order to install the aqua web client you need the following file: aquaWebNG-"your version"-Installer.exe To start the installation double-click the file and click next: After the installation a link to the web client will be available on the aqua ...

    • Login Issues after Initial Installation

      If your initial installation was successful, but you are not able to login to aqua, please try the following credentials:   Username start Password default

    • Installation

      You can find and install the plugin directly from within Jira in the Apps section. Just search for the keyword 'aqua'.   You can optionally also download the plugin from the Atlassian store using the following link and then upload it to your Jira ...

    • Server Installation

      Please make sure, that you have all files available to install your aqua server. 123   1. aqua for IIS Installer.msi 2. license.lic   First, you must to install the aqua for IIS Installer.msi on the Microsoft Windows server. In order to do so, double ...

    • Getting Agents

      The aqua Server contains a landing page, where you can find all clients, agents and connectors as well as a link to the web client. You can access this page via  the following URL    http(s)://<yourAquaServerURLorIP>   or in the following server path ...