Skip to content

Release 3.2.0

Compare
Choose a tag to compare
@dervalp dervalp released this 24 Nov 17:03

Features

New Command open

Run the open command to open a CluedIn instance in your browser. The instance must have already been started with up or start:

Examples

pwsh ./cluedin.ps1 open #=> Opens the browser for the default environment
pwsh ./cluedin.ps1 open local #=> Opens the browser for the 'local' environment
pwsh ./cluedin.ps1 open -org custom #=> Opens the browser for the default environment and the 'custom' org

Jobs Dashboard Visibility

A new environment variable is available to configure the visibility of the jobs server dashboard CLUEDIN_JOBS_DASHBOARD. By default, the dashboard is configured to be visible.

Examples

pwsh ./cluedin.ps1 env -set CLUEDIN_JOBS_DASHBOARD=true #=> Enables access to the dashboard on localhost:9003/hangfire
pwsh ./cluedin.ps1 env -set CLUEDIN_JOBS_DASHBOARD=false #=> Disables access to the dashboard
pwsh ./cluedin.ps1 env -set CLUEDIN_JOBS_DASHBOARD=localOnly #=> Enables access to the dashboard on localhost:9003/hangfire only for requests from localhost

The local port that is used to access the dashboard is controlled by the CLUEDIN_SERVER_JOB_LOCALPORT environment variable

Added new environment variables to control features

Features for the UI instance can now be controlled through environment variables.
Set the environment variable to a blank value to disable.

Name Default Value Possible Values
CLUEDIN_UI_ALT_UPLOAD http://gql:8888 Any uri
CLUEDIN_UI_FEATURES_ANNOTATION annotation annotation
CLUEDIN_UI_FEATURES_CLEAN (blank) clean
CLUEDIN_UI_FEATURES_CONNECTOR connector connector
CLUEDIN_UI_FEATURES_DATAGOVERNANCE data-governance data-governance
CLUEDIN_UI_FEATURES_DATASOURCE datasource datasource
CLUEDIN_UI_FEATURES_DEVELOPER developer developer
CLUEDIN_UI_FEATURES_ENDPOINT endpoint endpoint
CLUEDIN_UI_FEATURES_ENRICHER enricher enricher
CLUEDIN_UI_FEATURES_EXTENDEDSAR extended-sar extended-sar
CLUEDIN_UI_FEATURES_FOLLOW (blank) follow
CLUEDIN_UI_FEATURES_GLOSSARY glossary glossary
CLUEDIN_UI_FEATURES_INTEGRATIONS integrations integrations
CLUEDIN_UI_FEATURES_METRICS metrics metrics
CLUEDIN_UI_FEATURES_OPENREFINE cluedinClean cluedinClean
CLUEDIN_UI_FEATURES_PREPARATION preparation preparation
CLUEDIN_UI_FEATURES_SAVEDSEARCHES (blank) savedSearches
CLUEDIN_UI_FEATURES_SETTINGS settings settings
CLUEDIN_UI_FEATURES_STREAMS stream;streams stream;streams
CLUEDIN_UI_FEATURES_USERS users users

Note: OpenRefine is enabled by default so CLEAN is blank by default

Fixes

Disk drop off for Server emails

In previous releases, the CluedIn Server instance was not configured to drop emails to a local directory.
This would cause errors when sending emails after crawl jobs have completed.
The server image is configured using the same folder as the webapi with the environment variable CLUEDIN_EMAIL_DIR

Map NODE_ENV to CLUEDIN_ENVIRONMENT

For NodeJS apps (clean / gql / annotation / datasource) set the NODE_ENV correctly based on CLUEDIN_ENVIRONMENT

Default UI Port changed to 9080

To simplify support for developers and normalize the ports across all services under 90** the default port for the UI has changed to port 9080.

To change the port to an alternative (e.g. port 80):

pwsh ./cluedin.ps1 env -set CLUEDIN_UI_LOCALPORT=80 #=> Set to port 80 for the default environment
pwsh ./cluedin.ps1 env local -set CLUEDIN_UI_LOCALPORT=80 #=> Set to port 80 for the custom 'local' environment

check uses configured ports

The check command now correctly uses the ports configured for an environment.