KanBo on-premises installation (SharePoint 2013/2016)

Contact us at support@kanbozone.com to receive most recent KanBo installation package.

1. Prerequisites

The following prerequisites need to be fulfilled in order to install the KanBo app.


Farm Configuration

*in case you don't want to use UPSA follow steps decribed in Foundation scenario.

App server configuration

Following server roles and features need to be installed:


Server Roles:

  • Application Server
    • .NET Framework 4.7
    • TCP Port Sharing
    • Web Server (IIS) Support
    • Windows Process Activation Service Support
      • HTTP Activation
      • Named Pipes Activation
      • TCP Activation
    • Web Server (IIS)
      • Web Server
        • Common HTTP Features
          • Default Document
        • Security
          • Request Filtering
          • Basic Authentication
          • Client Certificate Mapping Authentication
          • Digest Authentication
          • IIS Client Certificate Mapping Authentication
          • Windows Authentication
        • Application Development
          • .NET Extensibility 3.5
          • .NET Extensibility 4.5
          • NET 3.5
          • NET 4.5
          • ISAPI Extensions
          • ISAPI Filters
          • WebSocket Protocol

Features:

  • .NET Framework 3.5 Features
    • .NET Framework 3.5
  • .NET Framework 4.5 Features
    • .NET Framework 4.5
    • NET 4.5
    • WCF Services
      • HTTP Activation
      • Named Pipe Activation
      • TCP Activation
      • TCP Port Sharing

Certificates

  • One self-signed certificate to allow the KanBo app to communicate with SharePoint (we will generate it later in this manual in the IIS Manager).
You can read about a recommended KanBo Farm setup for small company here.

2. Creating a site which will host KanBo

Before creating a site we will have to create an application pool on which the site will be running.


PLEASE NOTE: Every name given here (application pool, host etc.) is an example, you should pick your own one which would suit your environment.


Create IIS App Pool

  1. Go to the IIS Manager
  2. Click on Application Pools
  3. Add new
  4. In our case we give it a name KanBoAppPool
  5. After creating it, go to its advanced settings and change the Identity to SP_Farm (your SharePoint Farm Account). IMPORTANT: This user needs to be added to your SQL Database with dbcreator role if you intend to use Integrated Security.


Create IIS Website

After creating the application pool, we can create a site:

  1. After creating the site go to the physical path on your drive and copy there the provided installation files from zip (that you downloaded from our Onedrive) with name like 2.5.0_20170504_KanBoPkg.zip

  2. In IIS Manager right click on Sites, then Create a new one.
    1. In the application pool select the one created in previous points,
    2. Create a physical path for the site,
    3. Choose https,
    4. Host name: kanboapp.kanbo.local (in our case),
    5. In our case we pick the *.kanbo.local (you’ll have to pick the one created for your SharePoint’s domain),
    6. As the SSL Certificate pick the one which you have generated or received from the Certifying Authority.
  3. After the site has been created, select it and click on the “Authentication” (possible issue with override mode can appear here: here is the explanation how to solve it):
    1. Windows -> Disable
    2. Anonymous -> Enable
  4. In the “Auth\ntlm” catalog of your site (you can find it in the tree on the left site), choose “Authentication” and set the following:
    1. Windows -> Enable
    2. Anonymous ->Disable
  5. In the “Services” catalog of your site (you can find it in the tree on the left site), choose “Authentication” and set the following:
  1. Windows -> Disable
  2. Anonymous -> Enable

IMPORTANT: Please make sure that “Authenticated Users” are granted the READ permissions to the site directory.


3. Registering the App within the Site Collection

To allow KanBo App to communicate with SharePoint we need to register it in a SharePoint’s Site Collection.
Go to the site collection where KanBo app is supposed to be installed and navigate to the following URL: {SiteCollectionURL}/_layouts/15/appregnew.aspx . After navigating to the site click on both “Generate” buttons.

In the title field enter “KanBo”.

App domain should be the domain of the site you we have created in step 2 (without “https” or “http” for example: kanboapp.kanbo.local ).

The Redirect URL should be the site address with the HTTPS prefix + /pages/default.aspx. For example https://{YourAppDomain}/pages/default.aspx.

After providing the necessary data click on “Create”. You’ll be presented a page with the generated keys and other information you have provided earlier. Save this data as we will need it later.

KanBo Installation on premises on prem SharePoint


After clicking "ok", you will be presented with the following page:

