> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/english-v14/apps/apps.md).

# Apps

## What are apps?

{% hint style="warning" %}
This chapter is intended for experienced users and administrators.

Incorrect settings in this chapter could damage the system or cause costs.
{% endhint %}

Apps are an integral part of eliona. Apps can be used to extend eliona's functionality and integrate eliona with other systems.

However, apps are also demanding and sometimes require programming knowledge. If mishandled, apps can even damage the system.

Eliona offers *Internal apps,* which are part of Eliona by default (system applications). For project-specific requirements, *External apps* can be written to meet them. For app development, go to Eliona's [GitHub page](https://github.com/eliona-smart-building-assistant).

## Open app overview

<div data-full-width="false"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/N01FtvW9ZuNF9rXQceGU/Docs%20-%20Apps%201.png" alt=""><figcaption></figcaption></figure></div>

In the app overview you can see all available apps. Through the app overview you can install and uninstall apps.

1. Click on **Settings \[A]**
2. Click on **Apps \[B]**\
   ▷ The app overview opens

<table data-full-width="false"><thead><tr><th width="142.33333333333331">Element</th><th>Title</th><th>Details</th></tr></thead><tbody><tr><td><strong>[C]</strong></td><td>App overview</td><td>All existing apps are displayed here</td></tr><tr><td><strong>[D]</strong></td><td>Filter “Type”</td><td>Filter ↗ apps by type. Available are:</td></tr><tr><td><strong>[E]</strong></td><td>App filter</td><td>Choose whether all, only installed, or only not installed apps should be shown in the app overview.</td></tr><tr><td><strong>[F]</strong></td><td>Search</td><td>click to open the search mask</td></tr></tbody></table>

## Install apps

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/gV58H0IerpmXw5Vv9DOv/Docs%20-%20Apps%202.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The exact information for installing apps can be found in the documentation for the individual apps
{% endhint %}

1. Open the [↗ App overview](#app-uebersicht-aufrufen)
2. For the app you want to install: Click on **Install \[F]**\
   ▷The “Install” pop-up opens
3. Configure the app.

<table data-full-width="false"><thead><tr><th width="111.33333333333331" align="center">Element</th><th width="255">Title</th><th>Details</th></tr></thead><tbody><tr><td align="center"><strong>[K]</strong></td><td>App installation window</td><td></td></tr><tr><td align="center"><strong>[L]</strong></td><td>General</td><td>General settings</td></tr><tr><td align="center"><strong>[L1]</strong></td><td>API key</td><td>Enter the API key.</td></tr><tr><td align="center"><strong>[L2]</strong></td><td>Image link</td><td>Optional: Add a link to an image</td></tr><tr><td align="center"><strong>[M]</strong></td><td>External port</td><td></td></tr><tr><td align="center"><strong>[M1]</strong></td><td>Add port</td><td>Click to add a port</td></tr><tr><td align="center"><strong>[M2]</strong></td><td>Target port</td><td>Specify a target port</td></tr><tr><td align="center"><strong>[M3]</strong></td><td>Port type</td><td>Select a port type</td></tr><tr><td align="center"><strong>[M4]</strong></td><td>External port</td><td>Specify an external port</td></tr><tr><td align="center"><strong>[M5]</strong></td><td>Add note</td><td>Opens the options <strong>[M6]</strong> and <strong>[M7]</strong>. Information about these options can be found in the documentation for the respective apps.</td></tr><tr><td align="center"><strong>[M6]</strong></td><td>Enter value</td><td>Enter a value.</td></tr><tr><td align="center"><strong>[M7]</strong></td><td>Enter key</td><td>Enter a key.</td></tr><tr><td align="center"><strong>[M8]</strong></td><td>Add label</td><td>Opens the options <strong>[M9]</strong> and <strong>[M10]</strong>. Information about these options can be found in the documentation for the respective apps.</td></tr><tr><td align="center"><strong>[M9]</strong></td><td>Value</td><td>Enter a value</td></tr><tr><td align="center"><strong>[M10]</strong></td><td>key</td><td>Enter a key</td></tr><tr><td align="center"><strong>[N]</strong></td><td>Environment variables</td><td></td></tr><tr><td align="center"><strong>[N1]</strong></td><td>Add variable</td><td></td></tr><tr><td align="center"><strong>[N2]</strong></td><td>Enter value</td><td>Enter a value</td></tr><tr><td align="center"><strong>[N3]</strong></td><td>Enter key</td><td>Enter a key</td></tr></tbody></table>

## Uninstall app

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/yQKY4yNChSvn9gWpTFbw/Docs%20-%20Apps%203.png" alt=""><figcaption></figcaption></figure>

1. Open the [↗ App overview](#app-uebersicht-aufrufen)
2. For the app you want to uninstall: Click on **Uninstall \[H]** ▷The “Install” pop-up **\[O]** opens
3. Click on **\[O1]**, to uninstall the app.

## Update app

If a new version is available for apps, the option appears **Update \[I]**

## App types

### Core apps

{% hint style="warning" %}
Changes to the core apps can impair Eliona's functionality. Only very experienced users and administrators should be in this area.
{% endhint %}

Core apps are integral parts of Eliona and are responsible for important basic functions.

### System apps

System apps are shipped with Eliona by default and allow connection to additional services

### Apps

Ordinary apps expand Eliona's functionality. When this chapter refers to apps, it usually means these apps.

### Agents

Agents are responsible for communication with external devices. Most functions of agents are now handled by core apps.

## Restart app

{% hint style="danger" %}
**Attention** When restarting an app, information from the app may be lost.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/bbTX0eYJWnThEfzM1WRy/Docs_Apps%20Restart.png" alt=""><figcaption></figcaption></figure>

1. Click on **\[J]**\
   ▷ The app settings **\[P]** open
2. Click on **\[P1]**, to restart the app\
   ▷ The window **\[P2]** opens
3. Click on **\[P3]**, to confirm the restart

### App configuration

Detailed instructions for configuring apps can be found on the documentation page for apps. Each app also has its own documentation page, which contains specific configuration instructions for the app.

{% embed url="<https://drive.google.com/file/d/1JBRLqjZxhVZ8O_USArE3mRxrBuRk1DOE/view>" %}
App configuration
{% endembed %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.buildings.ability.abb/collection/english-v14/apps/apps.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.