Release 4.1.1 Docs

4.1.1/check.md

@@ -0,0 +1,45 @@
+---
+title: check
+parent: v4.1.1
+---
+
+# check
+
+Tests environment configuration is acceptable for CluedIn.
+{: .fs-6 .fw-300 }
+
+Performs a series of checks against the host machine for required services (e.g. docker),
+performance concerns (e.g. available memory), and validates environment configuration
+(e.g. port availability).
+
+## Syntax
+
+```
+check [[-Env] <string>] 
+```
+
+```powershell
+> .\cluedin.ps1 check
+
++----------------------------+
+| CluedIn - Pre-Flight Check |
++----------------------------+
+Installed Applications
+[1/3] ✅ » PowerShell : 7.1.1 / Core
+[2/3] ✅ » Docker : 20.10.7 / linux
+[3/3] ✅ » Docker Compose : 1.29.2
+Available Ports
+[1/23] ✅ » CluedIn UI : 127.0.0.1.nip.io:9080
+[2/23] ✅ » CluedIn API : 127.0.0.1.nip.io:9000
+[3/23] ✅ » CluedIn Auth : 127.0.0.1.nip.io:9001
+[4/23] ✅ » CluedIn Jobs : 127.0.0.1.nip.io:9003
+[5/23] ✅ » CluedIn WebHooks : 127.0.0.1.nip.io:9006
+[6/23] ✅ » CluedIn Public : 127.0.0.1.nip.io:9007
+#...
+```    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Env | String | false | default | The environment in which CluedIn will run. 
+
+

4.1.1/createorg.md

@@ -0,0 +1,40 @@
+---
+title: createorg
+parent: v4.1.1
+---
+
+# createorg
+
+Creates a new organization in CluedIn.
+{: .fs-6 .fw-300 }
+
+When creating a new organization an organization admin account is also created.
+The associated login details are returned.
+
+## Syntax
+
+```
+createorg [[-Env] <string>] -Name <string> [-Email <string>] [-Pass <string>] [-AllowEmailSignup] 
+```
+
+```powershell
+> .\cluedin.ps1 createorg -Name example
+
++-------------------------------+
+| CluedIn - Create Organization |
++-------------------------------+
+
+#...
+Email: admin@example.com
+Password: P@ssword!123
+```    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Env | String | false | default | The environment in which CluedIn will run. 
+| Name | String | true |  | The name of the organization to created. 
+| Email | String | false | "admin@${Name}.com" | The email/username of the organization admin. 
+| Pass | String | false | P@ssword!123 | The password of the organization admin. 
+| AllowEmailSignup | Flag | false | False | If set to true, will allow direct email sign up for future users<br />using an email that matches the organization admins email domain. 
+
+

4.1.1/data.md

@@ -0,0 +1,62 @@
+---
+title: data
+parent: v4.1.1
+---
+
+# data
+
+Identifies and clears data for an instance of CluedIn.
+{: .fs-6 .fw-300 }
+
+When an environment is started, one or more services may store data
+outside of the container so that it can be used for future scenarios.
+This command enables identification and removal of persisted data.
+
+## Get Details
+
+```
+data [[-Env] <string>] 
+```
+
+Displays information on the persisted data for an environment.
+e.g
+```
+> .\cluedin.ps1 data
+Name          Size      Items
+----          ----      -----
+elasticsearch 0.49 MB      56
+neo4j         0.91 MB      43
+sqlserver     240.06 MB    32
+```    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Env | String | false | default | The environment in which CluedIn will run. 
+
+## Clear All
+
+```
+data [[-Env] <string>] -CleanAll 
+```
+
+Forces all persisted data for all services to be wiped from disk.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Env | String | false | default | The environment in which CluedIn will run. 
+| CleanAll | Flag | true | False | Clears all data for all services. 
+
+## Clear Service(s)
+
+```
+data [[-Env] <string>] -Clean <string[]> 
+```
+
+Removes the persisted data for one or more services.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Env | String | false | default | The environment in which CluedIn will run. 
+| Clean | String[] | true |  | Specify one or more service names who's data is to be cleared. 
+
+

4.1.1/down.md

