You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

 Table of contents


Subpages


This chapter describes how to configure Blueriq Studio before getting started.

License

Before you can start Blueriq you have to copy a valid license file into the license directory. The license file is called “license.aql”. You can find the directory here: [Blueriq installation directory]\Studio\Configuration\License.

Security and User Management

During the installation of Blueriq Studio you have chosen a security mode. This paragraph will explain how to configure each security mode.

Blueriq supports three types of security modes:

  • NTLM authentication and authorization:

The authorization and authentication is done against active directory. Active directory groups can be mapped to a Blueriq Studio role.

  • NTLM authentication and custom authorization:

The authorization and authentication is done against active directory. Each active directory user can be mapped to a Blueriq Studio role.

  • Custom Authentication:

The authorization and authentication is managed in Blueriq Studio. Users can be created in Blueriq Studio and mapped to a Blueriq Studio role.

NTLM authentication and authorization

For this security mode you have to map an active directory group to a blueriq role. To do this, go to the directory [Blueriq Installation directory]\Configuration\Security\RoleMappings\. In this directory you will find a file named RoleMappings.xml.

<?xml version="1.0"?>
  <RoleMappings>
--> <RoleMapping>
      <Group>LDAP1</Group>
      <Group>LDAP2</group>
      <UserRole>Administrator</UserRole>
    </RoleMapping> <--
 </RoleMappings>

The text between the arrows shows a role mapping. The LDAP groups LDAP1 and LDAP2 are mapped to the Administrator role in Blueriq Studio. You can change the LDAP groups to your specific groups that must have full access to Blueriq Studio.

After the installation of Blueriq Studio only the user role Administrator exists. In Blueriq Studio you can create new roles with other permissions.

To map an active directory group to a user role, copy the text between the arrows from above and paste this after the </RoleMapping>-tag. Change the group name to the active directory group that you want to map to a user role. Change the User Role name to the user role you want to map to the active directory group. You can add more groups to the same user role.

For example: In Blueriq Studio you have created a new role with the name Test1. You want to map the active directory group Blueriq2 to this role. You must have the following text in the RoleMappings.xml file:

<?xml version="1.0"?>
  <RoleMappings>
    <RoleMapping>
      <Group>Blueriq</Group>
      <UserRole>Administrator</UserRole>
    </RoleMapping>
    <RoleMapping>
      <Group>Blueriq2</Group>
      <UserRole>Test1</UserRole>
    </RoleMapping>
  </RoleMappings>

NTLM Authentication and custom Authorization

For this security mode you have to map active directory users to Blueriq roles. To do this, go to the directory [Blueriq Installation directory]\Studio\Configuration\Security\UserAccess\. In this directory you will find a file named UserAccess.xml.

<?xml version="1.0"?>
  <Users>
--> <User Name="Admin">
    <Role>Administrator</Role>
  </User> <--
</Users>

The file contains a user Admin. This user is not an active directory user. In this security mode you can only use active directory users. You have to change the name in an active directory username with the syntax <domainname>\<username>.

For example: The domain name is Blueriq and the username of the user that needs full access to Blueriq Studio is Test, you have to change Admin into Blueriq\Test. You can insert more users with the same role.

This example results in the follow text:

<?xml version="1.0"?> <Users> <User Name="Blueriq\Test"> <Role>Administrator</Role> </User> </Users>

Custom Authentication

This security mode is fully controlled in Blueriq Studio. You can login with the default credentials:

  • Username: admin
  • Password: welcome

To activate changes restart the Studio server.

Logging

If any problem occurs with authorization or authentication you can use the  audit.log to trace and find the cause.

Secure the administration page

By default the administration page is not secured, which means that any user that can access the environment on which Studio or the Runtime is located can also access the administration page. A user can download/upload the repository through the administration page, so you might want to allow only specific users to access this page.

To achieve this you have two possibilities:

  1. You can secure the administration page through Studio [editor].
  2. You can restrict the administration page to all Studio users.

IIS

First open the Internet Information Services (IIS) Manager from the Start menu on the machine where Blueriq is installed.

Browse to the administration site by expanding the tree on the left as shown below and double click Authentication.

