KanBo Installation on Office 365 and Azure (Manual)

Table of Contents

Introduction

1. Purpose

Installing KanBo as Office 365 Groups Extension lets you integrate KanBo deeper with Microsoft Teams (Groups), Outlook (Groups) and Yammer (Groups). KanBo will use the same Documents as the Group and vice versa and KanBo will inherit the User Management from the Office Group the KanBo Board is attached to.

2. Prerequisites

  1. KanBo installation package and KanBo.JobHost package
  2. Microsoft 365 Business Basic environment (or a higher version) and administrator access to it
  3. Administrator access to the Azure portal
  4. One SQL Database
  5. Having a custom domain and SSL certificate for your KanBo Web App
  6. An Elastic Search instance on Your Azure

You need the Setup role to make this action.

Create the hosting site

1. Creating a Web App

  1. To create a Web App, go to this page.
  2. Click on the “Create” button.

Please follow these steps:

  1. Choose your Subscription.
  2. Choose Your Resource Group (we recommend creating a new one named "Kanbo").
  3. Provide the name URL of your site, in our case, it will be "kanboinstallation". Leave the publish on "Code".
  4. Choose the closest region.
  5. Choose Your Windows Plan and resize it to at least B1.

  1. After that is done, click "Review + create" and create the Web App.


2. Configuring a Custom Domain and SSL certificate for Web App

For this integration, you must have a custom domain attached to your KanBo. It's not possible to run it on default *.azurewebsites.net address.

To attach a custom domain:
– Map an existing custom DNS name to Azure Web App
– Bind an existing custom SSL certificate to Azure Web Apps

Follow the Microsoft Technet manuals above to set a custom domain and a SSL certificate to the Web App.

3. Configuring the new Web App

After the page has been created, we need to change some settings.

  1. Go back to the "App Services" page and search for your application.
  2. Click on your page to navigate to its options.

  1. After the page has loaded, scroll the menu down and click on the "Configuration" and then General Settings.

You will see the configuration screen.

  1. Make sure the Web Sockets option is on and the platform is set to 64-bit. Save your changes.


4. Creating an SQL database

  1. Enter the link to create an SQL Database.
  2. Click on Create and follow these steps:
    • Choose the same Subscription and Resource Group as Your KanBo Service.
    • Choose the name for the database
    • Choose the Database server (we recommend creating a new one called "KanBo")
    • For compute and storage, choose basic. You can scale it up later (information about optimal sizing can be found at the end of the article).


5. Configuring the DB connectivity

Use the Azure portal to obtain the connection string necessary for your Web App to connect with Azure SQL Database.

  1. Click on SQL Databases icon and then, search for your database.

  1. Click on your database, the click on "Show database connection strings".

  1. Copy the ADO.NET connection string

  1. Go to the appsettings.json file. There should be a "ConnectionStrings" array.

  1. Paste the connection string in the place of "FILL-ME", without dropping the quotation marks.
  2. Modify the line by filling in the password and adding "MultipleActiveResultSets=True;" to the end of the connection string.
  3. Save the changes.


