Kentico.Xperience.AiraUnified 0.3.2-prerelease-4

Xperience by Kentico Aira Unified

Description

The Aira Unified integration provides an alternative administration UI and a chatbot that can be easily added to an Xperience by Kentico project. It is designed for content editors and marketers who need essential functionality on mobile devices.

Screenshots

Library Version Matrix

Dependencies

• ASP.NET Core 8.0
• Xperience by Kentico
• Node.js 20.10.0 or newer (for development)

Full Instructions

To activate the communication of the Aira Unified app with the Aira service, you need to request an activation key. Please contact us at productmanagement@xperience.io for more information.

Follow the steps below to add the Aira Unified app to your Xperience project.

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.AiraUnified

Quick Start

1. Add the Aira Unified configuration to your appsettings.json. The minimal required configuration is:

"AiraUnifiedOptions": {
  "AiraUnifiedApiSubscriptionKey": "<your Aira Unified API key>"
}

For development and testing purposes, you can override default settings:

"AiraUnifiedOptions": {
  "AiraUnifiedApiSubscriptionKey": "<your Aira Unified API key>",
  "AiraUnifiedAIEndpoint": "https://your-custom-endpoint.com/api",
  "AiraUnifiedUseMockClient": true
}

For detailed configuration options, see Configuration Options.

2. Configure your project for HTTPS.

3. Include the Kentico.Xperience.AiraUnified package in your project:

   dotnet add package Kentico.Xperience.AiraUnified
   

4. Register the required services in Program.cs:

   var builder = WebApplication.CreateBuilder(args);
   
   // ...
   
   builder.Services.AddKenticoAiraUnified(builder.Configuration);
   
   // ...
   
   var app = builder.Build();
   
   // ...
   
   app.UseAiraUnifiedEndpoints();
   
   app.Run();
   

5. Configure the Aira Unified settings in the administration UI: Open the Aira Unified application in the Xperience administration. Fill in:

   • Relative Path Base: Defines where Aira Unified is available.
   • Logo: Select an asset from the Media Library.
   • Chat Title: Title for the chat page.
   • Smart Upload Title: Title for the smart upload page.
   • Workspace: The workspace used by the smart uploader.

6. Set up a Content Type for Mass Asset Upload.

7. Configure role-based permissions in the Role Management application:

   • View: Access the Aira Unified chat.
   • Create: Access and upload content via Smart Upload.

8. Users can now sign in to the Aira Unified app - <your-path-base>/signin.

For usage instructions, see Usage Guide.

For upgrade instructions, see Upgrades.

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Kentico Labs limited support.

See SUPPORT.md for more information.

This feature is currently in Preview mode. Do not use it for production instances.

For any security issues, see SECURITY.md.