By default IIS allows Anonymous access to the site.

Disable Anonymous Authentication and enable Basic Authentication by right clicking the appropriate authentication and choosing enable/disable.

Now when you browse to the administration page, a popup will be shown asking for credentials. But first we must specify which users and/or groups can access the administration page.

To do this, first return to the administration site and select authorization rules.

Please note: if you do not see authorization rules as shown below, you must first enable this feature in IIS.

By default all users have access.

Remove the entry allowing all users access by right-clicking on it and choosing remove. Then you can add a new Allow rule by right-clicking. Here you can specify users or groups from both the local machine or the active directory if the machine is part of a domain.

Please note that this is not related to the authentication you have chosen for the Studio. So for example you can configure the Studio with one of the NTLM modes to authenticate against active directory, while you can secure the administration page with a local user on the machine.

Studio users

Another way to restrict the administration page, is by restricting it to all Studio users. This relies on the authorization mechanism that Studio uses. To configure this, you have to change the configuration of the administration page. This can be found in the [Blueriq installation directory]\Studio\wwwroot\Administration\Web.config file.

The administration page uses a connection to the management service. This connection requires a username and password, which by default is set during the installation of Blueriq:

<managementservice>
<connection url="http://localhost:8095/Services/ManagementService" user="administrationpage" password="administrationpage"/>
</managementservice>

If the user and password in this configuration is cleared, the administration page will prompt for authorization when accessed. When the username and password of a Studio user is entered, the administration page will be shown.

Please note that the user and password tag have to exist in the configuration, so clear their values instead of removing them. Example:

<managementservice>
<connection url="http://localhost:8095/Services/ManagementService" user="" password=""/>
</managementservice>


Repository

Blueriq Studio has an internal repository. When installing Blueriq Studio a default repository is provided with an initial content to start using Blueriq Studio.

An already existing repository-backup can replace the default repository. The repository is found in the [Blueriq Installation directory]\Studio\Repository directory and is called Repository.sdf.

The Repository.sdf file contains the entire repository.

Backup the repository

A backup of the repository can be made. There are two options: the Blueriq Repository Backup tool, which can be scheduled, and download from the administration page.

Option 1: Blueriq Repository Backup Tool

  • The backup tool is included in the installation zip, call it using the following parameters:
  • Backup the repository to a backup location. This task can be automated by creating a batch file which you add to the Windows task scheduler.

Option 2: Download from the administration page

  • Open the administration page from the welcome page and open the “Repository” tab.
  • Click on “Create Backup” and save the file to a backup location.

Restore repository backup

Only backups created from the same or older versions of Blueriq Studio can be restored. If a backup of an older version is restored the repository is automatically upgraded by Blueriq Studio.

Option 1: Blueriq Repository Backup Tool

Option 2: Upload in administration page

  • Open the administration page from the Welcome page and open the “Repository” tab
  • Click on the “Browse” button near the “Upload Backup” button, browse to the backup file and click “Upload Backup”. The name for the backup file can be any name. The upload feature automatically renames the file name to Repository.sdf when it is installed on the server.

When the upload has completed all users are logged out and the system automatically refreshes. There is no need to restart the server.

Version Management

If you're going to upgrade to a Blueriq version >= 12.9 and are looking for the upgrade instructions, you can find them here.

Commit hook

The commit hook is a feature that sends an HTTP request to a configured endpoint whenever a commit is performed from within studio. This allows you to create buildpipelines that get triggered from Blueriq.

To enable this feature, add the configuration below to the studio section of the config file for Blueriq Studio (StudioService.exe.config).

<configuration>
  <studio>
    ...
	<commithook url="http://localhost:3210" />
    ...
  </studio>
</configuration>


Once you've configured the endpoint, each commit in Blueriq Studio will cause an http post request to be sent to the endpoint containing to information below.

{
  "repository": "MyRepository",
  "branch": "MyBranch",
  "tags": ["All", "Tags", "On", "The", "Branch"],
  "commitId": "d99ff38c-ac9f-4394-af79-7e1f235018c8",
  "user": "MyUserName",
  "message": "The message that was added to the commit"
}
  • No labels

Didn't find the answer you were looking for? Try the advanced search!