How to manually configure Dashboard Server Azure Edition
If the user who installs Azure Edition is not able to run the Dashboard Server setup wizard, i.e. is not an Azure global admin, then the steps in this article allow a user with the correct permissions to manually configure Azure Edition in the Azure Active Directory (AAD).
Before configuring Azure Edition
Azure Edition can either be deployed from the Azure Marketplace, or installed using the downloadable installer. Please ensure Azure Edition has been installed using your preferred method before continuing to manually configure Azure Edition.
How to deploy Dashboard Server Azure Edition from the Azure Marketplace
How to install Dashboard Server Azure Edition using the installer
A note to global admins
You may have been referred to these instructions by someone who did not have the permissions required to complete the Dashboard Server setup wizard themselves. As a global administrator you should have the needed permissions to run the Dashboard Server setup wizard. Using the wizard is usually the quickest and easiest way to configure Azure Edition.
The Dashboard Server setup wizard
The Dashboard Server setup wizard runs when you access Dashboard Server.
How to access Dashboard Server
If you used the downloadable installer to install Dashboard Server:
By default, the URL to your Dashboard Server instance is: http://SquaredUpServer/SquaredUpInstance
SquaredUpServer
is the name of the server where Dashboard Server is installed.
By default, SquaredUpInstance
for version 5 is SquaredUpv5
SquaredUpv4
If you deployed Dashboard Server from the Azure Marketplace:
The URL is https://DNSName
of the virtual machine (VM) deployed.
How to configure Dashboard Server using the Dashboard Server setup wizard
You can see step by step guidance for running through the Dashboard Server Azure Edition setup wizard here:
How to deploy Dashboard Server Azure Edition from the Azure Marketplace
How to install Dashboard Server Azure Edition using the installer
Don't forget the next steps after completing the Dashboard Server setup wizard:
- Take a look at the Dashboard Server v5 playlist on YouTube.
- Manage which users can access Dashboard Server: How to manage Named Users
- Set up a Dashboard Server administrator(s). To manage Dashboard Server you will need to be a Dashboard Server administrator, see How to make a user a Dashboard Server administrator
- Give dashboard authors permission to create dashboards. A Dashboard Server administrator will need to give users or groups author permission to a Team Folder, within which they can create and edit dashboards. See Team Folders
- Get access to your API data: How to add a Web API provider
- Configure Open Access dashboards. Open Access enables easy sharing of dashboards, that do not require authentication to view. See Sharing Dashboards with anyone - Open Access
- Create your first dashboard: How to create a dashboard
If you are able to complete the Dashboard Server setup wizard you need go no further with this article. If you prefer to carry out the configuration manually please continue with this article.
Manually create the AD Application
- In the Azure portal create a new application in Azure AD via Azure Active Directory > App Registrations- > New Registration
- Enter any name for the application.
- Enter the redirect URI for your Dashboard Server instance - it must end with a slash, e.g. https://myserver/squaredupv5/
- Click Register.
- Configure the token authentication options by clicking Authentication (under Manage).
- Under Implicit grant, check the ID tokens box, and click the Save button at the top.
- Configure the permissions for the application by clicking API Permissions (under Manage).
Click Add a permission > Microsoft Graph > Delegated permissions and add the following permissions:
- Directory.Read.All
- Group.Read.All
- User.Read
- User.ReadBasic.All
- Click Add permissions.
- Click Add a permission > Azure Service Management > Delegated permissions and add the following permissions:
- user\impersonation_
- Click Add permissions.
- To enable AAD non-administrators to login, click the Grant admin consent for XXX button, and click Yes.
- Create a client secret via Certificates & secrets (under Manage).
- Click New client secret, provide a name and an appropriate expiry.
- Copy and save the displayed secret value. You will need this later for
client-secret
. - Add the application roles via Manifest (under Manage)
Replace
Copy"appRoles": [],
with
Copy"appRoles": [
{
"allowedMemberTypes": [
"User"
],
"description": "Default SquaredUp User",
"displayName": "DefaultUser",
"id": "6dff721d-651b-4a79-b5c5-ac66839a3130",
"isEnabled": true,
"lang": null,
"origin": "Application",
"value": "DefaultUser"
},
{
"allowedMemberTypes": [
"User"
],
"description": "SquaredUp Administrator",
"displayName": "SquaredUpAdministrator",
"id": "1da1031d-cce9-4c98-8d39-5d39d3ad2fab",
"isEnabled": true,
"lang": null,
"origin": "Application",
"value": "SquaredUpAdministrator"
}
],- Click the Save button at the top.
- From the Overview blade, copy and save the Application (client) ID and the Directory (tenant) ID. You will need these later for
client-id
andtenant-id
.
Add a user as an administrator
Only Dashboard Server administrators can manage Dashboard Server, which includes the following tasks:
Create, edit, and delete dashboards
Create or delete Team Folders
Add new PowerShell profiles and integrations (such as Web API, ServiceNow, Azure Application Insights, etc.)
Edit the global dashboard navigation structure
See How to make a user a Dashboard Server administrator
Configure Dashboard Server to use the application
If you are not the person who installed Dashboard Server Azure Edition then you can now pass them the client-id
and client-secret
and they can complete the rest of this article.
You will need to connect to your SquaredUp server (How to connect to your SquaredUp server).
- On the SquaredUp server, run Notepad as administrator (Start, Run, type
notepad
, and then right-click and select Run as administrator). Open the following file from the Dashboard Server folder:
...\User\Configuration\openid.json
Where to find the Dashboard Server folderName of the Dashboard Server folder
The name of the Dashboard Server folder is
SquaredUpv
followed by theproduct version number
.Location of the Dashboard Server folder
If you deployed Dashboard Server via the Azure Marketplace :The default location for the Dashboard Server folder is
F:\
.SquaredUpv[Version Number]
For example, for Dashboard Server Azure Edition v5 the default location isF:\SquaredUpv5
and for v4 .F:\SquaredUpv4
If you installed Dashboard Server using the installer:
The default location for the Dashboard Server folder is
C:\inetpub\wwwroot\SquaredUpv[Version Number]
, but a custom location may have been chosen during the installation.
For example, for Dashboard Server v5 the default folder location isC:\inetpub\wwwroot\SquaredUpv5
and for v4 C:\inetpub\wwwroot\SquaredUpv4
The file will contain four properties:
Copy{
"tenant-id": "",
"client-id": "",
"client-secret": "",
"redirect-uri": ""
}Add the property values.
Use the details noted above for
tenant-id
,client-id
, andclient-secret
.The
redirect-uri
is the URL you use for accessing Dashboard Server.For an Azure Marketplace deployment it may look similar to this
https://squaredupserver.eastus2.cloudapp.azure.com/
.For an install using the downloadable installer the default is to append the server fully qualified domain name (FQDN) with
/squaredupv5/
, e.g.https://squaredupserver.mydomain.net/squaredupv5/
, but this may have been customized during the installation.Your completed file will look something like this:
Copy{
"tenant-id": "a1b23c4f-5de0-6ab7-8cde-9012345a678b",
"client-id": "12a34b5c-d67e-89ab-c0d1-2345ea5bf78c",
"client-secret": "1a234bc5fdea92ef8a391030bbfb66c40bd0c0bff4e3afe2ec1e68926b25a0554d65ed044b427a01dfca4a0588f6540eb",
"redirect-uri": "https://squaredup1.eastus2.cloudapp.azure.com/"
}- Save the file.
- In IIS recycle the Dashboard Server application pool for the setting to take effect (How to check and modify the application pool identity).
- Browse to Dashboard Server using the
redirect-uri
specified. You will be prompted to login.