How can we help you today?

Go ahead and ask us anything.

See the KanBo newest version.

KanBo on-premises installation (SharePoint 2013/2016/2019)

Last modified:

installation SharePoint


1. Prerequisites

Important:

You can see the prerequisites which need to be fulfilled for the KanBo On-Premise installation in the following article.


In order to Download the most recent KanBo installation package you need to fill out this form.


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. In the App Pool advanced setting you should choose a user which has access o High Trust Private Key. 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. Image 2318
  3. 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.
  4. 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
  5. In the “Auth” 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

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. Creating SharePoint high-trust authorization

To allow KanBo App to communicate with SharePoint we have to register the certificate that we created in Step 4 which will be used by the KanBo.app. The self-signed certificate will be added to the KanBo web.config later. You can learn more about this procedure from Microsoft. 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

Insert these entry to <plugins> before <loadPackages> section. Insertvalues of Client Id in {CLIENTID} and Issuer ID in {ISSUERID}. Also add a SharePoint URL in {SPHOSTURL} location. Add certificate's thumprint in {THUMBPRINT}.

<auth-by-login issuer="sp" />
<identity-source />
<auth.sharepoint sp-host-url="{SPHOSTURL}" client-id="{CLIENT ID}" issuer-id="{ISSUERID}">
<signer type="x509-store" key="thumbprint" value="{THUMBPRINT}" store-name="my" store-location="localmachine" valid-only="false" />
</auth.sharepoint>
<setup-permissions.sharepoint />
<sp-app url="sharepoint-appfile" />

             



Add these entries to <plugins> section after <package name="standard "/>.

  
<website-search.sharepoint /> 
<heartbeats>
<sql sync-interval="100" />
<messaging track="single-node" queue-interval="1000" send-interval="1000" inactive-detect-interval="1000" />
 <user-location />
</heartbeats>

For the certificates:

- FromStore - make sure KanBo's app Pool is configured to Load User Profile in Advanced Settings and the App Pool's Identity is set to your user.

- FromFile - make sure your user has access to them in certmgr and has access to folder where they are stored.

In  <appSettings> - License Part

<add key="KanBoLicenseKey" value="" /> - leave it empty for the installation process

    In   <connectionStrings> - Connection strings to database 

    <add name="KanBoContentConnectionString" connectionString="{Insert the DB connection string};MultipleActiveResultSets=True" providerName="System.Data.SqlClient" />


    PLEASE NOTE!

    KanBo is creating one database during the setup step later using the ConnectionString to the database.


    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=KANBO_DATABASE; Integrated Security=true; MultipleActiveResultSets=True
          
    • Preferred: Without the Integrated Security (we use separate SQL User to login to the database. (Adjust the upper case values to your own):
      Data Source=PDCWSS; Initial Catalog=KANBO_DATABASE; User ID=USERID; Password=PASSWORD; MultipleActiveResultSets=True
          

    Image 5055

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


    7. Modifying the KanBo.app 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:

    Image 2042

    Find KanBo on the list of the apps you can add and click on it to install it.

    Image 2043

    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.

    You might find yourself not able to add this app.

    Image 2044

    To solve this issue, simply click Find out why link. After you enter the next site, please click Request Approval link.

    Image 2045

    Simply send it by pressing Request. You don't need to type any text into white area.

    Image 2046

    At https://YOURNAME.sharepoint.com/sites/appcatalog/AppRequests/ActiveRequests.aspx you might find your pending request for KanBo app approval. Approve it to move forward.

    Image 2047

    Go to your Site collection -> Settings -> Add an app.

    Click on KanBo app tile.

    After clicking Trust it button or solving App Request problem and then clicking Trust It button, KanBo app will be added to your Site Collection. It takes 10-30 seconds depending on the current load of Office 365.

    Image 2048

    Once the KanBo App has been added, you can proceed with the initial run of KanBo.

    Open https://{YourKanBoAddress}.azurewebsites.net/Setup.

    Image 8474


    10. First run

    Important:

    Make sure that the user who runs the KanBo Setup must be the owner of the Top Level SIte of the Site Collection, where you added the KanBo App in the Step 9. If you are the Admin of this Site Collection that is also acceptable to run the KanBo Setup.

    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 license key

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

    Image 3483

    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.

    Image 3536

    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.

    Image 999


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


    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.

    Image 8678

    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 https://community.kanboapp.com/knowledge-bases/2/articles/2496-setting-up-email-notifications-in-kanbo-27  to configure email notifications.


    13. Configure KanBo Search

    Follow 

    https://community.kanboapp.com/knowledge-bases/2/articles/7634-solr-75-installation-on-a-virtual-machine

     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.


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