This will show you how to install CluedIn on your local machine by running it inside Docker. CluedIn is a complex application, with many moving parts, so you will need to ensure you have adequate resources on the machine you intend to run it on.
- At least 16Gb of free memory (It is preferable to run on a machine with 32Gb of RAM)
- Latest version of Docker for your operating system (Engine: > 19.03)
- Powershell 7 for your operating system - This is to run helper scripts
- Access to the private repositories inside the cluedin DockerHub organization. You will require a Docker Hub account and request access from CluedIn; then use this account to do a
docker login. NOTE: Only CluedIn certified developers have access to the CluedIn DockerHub.
First time preparation
CluedIn provides a helper script to streamline the process of getting started.
- Clone the helper script from the CluedIn Home repo
git clone https://github.com/CluedIn-io/Home
- Open a powershell console on Windows - ( or
pwshon Mac & Linux ) and run:
This will check a few things:
- That you have the needed software installed
- That you have the ports needed to run CluedIn available
- That you have logged into docker hub
If all these checks are green you are ready to proceed. If ports are in use then you may need to stop any programs locally that may be using them and re-run
- Pull the latest cluedin images to your local machine
You can use this command to refresh/update any images at a later date.
Starting the application
To start up the application use:
This will start up the various containers in Docker and begin initializing CluedIn for the first time.
Checking application status
Depending on the speed of the machine it is being installed onto CluedIn can take a moment to start up.
You can check the status of this by using:
CluedIn is ready when all the status checks are green.
Open your browser and CluedIn will be available under http://app.127.0.0.1.xip.io.
Creating an organization
In order to use CluedIn you need to create an organization. There are two ways to do this
Using a script. In a
bootstrap/Create-Organization.ps1. This will create an organization with the following parameters:
name foobar url https://foobar.127.0.0.1.xip.io admin firstname.lastname@example.org password foobar23
These values can be overridden by passing parameters to the Powershell script
Stopping the application
There are two ways to stop the application:
Stopping (without deletion of data)
To stop CluedIn but to preserve the data you created while running, use:
To start CluedIn back up again, you can simply use
up or :
Stopping (with removal/reset of data)
To completely remove CluedIn and all of the associated data use:
This is a destructive action but it is useful for resetting data in CluedIn.