Installation and Configuration
Installing an App makes it available to your organization's users. The entire process — from browsing the App Store to a running deployment — happens through a single wizard and takes only a few clicks.
Installing an App
Each App card in the App Store has action buttons at the bottom:
| Button | Purpose |
|---|---|
| Details | Opens a drawer with version, description, keywords, and dependencies |
| Use as Template | Opens the App's source code in Operaide Studio for use as a starting point |
| Deploy | Downloads the App and starts the installation wizard |
Click Deploy on the App you want to set up. The platform downloads the package from the registry, then opens the App Instance Wizard.
The Installation Wizard
The wizard guides you through three steps:
Step 1 — Select App
The App and version are pre-selected from the card you clicked. You provide:
| Field | Description |
|---|---|
| Instance Name | A URL-safe identifier, unique within your organization (e.g. support-chat, internal-chat) |
| Display Label | An optional human-readable name shown in the UI |
If the instance name is already taken, an error message appears before you can proceed.
Step 2 — Settings
The wizard presents two categories of settings:
- App Instance Settings — settings that apply to the App and all its reaktors as a whole (e.g. a display label).
- Reaktor Settings — each Reaktor within the App can define its own settings (e.g. a system prompt, a database ID, or a connection name). The wizard shows these grouped by Reaktor.
The forms are generated automatically from the settings each App declares — the fields you see depend entirely on the App. If the App has no configurable settings, this step is skipped.
Step 3 — Summary and Deploy
Review the configuration and click Deploy. The platform creates the App Instance and deploys all Reaktors defined by the App. Once deployment finishes, the App is live and accessible to users in your organization.
Configuring Settings After Installation
Settings can be changed at any time after installation. An App has two levels of settings:
App Instance Settings
These are the settings you configured during the wizard. To change them:
- Navigate to App Instances in the sidebar and click the instance.
- Open the Settings tab.
- Modify the values and save.
Reaktor Settings
Each Reaktor within an App can have its own settings — for example, a database connection ID or a system prompt specific to that Reaktor. To change them:
- Navigate to App Instances in the sidebar.
- Click your App in the table.
- Open the Reaktors tab.
- Click the Reaktor you want to configure.
- Open the Settings tab.
- Modify the values and save.
Changes to both App Instance and Reaktor settings take effect immediately.
Updating an App to a New Version
When a developer publishes a new version of an existing App, the updated version appears in the App Store automatically. If a newer compatible version is available for an already installed App, the App Store card shows an update option.
The update process diffs old and new Reaktor definitions: new Reaktors are added, removed ones are deleted, and existing ones are updated in place. Configuration settings are preserved where possible.
Core App Guides
Each Core App has a dedicated setup guide covering prerequisites, configuration, and verification:
| App | Package | Guide |
|---|---|---|
| Chat | core-operaide-chat | Chat App |
Example Walkthrough
For a step-by-step walkthrough of the installation wizard - including AI Provider, Connection, and database settings - follow the Chat App guide.
Permissions
App installation and configuration require the following permissions:
| Permission | Description | Default roles |
|---|---|---|
| Install Apps | Install Apps from the store into the organization | App Manager |
| Delete Apps | Remove installed Apps | App Manager |
| Access App Instances | View and manage App Instances | App Manager |
| Create App Instances | Create new App Instances with the wizard | App Manager |
| Delete App Instances | Remove App Instances and their deployments | App Manager |