Self-Hosted Setup Guide for Docker

Kendis is a cloud service, however, to provide more options for the enterprises, we also offer Kendis Enterprise Edition with a Self-Hosted option. Enterprise edition has separate pricing and more details can be found on our pricing page. 

Important:

After installation is successful, please remember to change the default password for the /system URL.

1) System Requirements

To be able to run Kendis smoothly in your local self-hosted environment, you should have

• Memory:
  - Minimum 8 GB
  - 16+ GB is recommended for smooth performance

• Storage:
  - Minimum 20 GB storage for logs, database, and other system-level storage requirements.
  - 30+ GB is recommended

• CPU
  - Quadcore 2.0GHz+ 

2) Setup Docker

In case you don't have Docker running at your local environment, you can install it from this link https://docs.docker.com/install/
There are options on the left navigation for the target OS, e.g., Linux, MAC, Windows, and others.

2.1) Ensure Docker is running

Open command prompt at your local self-hosted environment, in this example, we use MAC os, and we will open "Terminal" and type command "docker"

 > docker                                    

Note: if you are using windows then you should open "command prompt" using "CMD"

3) Pull Kendis from Docker Hub

At the same command prompt the following command

  > docker pull kendisdocker/kendis                                
It will start downloading the kendis docker. Wait for all the installation to be ready and once it is ready you will see the prompt again

4) Start Kendis Server

Start the Kendis server with the following command

  > docker run --restart=always  -v kendis-resources:/var/lib/kendis-resources -v kendis-logs:/var/log/kendis-logs -v kendis-backup:/var/lib/kendis-backup -v kendis-data:/var/lib/mongodb -p 8282:8080 kendisdocker/kendis  

Note: Ensure that there are no line-breaks in the above command, it needs to be copied as a single line at the command prompt

If all goes fine you will see the server is running at the 8282 port. 

5)  Access Kendis Server

To access the Kendis server please goto
  <your server url>:8282/welcome                           

In case, you have installed at your local machine, the server URL could be your machine name or 127.0.0.1

6) Special Parameters for Run Command

• --restart=always
  This will ensure the Kendis docker will be started automatically if the host machine restarts.
  

•  --add-host: <hostname>:<ip>
  In case you have DNS issues from your docker container, you can use the following parameters in the run command.
  e.g., the following 2 parameters are adding 2 host mappings
  --add-host =test1.com:127.0.0.1 --add-host=test2.com:127.0.0.2
  

• -v kendis-config:/var/lib/kendis-config
  This parameter should be added to the command if you are planning to use the external MongoDB database. This approach is highly recommended if you have a high number of boards and data (more details in section 7).
  

• --env aes256=true
  This parameter will use a stronger key for encryption.

> docker run --add-host=test1.com:127.0.0.1 --restart=always -v kendis-resources:/var/lib/kendis-resources -v kendis-logs:/var/log/kendis-logs -v kendis-backup:/var/lib/kendis-backup -v kendis-data:/var/lib/mongodb -p 8282:8080 kendisdocker/kendis 

7) Database hosting options

Kendis docker contains already a database so you don't need to install any separate databases.

Database hosted separately

However, if you would like to set up an external database inside your organization, which is recommended approach in case you have many boards and large data.

Check this detailed article for the steps

https://help.kendis.io/en/articles/4493201-configure-external-database-with-kendis-self-hosted

Important note: Since Kendis Docker and the database will be self-hosted by the enterprise, all the data will remain within the enterprise network.

8) External Calls

Kendis Docker doesn't make any external calls outside your enterprise network, it runs completely within your enterprise network

9) Setup Guide

Once you go to Kendis welcome page, it will ask you sign-up email and password and select the prefix for your sub-domain. After these 2 simple steps, you are all set to create your first Kendis Board.
Check out this guide on creating your first Kendis Board for SAFe®

Further Points:

• Kendis at DockerHub
  Kendis is available at DockerHub for download and with few simple steps, you can configure Kendis to run in your local enterprise setup.
  https://hub.docker.com/u/kendisdocker

• Ensure the Shared Drives are enabled
  Especially if you are installing it on Windows, ensure that shared drives are enabled. To check it, click on the Docker icon in your system try, if it's windows, you might have to right click at the docker icon and click on "Settings".
  At the settings select "Shared Drives" and then select the drive you want to share.