Local installation guide

Clone CluedIn repository

The first step for the local installation of CluedIn is to clone the CluedIn public repository named Home https://github.com/CluedIn-io/Home.

To clone the CluedIn repository

At the command prompt, run the following command.
```
  git clone https://github.com/CluedIn-io/Home
```
You will get an output similar to the following.

Alternatively, you can clone the repository using your preferred Git client.

Authenticate to CluedIn ACR

Prerequisites

For Windows environments: Modify the PowerShell execution policy to enable running local scripts. To do that, use the Set-ExecutionPolicy RemoteSigned command.
For Windows environments: Run your terminal session as an administrator.
For non-Windows environments: Use the sudo command.

CluedIn uses two ACRs:

Production – the registry name is cluedinprod. This registry is used to store all official images from CluedIn.
Testing & development – the registry name is cluedindev. This registry is used internally by CluedIn to develop the software. Occasionally, this registry can be used by partners and customers to test new functionality before it is officially released.

You can find the ACR to which you have been granted access in the email from CluedIn.

In the following instructions, we use 2024.01 as the release number. You should always use the latest release number. You can find the list of releases here.

To authenticate to CluedIn ACR

Open to the checkout directory by running the following command:
```
 cd Home
```
Sign in to Docker. Depending on the registry to which you have been granted access, do one of the following:
- For Production, run the following command:
```
  docker login cluedinprod.azurecr.io
```
- For Early Access, run the following command:
```
  docker login cluedindev.azurecr.io
```
Enter the username and password that you received in the email from CluedIn.
To verify your access, pull images from the ACR by running the following command:
```
 pwsh .\cluedin.ps1 pull
```
This process might take some time.

You will get an output similar to the following.
Create an environment. In the following command, we use 202401 as the name of the environment and 2024.01 as the release number. To create an environment, run the following command:
```
 pwsh .\cluedin.ps1 env 202401 -tag 2024.01
```
You should always use the latest release number. You can find the list of releases here.

You will get an output similar to the following.

Environment is used for having scripts that can start CluedIn of different versions. Docker does not support multiple CluedIn versions running in parallel.

Start CluedIn

As Docker is not an orchestration tool like Kubernetes, starting up Docker containers may require some manual configuration steps to ensure proper initialization.

To start CluedIn

Run the following command:
```
 pwsh .\cluedin.ps1 up 202401 -disable server
```
where 202401 is the name of the environment.

You will get an output similar to the following.
In Docker Desktop, check if SQL Server is ready. To do that, select the SQL Server container and look for a similar section in logs.
Run the following command:
```
 pwsh .\cluedin.ps1 up 202401
```
where 202401 is the name of the environment.

You will get an output similar to the following.

The last step of the local installation of CluedIn is to create an organization and credentials for signing in to CluedIn.

Prerequisites

Make sure that the server has started correctly. To do that, in Docker Desktop, select the server and look for a similar section in logs.

In the following procedure, we’ll use 202401 as an environment, example as an organization name, and Example123! as a password for signing in to CluedIn.

To create organization and sign-in credentials

Run the following command:
```
 pwsh .\cluedin.ps1 createorg 202401 -Name example -Pass Example123!
```
You’ll get the credentials for signing in to CluedIn.
Open the CluedIn sign-in page by running the following command:
```
 pwsh .\cluedin.ps1 open 202401 -Org example
```
As a result, CluedIn opens in your default browser.

By default, CluedIn uses the following address: http://app.127.0.0.1.nip.io:9080
Sign in to CluedIn using the credentials that you received in step 1.

Results

You have installed CluedIn locally.

Next steps

Add more features to CluedIn with the help of extension packages. Learn how to do that in Extension packages.