As CluedIn is a complex platform, CluedIn is providing you a template on how to run CluedIn using docker locally on your machine.
- Windows version 1903 or greater
- Latest version of Docker for Windows (> 19.03.4)
- Docker experimental features turned on
- Docker set up to run Windows containers
- 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.
You can verify if you satisfy these requirements and you can run simultaneously Windows and Linux containers by opening a
Powershell console and running:
docker info | sls 'Storage Driver'
The returned value should be:
Storage Driver: windowsfilter (windows) lcow (linux)
First time preparation
- Clone the Simple-Docker-Deployment
git clone https://github.com/CluedIn-io/Simple-Docker-Deployment
- Pull latest images
- Open an administrator
Starting the application
The application is run doing a via docker-compose You can then bring the application up doing:
docker-compose up -d
You can check if the the different services are created running:
The CluedIn server component takes a while to boot up. You can verify it is starting correctly:
docker-compose logs -f server
The server will be ready when you see the message
Server Started. Open your browser and CluedIn should be available under https://app.127.0.0.1.xip.io.
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 email@example.com password foobar23
These values can be overridden by passing parameters to the Powershell script
Using the UI
- Navigate to the https://app.127.0.0.1.xip.io/signup page.
- Fill in an email address (it can be fictitious)
- Check the
/emailsfolder. You should be able to open the file with the standard Mail application from Windows by double clicking on it.
- Click on the Setup my organization link in the email
- Fill in the information and click in Sign up
- You will be redirected to the login screen. Simply add the information created in the step above.
Stopping the application
You can then stop and start the stack, using the usual docker-compose commands
docker-compose down # containers are removed, data is kept docker-compose down -v # containers are removed and data is lost
If you need to remove the certificates you can run
Adding extra components
You can add extra providers or enrichers in two different ways:
- Via Nuget packages
- Add a a file named
./componentsfolder with the names of the nuget packages for the components you want to install.
- If the Nuget packages are not available publicly add a
nuget.configfile in the
./componentsfolder. Either pass the password token to the
nuget.configor create a
KEYenvironment variable with it.
- Add a a file named
- Copy the relevant DLLs for the components in the