Configure Microsoft Graph connectivity

  1. Go to Azure Active Directory by going to this page.
  2. Click on Azure Active Directory and look for App Registrations.

  1. Click on New registration.

  1. Choose a name for Your App Registration.
  2. Select the Redirect URI as "Web" and write down a link that looks like this: https://YOUR KANBO ADDRESS/auth/aad/return

  1. Click on register to save the changes.
  2. After the App Registration is finished go to API Permissions.

  1. Click on "Add a permision" and select Microsoft Graph.

    There are two options for permissions, delegated and application. Here's a list of permissions that must be added from both of the options.

    Application permissions:

    • Calendars.ReadWrite
    • Directory.Read.All
    • Directory.ReadWrite.All
    • Files.Read.All
    • Files.ReadWrite.All
    • Group.Read.All
    • Group.ReadWrite.All
    • Mail.Send
    • Mail.ReadWrite
    • Sites.Read.All
    • User.Invite.All
    • User.Read.All


    Delegated Permissions:

    • Calendars.Read
    • email
    • Directory.Read.All
    • Files.ReadWrite.All
    • Group.ReadWrite.All
    • User.Read
    • User.Read.All
    • Sites.Read.All

    1. Now, when all permissions are selected and added, click on "Grand admin consent for KanBo".
    2. Create a pair of self-signed certificates using this manual.

    1. Go to "Certificates & Secrets" section in App registrations to register a certificate.

    1. Click on Upload public key and select your .cer certificate. Now click Save.

      1. Your certificate should be now visible.
       

      1. Go back to Overview. Get Application ID and Directory (Tenant) ID and save it for later as this would be used in the KanBo configuration.


      Upload the certificate to KanBo

      1. Go back to Your KanBo Azure Webapp ang go to TLS/SSL settings, then go to Private Key Certificates (.pfx).
      2. Click on "Upload certificate".

      1. Provide the password and Upload it.

      1. Copy the certificate's thumbprint.

      1. Open Configuration and add a new Application Setting.

      1. The setting's name should be WEBSITE_LOAD_CERTIFICATES. The value should be the Thumbprint of certificate.
      2. Save it.

      1. In the Bindings Settings activate "HTTPS only".

      Adjust KanBo configuration

      There are some areas that need filling out in the appsettings.json file.

         {
          "type": "set-language-for-new-users",
          "lang": "de-DE"
         },

      Here You are able to set the Default language for the new KanBo Users by changing the "lang" variable. Possible languages are:

      • de-DE - German
      • de-AT - Austrian German
      • en-US - United States English
      • en-GB - United Kingdom English
      • en-AU - Australian English
      • en-CA - Canadian English
      • es-ES - Spanish
      • pl-PL - Polish

         {
          "type": "server-url",
          "value": "FILL-ME"
         },

      The "value" variable should contain the full URL of Your KanBo (e.g.

      The" class="redactor-autoparser-object">https://mykanbo.azurewebsites.com/)

        {
          "type": "package",
          "name": "auth-aad",
          "client-id": "FILL-ME",
          "tenant": "FILL-ME",
          "thumbprint": "FILL-ME",
          "admin-upn": "FILL-ME"
         },

      The "client-id" and "tenant" should contain the Client ID and the Directory (Tenant) ID copied from Your Azure Active Directory App Registration, "thumbprint" should contain the Thumbprint of the certificate You have created, and "admin-upn" should be Your email address in Azure (e.g. admin@company.com).

       {
          "type": "template-files",
          "path": "FILL-ME"
         },

      Here You have to specify where the KanBo Board Templates will be temporarily stored when being installed or created. We will get back to this after uploading the KanBo installation package.

       {
          "type": "package",
          "name": "webjobs",
          "thumbprint": "FILL-ME"
         },

      This is needed to allow KanBo Webjobs to work. Insert the same thumbprint here that You used for the "auth-aad" package.


      Upload the KanBo installation package

      1. Navigate to your Azure website KUDU service (add .scm just before azurewebsites.net e.g https://mykanbo.scm.azurewebsites.net, then select Debug console -> PowerShell).
      2. Enter the folder "site", then wwwroot.
      3. Pack all your files into a .zip file (but please don't add the folder!).
      4. Now drag and drop your .zip archive into right upper part of KUDU service to unzip the contents of the .zip archive.


      Now You need to create a folder for KanBo Board Templates.

      It is best not to create the Templates folder where the KanBo files are stored. As an example, let's create this folder inside the "site" directory.

      1. Click on the plus icon and select "Create Folder"

      1. Name the folder "Templates" and confirm with enter.
      2. Go into the folder.

      1. The path to the folder is present in the Powershell window. Copy it.
      2. Before we can paste it in the appsettings.json file, we need to change the backslashes to double backslashes.

        So this:

        C:\home\site\Templates

        Will become this:

        C:\\home\\site\\Templates

      3. Head back to the appsettings.json file and fill in the "path" for "template-files". You can edit the file by clicking the edit button alongside it.

      1. After pasting the line, click on "save".


      Creating the databases

      1. Go to https:{your kanbo address}/setup and you will be directed to the KanBo Setup page.
      2. Choose the Start simple setup option.

      After clicking on the Automatic Setup option, installation of KanBo Setup will proceed. Wait a couple of minutes until it is finished.


      Obtaining the license key

      1. To obtain a KanBo License ID, click on "Show Advanced Setup", then click on the "Refresh" button near the License ID fieldset.
      2. Please send the KanBo ID to support@kanboapp.com, so a license key can be generated and sent to you.

      1. Go back to the appsettings.json and paste the license key in the "LicenseKey" variable.

      1. After updating the pasting the LicenseKey, save the appsettings.json file and restart the KanBo app.

      Your KanBo has been successfully installed!

      Creating Sync Jobs

      For KanBo to sync Azure Active Directory profiles and o365 groups two Webjobs need to be created. Along with the web.zip file, You will be provided with a KanBo.JobHost.zip file. It contains its own appsettings.json, which we will need to edit. There are two sections to modify:

      "ConnectionStrings": {
          "KanBo": "FILL-ME"
        },

      Here, You will need to paste the same connection string that You use in Your KanBo web.config.

      {
          "type": "package",
          "name": "auth-aad",
          "client-id": "FILL-ME",
          "tenant": "FILL-ME",
          "thumbprint": "FILL-ME"
         },
         {
          "type": "package",
          "name": "webjob.group-sync",
          "thumbprint": "FILL-ME",
          "kanbo-url": "FILL-ME"
         }
      

      The values here should be the same ones that You used in the appsettings.json of Your KanBo.

      After saving the configured file, put all the files into a .zip folder and follow these instructions on creating a scheduled WebJob: https://docs.microsoft.com/en-...

      For the o365 Group Sync jobs, choose the name of "GroupSync" and a CRON expression of "0 */15 * * * *"

      To create a package for the AAD Profile Sync job, simply replace:

      "name": "webjob.group-sync",

      with:

      "name": "webjob.profile-sync",
      

      and save the config.

      Follow the same instructions You did for creating the o365 Group Sync job, but change the name to "ProfileSync".


      Use it

      1. Create boards.
      2. During the board creation, you can choose whether you would like to create new Office 365 Group or use the existing one under the board.

      1. Group memberships will be synchronized.

      Also, user's information will be taken from AAD and transferred into KanBo Profile.


      Configure KanBo

      1. Configure email notifications

      Follow this instruction to configure email notifications.

      2. Configure KanBo Search

      Follow this instruction to configure Search for KanBo (Elastic Search).

      3. Configure KanBo Content Database on Azure

      As soon as your KanBo is installed, please adjust the sizing of Your database to be suitable

      A change might be necessary for a good performance of the KanBo Content Database which has been created during the Setup installation.

      You can see dependencies on the table below:

      Number of users on your KanBo instance Recommended Pricing Tier for KanBo Content Database
      20+ users Standard 10 DTUs 250GB
      50+ users Standard 20 DTUs 250GB
      100+ users Standard 50 DTUs 250GB

      Was this article helpful?

      Please, contact us if you have any additional questions.