KanBo Installation on premises on prem SharePoint



4. Setting up the certificate

Creating a self-signed certificate

Go to the IIS Server Manager, click on your server and choose Server Certificates. From the menu on the right side choose “Create self-singed certificate”, pick a name for your certificate and follow the next steps to create it. After the certificate has been created save it to a file by following these steps:

  1. Select -> Click on “Export” -> Follow the steps to save it as a .pfx file in a choosen location (we will use the location later when configuring the app)
  2. Select -> Click on “View” -> Details -> Copy to file -> Save it as a .cer file in the same location as the .pfx file
  3. Install certificate to LocalMachine store (DoubleClick it) . Ensure certificate exist under Personal tree using Manage computer certificates (certlm).

5. Registering the self-signed certificate in SharePoint

To allow KanBo App to communicate with SharePoint we have to register the certificate which will be used by app (the self-signed which we then added to the web.config). Run the following script to do so:

Add-PSSnapin Microsoft.SharePoint.PowerShell -ErrorAction SilentlyContinue
$publicCertPath = "<the path to your self-signed certificate .cer file>"
$issuerID = "<Client ID generated earlier in step 3>"
$targetTenantSite = "<the site collection URL where KanBo will be installed>"
$authorityName = "<Your chosen authority name ex. KanBoServerAppsCerts>"
$certificate = Get-PfxCertificate $publicCertPath
New-SPTrustedRootAuthority -Name $authorityName -Certificate $certificate
$spweb = Get-SPWeb $targetTenantSite
$realm = Get-SPAuthenticationRealm -ServiceContext $spweb.Site
$fullIssuerIdentifier = $issuerId + '@' + $realm
New-SPTrustedSecurityTokenIssuer -Name $authorityName -Certificate $certificate -RegisteredIssuerName $fullIssuerIdentifier -IsTrustBroker
Iisreset

6. Configuring the Web.Config file

To get KanBo running we need to configure the web.config file.

  1. Go to the place on your drive where a KanBo site is located.
  2. Open the web.config (for ex. with Notepad).
  3. Edit the following:
    • <provider id="sp" type="Sharepoint" clientId="{CLIENTID}" issuerId="{ISSUERID}"> - from step 5 most likely both are Client ID
    • To use certificate form store use this command: <signer type="X509SignerFromStore" storeName="My" storeLocation="CurrentUser" key="Thumbprint" value="<Your certificate Thumbprint value>" />
    • To use certificate form file use this command: <signer type="X509SignerFromFile" file="{CERTIFICATEPATH}" key="{CERTIFICATEPASSWORD}" />
    • <add key="KanBoLicenseKey" value="" /> - leave it empty for the installation process
    • <add name="KanBoSqlConnectionString" connectionString="{Insert the DB connection string};MultipleActiveResultSets=True" providerName="System.Data.SqlClient" />
    • <add name="KanBoProfilesConnectionString" connectionString="{Insert the DB connection string};MultipleActiveResultSets=True" providerName="System.Data.SqlClient" />

PLEASE NOTE!

KanBo is creating the databases dynamically upon the first run so the connection string needs to point to your SQL Server but the Database/Initial Catalog name should be a one that hasn't existed before. For example KanBo_db for KanBoSqlConnectionString and KanBoProfiles_db for KanBoProfilesConnectionString. See examples below:

<add name="KanBoSqlConnectionString" connectionString="Data Source=PDCWSS; Initial Catalog=<b>KanBoInstances_Database</b>; Integrated Security=true; MultipleActiveResultSets=True" providerName="System.Data.SqlClient" />
<add name="KanBoProfilesConnectionString" connectionString=" Data Source=PDCWSS; Initial Catalog=<b>KanBoProfiles_Database</b>; Integrated Security=true; MultipleActiveResultSets=True" providerName="System.Data.SqlClient" />

The important issue is putting “MultipleActiveResultSets=True” at the end of each connection string (it is already there in our example).

Connection string examples:


  • Using Integrated Security (we are logging to the database with the application pool account):
    Data Source=PDCWSS; Initial Catalog=<b>KanBoInstances_Database</b>; Integrated Security=true; MultipleActiveResultSets=True
        
  • Without the Integrated Security (we use separate SQL User to login to the database):
    Data Source=PDCWSS; Initial Catalog=<b>KanBoInstances_Database</b>; User ID=<b>userID</b>; Password=<b>password</b>; MultipleActiveResultSets=True
        

