Installation - Laptop (Docker Desktop/Podman)

Step 1 - KnowHOW System Requirements

Please check here for System Requirements: PSknowHOW | System Requirements

Step 2 - Release Notes

Please read the release notes before starting the installation.

Step 3 - Create folder structure

Please select the preferred location for creating the PSKnowhow folder, ensuring that the chosen location offers a sufficient amount of available space.

Windows / MacOS:

Please establish the "PSKnowhow" directory in your preferred drive location. For instance, on Windows, you may choose to create it at “C:\UserName\PSKnowhow”, whereas on macOS, you can opt for the “/Users/YourUsername/PSKnowhow” directory.

Step 4 - Download docker-compose.yaml

Go to https://github.com/PublicisSapient/PSknowHOW/blob/master/docker-compose.yaml
Right Click on Raw and save link as to Download docker-compose.yaml file to local as shown in below picture
Upload the downloaded docker-compose.yaml to PSKnowhow folder which you created in Step 3.

Step 5 - Edit the docker compose file with appropriate values

Update Credentials of DB and other Environmental variable as specified hereEnvironmental variables
Create readWrite Privileged user which adds extra layer of data protection from accidentally deleting collections and use this in application . follow this steps to create

docker exec -it mongodb /bin/bash
mongo admin -u ${MONGO_INITDB_ROOT_USERNAME} -p ${MONGO_INITDB_ROOT_PASSWORD}
use kpidashboard
db.createUser({user: '<MONGODB_APPLICATION_USER>', pwd: '<MONGODB_APPLICATION_PASS>', roles:[{role:'readWrite', db:'kpidashboard'}]})
exit

To begin with PSKnowhow, it is essential to have three mandatory containers: i) UI, ii) CustomAPI, and iii) MongoDB. Additionally, there are other optional containers, such as jira-processor, devops-processor (including Jenkins, GitHub, GitLab, Bamboo, Bitbucket, Zephyr, Sonar, and TeamCity collectors), azure-board-processor (for Azure Board), and azure-pipeline-repo (for Azure Pipeline and Azure Repo).
Based on specific requirements, you can bring up these respective containers as needed.

Step 6 - Pull the docker images and Run the Containers

Open terminal/command prompt in PSKnowhow folder .
Pull the images by (For Docker for Desktop)
```
docker-compose pull
```

(For Podman)

podman-compose pull

Run the container by (For Docker for Desktop)

```
docker-compose up -d
```

(For Podman)

podman-compose up -d

Check Post installation steps for further configuration.