GitBook: [master] 76 pages modified

Author: kimburgess

README.md

@@ -1,18 +1,16 @@
 ---
 description: >-
-  ACAEngine is a platform for creating digital experiences for physical
+  Engine is a platform for creating digital experiences for physical
   environments. It connects devices, hardware systems and third-party software
   to provide an API for the built environment.
 ---
 
-# What is ACAEngine
+# What is Engine?
 
 {% hint style="success" %}
 If you’ve used traditional, hardware-based control systems before, welcome to the new world.
 {% endhint %}
 
->
-
 * **Software only** built on the modern web.
 * **Open source** continuously improved and backed by a full-time team of developers.
 * **Extensible** able to run stand-alone, or integrated into staff, building or third party apps.
@@ -31,5 +29,5 @@ There are no restrictions on what can be built, but here are some examples of [w
 
 ## Who builds it?
 
-[ACA Projects](https://www.acaprojects.com/staff) are a fast-paced team of developers and designers based across Australia, Singapore, Hong Kong, Shanghai and London. We believe in modern tech and despise black boxes.
+[Place Technology](https://place.technology) is a team of developers, designers and technologists based across Australia, Singapore, Hong Kong, Shanghai and London. We believe in modern tech and despise black boxes.
 

SUMMARY.md

@@ -1,6 +1,6 @@
 # Table of contents
 
-* [What is ACAEngine](README.md)
+* [What is Engine?](README.md)
 * [Key Concepts](key-concepts/README.md)
   * [Drivers](key-concepts/drivers.md)
   * [Modules](key-concepts/modules.md)
@@ -15,7 +15,7 @@
 
 * [System Architecture](deployment/architecture.md)
 * [Single Sign-On](deployment/single-sign-on/README.md)
-  * [Configuring ACAEngine for SAML2](deployment/single-sign-on/configuring-acaengine-for-saml2.md)
+  * [Configuring Engine for SAML2](deployment/single-sign-on/configuring-acaengine-for-saml2.md)
   * [SAML2 with Azure AD](deployment/single-sign-on/saml2-with-azure-ad.md)
   * [SAML2 with ADFS](deployment/single-sign-on/saml2-with-adfs.md)
   * [SAML2 with Auth0](deployment/single-sign-on/saml2-with-auth0.md)
@@ -93,6 +93,5 @@
 
 ## Support
 
-* [Tech Chat](support/chat.md)
 * [Service Desk](https://support.acaprojects.com)
 

deployment/architecture.md

@@ -1,6 +1,6 @@
 # System Architecture
 
-ACAEngine is packaged and distributed as a set of Docker containers for deployment within private cloud, or on-premise infrastructure. All application components run on hosts owned and managed by your organistation.
+Engine is packaged and distributed as a set of Docker containers for deployment within private cloud, or on-premise infrastructure. All application components run on hosts owned and managed by your organistation.
 
 ## Application Services
 
@@ -24,15 +24,15 @@ A dedicated search service is used to provide fast, efficient access to informat
 
 ## External Components
 
-In addition to the core application services, a number of external components contribute to the overall deployment environment. These are not created as part of ACAEngine, but may require configuration as part of the deployment.
+In addition to the core application services, a number of external components contribute to the overall deployment environment. These are not created as part of Engine, but may require configuration as part of the deployment.
 
 ### ![](../.gitbook/assets/components-client.svg) Clients
 
-Clients are devices running interfaces distributed by Web nodes, or native apps and other services which use the ACAEngine API. Common examples may be a phone running a staff app, room booking panels or wayfinding displays.
+Clients are devices running interfaces distributed by Web nodes, or native apps and other services which use the Engine API. Common examples may be a phone running a staff app, room booking panels or wayfinding displays.
 
 ### ![](../.gitbook/assets/components-identity.svg) Identity Provider
 
-Interactions with ACAEngine must be associated with a valid user. To simplify UX and improve security, authentication integrates tightly with existing identity providers operating in an environment. This may be services such as Azure AD, Google Sign-In or other services providing SAML or OAuth2 endpoints.
+Interactions with Engine must be associated with a valid user. To simplify UX and improve security, authentication integrates tightly with existing identity providers operating in an environment. This may be services such as Azure AD, Google Sign-In or other services providing SAML or OAuth2 endpoints.
 
 ### ![](../.gitbook/assets/components-load-balancer.svg) Load Balancer
 

deployment/single-sign-on/configuring-acaengine-for-saml2.md

@@ -1,25 +1,25 @@
 ---
 description: >-
-  Steps required for enabling SAML2 sign on for users logging in to all
-  ACAEngine web apps
+  Steps required for enabling SAML2 sign on for users logging in to all Engine
+  web apps
 ---
 
-# Configuring ACAEngine for SAML2
+# Configuring Engine for SAML2
 
-By default, ACAEngine uses local authentication. An admin account is generated upon initial deployment and the administrator can manually create additional user accounts in the ACAEngine Backoffice \(on the Users tab\).
+By default, Engine uses local authentication. An admin account is generated upon initial deployment and the administrator can manually create additional user accounts in the Backoffice \(on the Users tab\).
 
 Switching to federated authentication is recommended. There are 3 steps required:
 
-1. In ACAEngine Backoffice, create a new SAML2 Identity provider entry
-2. In your organisation's SAML2 Identity provider dashboard \(e.g. Azure AD, ADFS, Auth0\), create the SAML2 Service provider for entry for ACAEngine
-3. Back in ACAEngine Backoffice, update the SAML2 Identity provider entry with the new details retrieved from step 2
+1. In Backoffice, create a new SAML2 Identity provider entry
+2. In your organisation's SAML2 Identity provider dashboard \(e.g. Azure AD, ADFS, Auth0\), create the SAML2 Service provider for entry for Engine
+3. Back in Backoffice, update the SAML2 Identity provider entry with the new details retrieved from step 2
 
 ## Prerequisites
 
 1. The domain where users will visit to login must exist as a valid **DNS** entry 
-2. Browsers should consider the domain secure: Valid **SSL certificates** should be in place and served by either your load balancer or the web server in front of ACAEngine.
+2. Browsers should consider the domain secure: Valid **SSL certificates** should be in place and served by either your load balancer or the web server in front of Engine.
 
-## Step 1: Add a new SAML2 authentication source to ACAEngine
+## Step 1: Add a new SAML2 authentication source
 
 1. Login as an admin to backoffice \([https://&lt;engine-url&gt;/backoffice/\](https://<engine-url>/backoffice/\)\)
 2. On the **Domains** tab, select the Domain that represents the URL you wish to enable SAML2 for.
@@ -80,7 +80,7 @@ Switching to federated authentication is recommended. There are 3 steps required
    2. Example: If you copied _"_[https://engine.example-organisation.com/auth/adfs?id=adfs-XXXXXXXX](https://engine.example-organisation.com/auth/adfs?id=adfs-XXXXXXXX)_"_ then set the Assertion URL to "_https://engine.example-organisation.com/auth/adfs/callback?id=**adfs-XXXXXXXX**"_
    3. Click Save
 
-## Step 2: Register ACAEngine as new service/app in your authentication provider
+## Step 2: Register a new service/app in your authentication provider
 
 ### Prerequisites
 
@@ -97,13 +97,13 @@ Follow the instructions for your Identity Provider:
 * [ADFS](saml2-with-adfs.md)
 * [Auth0](saml2-with-auth0.md)
 
-## Step 3: Update the ACAEngine SAML2 authentication source settings
+## Step 3: Update the SAML2 authentication source settings
 
-You will enter these details from Step 2 into ACAEngine Backoffice:
+You will enter these details from Step 2 into Backoffice:
 
 ### Prerequisites
 
-1. **Issuer** \(also known as **Identifier**\): If your ID provider defines an Identifier instead of letting you define one, Update the ACAEngine auth settings to use the required Identifier. 
+1. **Issuer** \(also known as **Identifier**\): If your ID provider defines an Identifier instead of letting you define one, Update the auth settings to use the required Identifier. 
 
    For example, Azure AD defines fixed identifiers in the form _"spn:00000000-0000-0000-0000-000000000000"_  where the 0 digits are the _Application \(client\) ID_, found on the Overview page of the Azure AD Application.
 
@@ -115,10 +115,10 @@ You will enter these details from Step 2 into ACAEngine Backoffice:
 
 ### Update Engine's new authentication settings
 
-Start by clicking edit \(pen icon\) on the Authentication that was created in Step 1 _"Add a new SAML2 authentication source to ACAEngine"_ \(top of this page\)
+Start by clicking edit \(pen icon\) on the Authentication that was created in Step 1 _"Add a new SAML2 authentication source"_ \(top of this page\)
 
 1. Replace the **Issuer** field with the Issuer from your SAML2 ID provider \(unless your SAML2 ID provider already matches\)
-2. Replace the **IDP Target URL** field with the SAML2 Identity provider login url that was generated in Step 2 _"Register ACAEngine as new service/app on your authentication provider"_
+2. Replace the **IDP Target URL** field with the SAML2 Identity provider login url that was generated in Step 2 _"Register a new service/app on your authentication provider"_
 3. Paste the long X509Certificate string into the **Full Certificate** field, without any appended/prepended text.
 4. Click Save
 

deployment/single-sign-on/saml2-with-adfs.md

@@ -1,6 +1,6 @@
 # SAML2 with ADFS
 
-If using ADFS, [these steps](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust) can generally be followed. ACAEngine will use these four SAML2 claims:
+If using ADFS, [these steps](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust) can generally be followed. Engine will use these four SAML2 claims:
 
 * Firstname
 * Lastname

deployment/single-sign-on/saml2-with-auth0.md

@@ -2,14 +2,14 @@
 
 ## Prerequesites
 
-* You are an administrator of an Auth0 domain and would like ACAEngine user to be redirected to this Auth0 domain for signup and SSO login.
+* You are an administrator of an Auth0 domain and would like Engine user to be redirected to this Auth0 domain for signup and SSO login.
 
 ## Auth0 configuration
 
 * Follow [these instructions](https://auth0.com/docs/dashboard/guides/applications/register-app-spa) to create a register a single-page-app for SAML2 SSO using Auth0
-* The `Name` of the applicaiton can be the domain name on which your instance of ACAEngine is located.
+* The `Name` of the applicaiton can be the domain name on which your instance of Engine is located.
 * On the `Addons` tab, enable SAML2 Web App and use [these steps](https://auth0.com/docs/protocols/saml/saml2webapp-tutorial) as a guide.
-* Set the `Application Callback URL` to match ACAEngine's `Assertion URL` \(e.g. [https:///auth/adfs/callback?id=adfs-XXXXXX\](https:///auth/adfs/callback?id=adfs-XXXXXX%29\)
+* Set the `Application Callback URL` to match Engine's `Assertion URL` \(e.g. [https:///auth/adfs/callback?id=adfs-XXXXXX\](https:///auth/adfs/callback?id=adfs-XXXXXX%29\)
 * Paste in the below for `Settings`:
 
   ```text

deployment/single-sign-on/saml2-with-azure-ad.md

@@ -1,17 +1,17 @@
 # SAML2 with Azure AD
 
-If using Azure Active Directory for SSO a new or exisiting "App Registration" will need to be configured to provide be the SAML2 identity provider for ACAEngine.
+If using Azure Active Directory for SSO a new or exisiting "App Registration" will need to be configured to provide be the SAML2 identity provider for Engine.
 
 ## Step 1 - New or Existing App Registration
 
 * Login to portal.azure.com and browse to [Azure AD > App Registrations](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps)
 * Locate the existing app that was created for [o365 Graph API access](https://github.com/acaprojects/docs/tree/be220954cefb53b2ac2ca82f775a56993117e99d/deployment/single-sign-on/integrations/directory-services/microsoft-office365.md). If none has been created yet, then create a new app registration now, as this app can be used for both SSO and o365 Graph API access.
   * If creating a NEW app registration:
     * Name it and select the appropriate "Support Account types" \(which is usually "Single tenant"\).
-    * Paste the ACAEngine **Assertion URL** \(generated in Step 1 of [Configuring ACAEngine for SAML2](configuring-acaengine-for-saml2.md)\) into the **Reply URL** field. Leave the type as "Web". Click Register to finish.
+    * Paste the ACAEngine **Assertion URL** \(generated in Step 1 of [Configuring Engine for SAML2](configuring-acaengine-for-saml2.md)\) into the **Reply URL** field. Leave the type as "Web". Click Register to finish.
   * If configuring an existing app registration:
     * Navigate to Overview -> Redirect URIs
-    * Paste the ACAEngine **Assertion URL** \(generated in Step 1 of [Configuring ACAEngine for SAML2](configuring-acaengine-for-saml2.md)\) into the **Redirect URI** field. Leave the type as "Web". Click Save to finish.
+    * Paste the ACAEngine **Assertion URL** \(generated in Step 1 of [Configuring Engine for SAML2](configuring-acaengine-for-saml2.md)\) into the **Redirect URI** field. Leave the type as "Web". Click Save to finish.
 * Confirm that you have access to the [SAML2 Federation Metadata URL](https://docs.microsoft.com/en-us/azure/active-directory/azuread-dev/azure-ad-federation-metadata) for your Azure Tenant. This is generally in the below format. Data in this XML file may be used later in Step 3, OR can be used to configure advanced custom claims.
 
   * https://login.microsoftonline.com/<Tenant ID or Domain Name>/FederationMetadata/2007-06/FederationMetadata.xml 
@@ -53,17 +53,17 @@ Now two fields of the app Manifest need to be edited \(`groupMembershipClaims` a
 
 * Click Save
 
-## Step 3 - Collect data required by ACAEngine Backoffice
+## Step 3 - Collect data required by Backoffice
 
-The App Registration is now configured for Engine. Three pieces of info are required to be entered back into ACAEngine \(Step 3 of [Configuring ACAEngine for SAML2](configuring-acaengine-for-saml2.md)\):
+The App Registration is now configured for Engine. Three pieces of info are required to be entered back into Backoffice \(Step 3 of [Configuring Engine for SAML2](configuring-acaengine-for-saml2.md)\):
 
 ### **Issuer**
 
 For Azure AD the "Issuer" will be the "Application \(client\) ID" found on the Overview page of your App Registrating, but with "spn:" added to the front. E.g. _"spn:00000000-0000-0000-0000-000000000000"_ where the 0 digits are the Application \(client\) ID from Azure AD. Paste this value into the Issuer field of the SAML2 auth object that was created in ACAEngine.
 
 ### **IDP Target URL**
 
-Also known as **SAML2 sign-on endpoint.** This is the url that ACAEngine redirects users to in order to login with your SAML2 ID provider. For Azure AD it is : [**https://login.microsoftonline.com/**](https://login.microsoftonline.com/)**<TENANT-ID>/**_**saml2**_ _\*\*_ where the Directoy \(tenant\) ID can be seen on the Overview tab of your Azure App Registration. Paste this into the IDP Target URL field of the SAML2 auth object that was created in ACAEngine
+Also known as **SAML2 sign-on endpoint.** This is the url that Engine redirects users to in order to login with your SAML2 ID provider. For Azure AD it is : [**https://login.microsoftonline.com/**](https://login.microsoftonline.com/)**<TENANT-ID>/**_**saml2**_ _\*\*_ where the Directoy \(tenant\) ID can be seen on the Overview tab of your Azure App Registration. Paste this into the IDP Target URL field of the SAML2 auth object that was created in Engine
 
 ### Full Certificate
 

integrations/directory-services/README.md

@@ -1,10 +1,10 @@
 ---
-description: Options for integrating ACAEngine with enterprise directory services.
+description: Options for integrating Engine with enterprise directory services.
 ---
 
 # Directory Services
 
-ACAEngine extends beyond IoT control/monitoring when integrated with one of several enterprise directory service options. Directory service integration enables the ACAEngine Staff API, which allows apps to offer experiences such as room searching/booking, user directory searching and calendar event information/interactions.
+Engine extends beyond IoT control/monitoring when integrated with one of several enterprise directory service options. Directory service integration enables the Engine Staff API, which allows apps to offer experiences such as room searching/booking, user directory searching and calendar event information/interactions.
 
 Data from directory services can be combined with IoT and/or location services data to add meaningful context to user interactions within a space. The result can be used to trigger an event in the space in real time or stored for retrospective analytics.