@@ -0,0 +1,27 @@
+---
+title: down
+parent: v4.1.1
+---
+
+# down
+
+Terminates a running instance of CluedIn.
+{: .fs-6 .fw-300 }
+
+Running `down` will stop all containers and persisted data.
+The images themselves will not be removed, so this command
+can be used to effectively clear out an instance, ready to
+run again from a clean state.
+
+## Syntax
+
+```
+down [[-Env] <string>] [-KeepData] 
+```
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Env | String | false | default | The environment in which CluedIn will run. 
+| KeepData | Flag | false | False | If set, data for services will be retained for future use. 
+
+

4.1.1/env.md

@@ -0,0 +1,98 @@
+---
+title: env
+parent: v4.1.1
+---
+
+# env
+
+Management of CluedIn environments.
+{: .fs-6 .fw-300 }
+
+Environments allow alternative configurations of CluedIn to be managed
+at the same time.
+
+Using environments, you can configure different versions of CluedIn,
+configure different packages, validate different imports of data, and more.
+
+## Get
+
+```
+env [[-Name] <string>] [-Get] 
+```
+
+Displays current variables for an environment.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Name | String | false | default | The environment in which CluedIn will run. 
+| Get | Flag | false | False | When set, displays information about the environment. 
+
+## Tag Override
+
+```
+env [[-Name] <string>] -TagOverride <string[]> 
+```
+
+Enables overriding specific services with their own version of CluedIn.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Name | String | false | default | The environment in which CluedIn will run. 
+| TagOverride | String[] | true | @() | The CluedIn version tag to use for specific services.<br />The names or services match those reported by docker when starting CluedIn<br />e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta` 
+
+## Remove
+
+```
+env [[-Name] <string>] -Remove 
+```
+
+Removes an environment completely.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Name | String | false | default | The environment in which CluedIn will run. 
+| Remove | Flag | true | False | When set, fully removes the environment from disk. 
+
+## Unset
+
+```
+env [[-Name] <string>] -Unset <string[]> 
+```
+
+Removes the current setting for a variable.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Name | String | false | default | The environment in which CluedIn will run. 
+| Unset | String[] | true |  | The names of variables to be unset in the environment. 
+
+## Tag
+
+```
+env [[-Name] <string>] -Tag <string> [-TagOverride <string[]>] 
+```
+
+Set the default tag to be used for all CluedIn services.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Name | String | false | default | The environment in which CluedIn will run. 
+| Tag | String | true | [string]::Empty | The CluedIn version tag to use for all services. 
+| TagOverride | String[] | true | @() | The CluedIn version tag to use for specific services.<br />The names or services match those reported by docker when starting CluedIn<br />e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta` 
+
+## Set
+
+```
+env [[-Name] <string>] -Set <string[]> [-Tag <string>] [-TagOverride <string[]>] 
+```
+
+Set one or more variables within an environment.    
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Name | String | false | default | The environment in which CluedIn will run. 
+| Set | String[] | true |  | Variables to set within the environment.<br />e.g. `-set CLUEDIN_SERVER_LOCALPORT=9988,CLUEDIN_SQLSERVER_LOCALPORT=9533` 
+| Tag | String | true | [string]::Empty | The CluedIn version tag to use for all services. 
+| TagOverride | String[] | true | @() | The CluedIn version tag to use for specific services.<br />The names or services match those reported by docker when starting CluedIn<br />e.g. `-tagoverride server=3.2.4-beta,sqlserver=3.2.4-beta` 
+
+

4.1.1/index.md

@@ -0,0 +1,11 @@
+---
+has_toc: False
+title: v4.1.1
+has_children: True
+---
+
+# Release Notes - v4.1.1
+
+## Features
+## Fixes
+

4.1.1/open.md

@@ -0,0 +1,25 @@
+---
+title: open
+parent: v4.1.1
+---
+
+# open
+
+Opens CluedIn.
+{: .fs-6 .fw-300 }
+
+Starts CluedIn in the default browser using the environments configured
+host/port information.
+
+## Syntax
+
+```
+open [[-Env] <string>] [-Org <string>] 
+```
+
+| Parameter | Type | Required | Default Value | Description |
+| --------- | ---- | -------- | ------------- | ----------- |
+| Env | String | false | default | The environment in which CluedIn will run. 
+| Org | String | false | app | Open the sign in page for the specified organization. 
+
+