In both cases the added user needs to have dbcreator role in the database.


Moreover remove entire section dedicated Office 365 installation

        <!-- < o365> -->
      <provider id="sp" type="Sharepoint" clientId="b55f746b-c3fb-4b77-b2bd-ddc34e289a25" clientSecret="EZS53z0OOn2C863s78nJeVBuLqlqNOdbtOEFkNHS91c=" />
      <!-- < /o365> -->


In case you are installing KanBo on SharePoint Foundation set following values to allow user modify his KanBo profile:


  • <add key="KanBoUserCanSyncProfile" value="false" />    
    <add key="KanBoUserCanEditAvatar" value="true" />
    <add key="KanBoUserCanLinkProfile" value="false" />
    <add key="KanBoUserCanEditProfile" value="true" />
        

7. Modifying the KanBo.app file

Click here to download recent KanBo.app (2.5.1) file.

First of all change the extension of the KanBo.app to .zip so that it is KanBo.zip. When done, open the .zip file(do not extract it!) and change the following in the AppManifest.xml:

  1. The <StartPage> section: change every single address so that it points to your site where KanBo is hosted, HTTPS is important. Replace url.placeholder with adres of your KanBo IIS
  2. <RemoteWebApplication> section, change the ClientIdPlaceholder, so that it is the same as the ID you’ve previously generated in step 3.

KanBo Installation on premises on prem SharePoint

After the changes have been made, save the file, allow the .zip file to update, and change the file extension back to .app so that it is KanBo.app again.


In case you are installing KanBo on SharePoint Foundation please remove following entry from AppManifest.xml


<AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="Read" />
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />

and add


<AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" />

8. Uploading KanBo.app file

When you are done with changes in the KanBo.app file you can upload it to the App Catalog. Navigate to your app catalog, choose Apps for SharePoint, upload the KanBo.app file there. (See more here).


9. Adding the KanBo App to our Site Collection

Do not use system account! Use tenant admin account instead-http://www.codeproject.com/Articles/808291/Sorry-only-tenant-administrators-can-add-or-give-a

Navigate to the site collection, click on add an app:

KanBo Installation on premises on prem SharePoint


Find KanBo on the list of the apps you can add and click on it to install it. You will have to click on "Trust" when asked if you trust the app. After a couple of seconds you should see the app installed and ready to use. Before navigating to the app please click on the app details to be sure that no errors occurred during the installation process.

If no errors occurred you can click on the app to navigate to it.


10. First run

Creating the databases

You will be directed to the KanBo Setup page. Choose the Automatic Setup option.

Full KanBo installation on Office 365 SharePoint Azure Microsoft


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

Full KanBo installation on Office 365 SharePoint Azure Microsoft


When the process succeeds you'll be presented with the following communicate (in the screen below in Obtaining the licence key part).

Obtaining the licence key

In order to obtain the licence key you will need to send us your KanBo ID. Please copy it from the following message.


The selected string is essential for the license key creation process. Provide us (support@kanbozone.com) with it and the key will be generated.

After obtaining the key you have to enter it in the web.config file.




Running the app

Navigate to the site collection where you've installed the KanBo app and run the application:

KanBo Installation on premises on prem SharePoint


You will be directed to the KanBo Setup page. Choose the Automatic Setup option.


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

KanBo Installation on premises on prem SharePoint


Click on Go back. You will be redirected to your KanBo Landing Page.

KanBo Installation on premises on prem SharePoint



Your KanBo has been successfully launched.





11. Adding users

After installing KanBo, only the user who installed it has access to the app. In order to allow others to use KanBo they need to be added.


12. Configure email notifications

Follow http://community.kanbozone.com/topics/74-setting-up-kanbo-email-notifications-on-premise/ to configure email notifications.


13. Configure KanBo Search

Follow http://community.kanbozone.com/topics/873-kanbo-search-installation-and-configuration-on-premises/ to install and configure KanBo Search.

14. Possible mistakes

  • Be sure that every single address you’ve provided in the configuration was https and not http address.
  • If errors occur please check if the ClientId and ClientSecret are properly provided.
  • If you haven’t copied the ClientId direct from browser check if the “-“ signs are right encoded (the best solution is to delete them and then put back again).

Here you will find full update procedure and be able to sign up for KanBo updates newsletter.

installation SharePoint

This article was helpful for 4 people. Is this article helpful for you?