> For the complete documentation index, see [llms.txt](https://docs.editran.onesait.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.editran.onesait.com/documentacion-editran/connect-v3.1/instalacion/linux_actualizacion.md).

# Actualizacion Linux

Esta guía te ayudará a actualizar la versión de **Editran Connect** en Linux, paso a paso. La actualización puede realizarse para cambiar de versión o reinstalar un componente de la versión actual.

***

## Requisitos previos

Antes de empezar con el proceso de actualización debes asegurarte de:

1. tener instalada una versión de **Editran Connect** antes de proceder con la actualización.
2. Si vienes de una 2.1.x o inferior desinstala **Editran Core Connect**. Esto evitará conflictos entre ambas aplicaciones.
3. Verifica que el usuario que realiza la actualización tiene permisos de administrador.

> Se recomienda realizar una copia de seguridad completa de los datos, carpetas y archivos de **Editran Core Connect** antes de desinstalarlo. Del mismo modo, antes de actualizar **Editran Connect**, es fundamental hacer una copia de seguridad completa. Esto garantizará que puedas restaurar la información en caso de que ocurra algún problema durante el proceso.

***

## Instalación en entorno gráfico

A continuación, se describen los pasos de la instalación. El proceso es bastante sencillo y rápido de realizar. Asegúrate de tener un entorno de escritorio instalado (por ejemplo, GNOME, KDE).

## Paso 1: Inicio

Ejecuta el paquete de instalación que nos mostrará la siguiente pantalla de bienvenida:

![Inicio de la instalación](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-6612b0906b09a0a3aacb6bb76c24cebe5f02421f%2Finicio_instalacion.png?alt=media)

1. Asigna permisos al archivo de instalación, si es necesario:

   ```bash
   sudo chmod +x EditranConnect-3.0.x-linux-x64.run
   ```
2. Ejecuta el instalador:

   ```bash
   sudo ./EditranConnect-3.0.x-linux-x64.run
   ```
3. Haz clic en **Siguiente** para comenzar con el proceso

***

## Paso 2: Selección de componentes

En esta pantalla, podrás elegir qué componentes de la aplicación deseas instalar:

![Selección de componentes](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-4427ba19351ab1c14cbad9064ade5604582b4404%2Fupgrade_seleccion_componentes.png?alt=media)

1. Algunos componentes son obligatorios actualizar, por ello aparecen marcados y deshabilitados.
2. Algunos componentes son recomendados para actualizar, por ello aparecen marcados y habilitados.
3. Se recomienda dejar la selección por defecto, si no estás seguro de qué componentes seleccionar.
   * **Java**: Selecciona este componente si necesitas actualizar o reinstalar el software de Java.
   * **PostgreSQL**: Selecciona este componente si necesitas actualizar o reinstalar el software del motor de base de datos PostgreSQL.
   * **Nginx**: Selecciona este componente si necesitas actualizar o reinstalar el software del servidor web Nginx, o bien si necesitas cambiar el certificado SSL.
   * **Módulo de firma**: Selecciona este componente si necesitas actualizar o reinstalar el módulo de firma.
4. Haz clic en **Siguiente** para continuar.

***

## Paso 3: Aviso

En esta pantalla, se te informará que la instalación detecta una versión anterior de **Editran Connect** instalada en el sistema. Además, se te indicará que la instalación actualizará la versión actual a la nueva versión. Asegúrate de no tener ninguna instancia de **Editran Connect** abierta durante el proceso de actualización.

![Aviso de actualización](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-e4f8ebf6b1dca2e9e0823ad00612f897d06ce65d%2Fupgrade_aviso.png?alt=media)

Haz clic en **Siguiente** para continuar. Si el componente **PostgreSQL** o **Nginx** está marcado, continúa en el **Paso 4**, y en caso contrario continúa en el **Paso 5**.

***

## Paso 4: Distribución de Linux

En esta pantalla, puedes seleccionar la distribución de Linux que estás utilizando:

![Distribución de Linux](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-30ba2f0a3bebf03077f0b2ade0c7f89d190934bd%2Fdistribucion_linux.png?alt=media)

1. Selecciona la distribución de Linux que estás utilizando. Si no estás seguro, puedes dejar la opción predeterminada.
   * **Debian**: Para distribuciones basadas en Debian (Ubuntu, Mint).
   * **Red Hat**: Para distribuciones basadas en Red Hat (Fedora, CentOS).
   * **Otras distribuciones**: Para otras distribuciones no soportadas oficialmente.
2. Es importante seleccionar la distribución correcta, ya que esto afectará a la instalación de los paquetes necesarios para el funcionamiento de la aplicación.
3. Haz clic en **Siguiente** para continuar.

***

## Paso 5: Configuración. Certificado

Esta pantalla estará disponible si el componente **Nginx** está seleccionado en el **Paso 2**. En caso contrario, se omitirá este paso. Puedes seleccionar los archivos de un certificado propio autofirmado:

* **Certificado**: Archivo del certificado (.pem).
* **Clave del certificado**: Archivo de la clave privada (.key).

![Configuración. Certificado](https://gitlab.devops.onesait.com/onesait/disruptors/ecosystems-editran/editran-documentation/-/blob/public/connect/3.1/instalacion/broken-reference)

1. Se actualizará el certificado de firma de la aplicación.
2. Esta información es opcional. Si no especificas un certificado, el instalador utilizará un certificado autofirmado provisional. Aunque es funcional, no tiene validez y deberá reemplazarse por un certificado SSL emitido por una autoridad certificadora.
3. Si deseas utilizar tu propio certificado, marca la opción **Especificar un certificado SSL** y selecciona los archivos correspondientes mediante el icono o escribe la ruta y el nombre manualmente.
4. Haz clic en **Siguiente** para continuar.

***

## Paso 6: Licencia

En esta pantalla, puedes seleccionar el archivo de licencia (.dat) si lo tienes. Este paso es opcional.

![Fichero de licencia](https://gitlab.devops.onesait.com/onesait/disruptors/ecosystems-editran/editran-documentation/-/blob/public/connect/3.1/instalacion/broken-reference)

Haz clic en **Siguiente** para continuar.

***

## Paso 7: Resumen

En esta pantalla, se te mostrará un resumen de la instalación que se va a realizar:

![Resumen de la instalación](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-174246cf1481f0944eb08613399597d0b79ebe4c%2Fupgrade_resumen_instalacion.png?alt=media)

Se mostrará, entre otras, la siguiente información:

* Versión a instalar
* Tipo de instalación (Actualización)
* Directorios
* ...

Haz clic en **Siguiente** para continuar.

***

## Paso 8: Confirmación

En esta pantalla se te indicará que está todo listo para realizar la instalación:

![Listo para instalar](https://gitlab.devops.onesait.com/onesait/disruptors/ecosystems-editran/editran-documentation/-/blob/public/connect/3.1/instalacion/broken-reference)

Haz clic en **Siguiente** para comenzar el proceso de instalación.

***

## Paso 9: Instalación en proceso

Antes de realizar la instalación propiamente dicha, se realizará una copia de seguridad de los archivos y carpetas de la instalación anterior.

![Copia seguridad](https://gitlab.devops.onesait.com/onesait/disruptors/ecosystems-editran/editran-documentation/-/blob/public/connect/3.1/instalacion/broken-reference)

La copia de seguridad se almacenará en un directorio con el mismo nombre que el directorio de la aplicación, añadiendo la extensión .backup al final. **Ruta predeterminada**: `/opt/EditranConnect.backup`.

Posteriormente, la instalación comenzará y se mostrará el progreso junto con los procesos en ejecución:

![Instalación en proceso](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-e1dcf5bfbc8d7433c32c84d8d07dece9a9b8d821%2Finstalacion_en_proceso.png?alt=media)

1. Dependiendo de los componentes seleccionados, se mostrarán diferentes pantallas durante el proceso de instalación.
2. Si el componente **PostgreSQL** está seleccionado en el **Paso 2**, y la versión de PostgreSQL instalada es anterior a la versión incluida en el instalador, se te preguntará si deseas actualizar PostgreSQL a la última versión.

   ![Selección de versión de PostgreSQL](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-dfb14c90fc4b2344cfda371a7586bb3c6cab8925%2Fupgrade_postgresql.png?alt=media)

   * Asegúrate de que la versión de PostgreSQL instalada es compatible con el sistema operativo de tu máquina. Si no es compatible o no estás seguro, selecciona **No**.
   * Si seleccionas **Sí**, se actualizará PostgreSQL.
3. Si los servicios no se inician correctamente, aparecerá un mensaje de advertencia. Consulta el apartado *Solución de problemas* para identificar la causa.

Espera a que el proceso termine.

***

## Paso 10: Instalación finalizada

Una vez finalizada la instalación, se mostrará una pantalla indicando que el proceso ha terminado

![Instalación finalizada](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-727a5d6c8bbce4f1e1fff0a76bd51978991ff457%2Finstalacion_finalizada.png?alt=media)

Haz clic en **Terminar**.

**¡Listo!** Ahora tienes la aplicación **Editran Connect** actualizada.

***

## Instalación en modo texto

A continuación, se describen los pasos de la instalación. El proceso es bastante sencillo y rápido de realizar. Asegúrate de tener un entorno de consola o terminal disponible.

## Paso 1: Inicio

1. Asigna permisos al archivo de instalación, si es necesario:

   ```bash
   sudo chmod +x EditranConnect-3.0.x-linux-x64.run
   ```
2. Ejecuta el paquete de instalación. El parámetro `--mode text` indica que deseas realizar la instalación en modo texto. No es necesario si el sistema no tiene entorno gráfico:

   ```bash
   sudo ./EditranConnect-3.0.x-linux-x64.run --mode text
   ```
3. Si deseas consultar los parámetros de instalación, puedes ejecutar el siguiente comando:

   ```bash
   sudo ./EditranConnect-3.0.x-linux-x64.run --mode text
   ```

***

## Paso 2: Selección de componentes

A continuación, podrás elegir qué componentes de la aplicación deseas instalar:

![Selección de componentes](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-f8e0ad01fbae650c048a033e7734efd487b2f609%2Fupgrade_seleccion_componentes_text.png?alt=media)

1. Algunos componentes son obligatorios, por ello no pueden editarse ni seleccionarse.
2. Algunos componentes son recomendados para actualizar, por ello aparecen marcados y habilitados.
3. Se recomienda dejar la selección por defecto, si no estás seguro de qué componentes seleccionar.
   * **Java**: Escribe **Y** en este componente si necesitas actualizar o reinstalar el software de Java.
   * **PostgreSQL**: Escribe **Y** en este componente si necesitas actualizar o reinstalar el software del motor de base de datos PostgreSQL.
   * **Nginx**: Escribe **Y** en este componente si necesitas actualizar o reinstalar el software del servidor web Nginx, o bien si necesitas cambiar el certificado SSL.
   * **Módulo de firma**: Escribe **Y** en este componente si necesitas actualizar o reinstalar el módulo de firma.
4. Pulsa **Enter** para continuar, o escribe **N** si quieres modificar la selección de componentes.

## Paso 3: Aviso

A continuación, se te informará que la instalación detecta una versión anterior de **Editran Connect** instalada en el sistema. Además, se te indicará que la instalación actualizará la versión actual a la nueva versión. Asegúrate de no tener ninguna instancia de **Editran Connect** abierta durante el proceso de actualización.

![Aviso de actualización](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-245140167699a6751a967e4e28118b11b4e59cb1%2Fupgrade_aviso_text.png?alt=media)

Pulsa **Enter** para continuar. Si el componente **PostgreSQL** o **Nginx** está seleccionado, continúa en el **Paso 4**, y en caso contrario continúa en el **Paso 5**.

***

## Paso 4: Distribución de Linux

A continuación, puedes seleccionar la distribución de Linux que estás utilizando:

![Distribución de Linux](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-3a3b3ce0eef5f8764bfe8154ffae1cc638a32355%2Fdistribucion_linux_text.png?alt=media)

1. Indica la distribución de Linux que estás utilizando. Si no estás seguro, puedes dejar la opción predeterminada.
   * **Debian**: Para distribuciones basadas en Debian (Ubuntu, Mint).
   * **Red Hat**: Para distribuciones basadas en Red Hat (Fedora, CentOS).
   * **Otras distribuciones**: Para otras distribuciones no soportadas oficialmente.
2. Es importante seleccionar la distribución correcta, ya que esto afectará a la instalación de los paquetes necesarios para el funcionamiento de la aplicación.
3. Escribe el número de la distribución y pulsa **Enter** para continuar.

***

## Paso 5: Configuración. Certificado

Esta información estará disponible si el componente **Nginx** está seleccionado en el **Paso 2**. En caso contrario, se omitirá este paso. Puedes seleccionar los archivos de un certificado propio autofirmado:

* **Certificado**: Archivo del certificado (.pem).
* **Clave del certificado**: Archivo de la clave privada (.key).

![Configuración. Certificado](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-a172a3c9eee67ba5fefabc91e43de4cfab9aa804%2Fconfiguracion_certificado_text.png?alt=media)

1. Se actualizará el certificado de firma de la aplicación.
2. Esta información es opcional. Si no especificas un certificado, el instalador utilizará un certificado autofirmado provisional. Aunque es funcional, no tiene validez y deberá reemplazarse por un certificado SSL emitido por una autoridad certificadora.
3. Si deseas utilizar tu propio certificado, escribe **Y** en **Especificar un certificado SSL**.
4. Pulsa **Enter** para continuar.
5. Seguidamente escribe nombre y ruta de los archivos del certificado.

***

## Paso 6: Licencia

A continuación, puedes seleccionar el archivo de licencia (.dat) si lo tienes. Este paso es opcional.

![Fichero de licencia](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-b6b0f9b4e5672fb7fc7ed50431cb3b7e475c8982%2Ffichero_licencia_text.png?alt=media)

1. Escribe nombre y ruta completa del fichero de licencia, en el caso de que quieras indicarla.
2. Pulsa **Enter** para continuar.

***

## Paso 7: Resumen

A continuación, se te mostrará un resumen de la instalación que se va a realizar:

![Resumen de la instalación](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-c22bfe90f97a436d3e3bcf6417d0c6ec5269b427%2Fupgrade_resumen_instalacion_text.png?alt=media)

Se mostrará, entre otras, la siguiente información:

* Versión a instalar
* Tipo de instalación (Actualización)
* Directorios
* ...

Pulsa **Enter** para continuar.

***

## Paso 8: Confirmación

A continuación, se te indicará que está todo listo para realizar la instalación:

![Listo para instalar](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-93ff9aa22d966f4209e36ab797c83b26ee9e1a74%2Fconfirmacion_instalacion_text.png?alt=media)

1. Escribe **N** si no quieres comenzar el proceso de instalación.
2. Pulsa **Enter** para continuar.

***

## Paso 9: Instalación en proceso

Antes de realizar la instalación propiamente dicha, se realizará una copia de seguridad de los archivos y carpetas de la instalación anterior.

La copia de seguridad se almacenará en un directorio con el mismo nombre que el directorio de la aplicación, añadiendo la extensión .backup al final. **Ruta predeterminada**: `/opt/EditranConnect.backup`.

Posteriormente, la instalación comenzará y se mostrará el progreso junto con los procesos en ejecución:

![Instalación en proceso](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-b2e40503d069aa9fd90462d552df319cd43e1d03%2Finstalacion_en_proceso_text.png?alt=media)

1. Si el componente **PostgreSQL** está seleccionado en el **Paso 2**, y la versión de PostgreSQL instalada es anterior a la versión incluida en el instalador, se te preguntará si deseas actualizar PostgreSQL a la última versión.

   ![Selección de versión de PostgreSQL](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-a91f54e8f3b2492a1ce02454eb6681a4c3a09537%2Fupgrade_postgresql_text.png?alt=media)

   * Asegúrate de que la versión de PostgreSQL instalada es compatible con el sistema operativo de tu máquina. Si no es compatible o no estás seguro, escribe **N**.
   * Si escribes **Y**, se actualizará PostgreSQL.
2. Si los servicios no se inician correctamente, aparecerá un mensaje de advertencia. Consulta el apartado *Solución de problemas* para identificar la causa.

Espera a que el proceso termine.

***

## Paso 10: Instalación finalizada

Una vez finalizada la instalación, se mostrará un mensaje que el proceso ha terminado

![Instalación finalizada](https://3624397791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzO0mk2eo5LONjICfqrP8%2Fuploads%2Fgit-blob-3cc8959c4d41e830c0193131dd755a4b7f467eb8%2Finstalacion_finalizada_text.png?alt=media)

**¡Listo!** Ahora tienes la aplicación **Editran Connect** actualizada.

***

## Solución de problemas

#### 1. Errores durante la instalación

Si encuentras algún error durante el proceso de instalación, verifica los siguientes puntos:

* **Espacio en disco**: Asegúrate de que haya suficiente espacio disponible para la instalación.
* **Compatibilidad del sistema**: Verifica de que tu sistema operativo y procesador sean compatibles.
* **Permisos de administrador**: Ejecuta el instalador con permisos de superusuario (root) para evitar problemas de permisos.
* **Antivirus o firewall**: Comprueba que tu antivirus o firewall no estén bloqueando la instalación. Si es necesario, desactívalos temporalmente durante el proceso.

Para obtener más información sobre el error, consulta el archivo de registro de la instalación (log).

#### 2. Los servicios no se inician

Si la instalación fue exitosa, pero los servicios no se inician, verifica lo siguiente:

* **Dependencias**: Asegúrate de que todos los servicios necesarios estén en funcionamiento. Por ejemplo, el servicio *Editran Connect Data* debe estar iniciado antes de iniciar el servicio *Editran Connect Base*.
* **Puerto en uso**: Confirma que el puerto 443 *(Editran Connect Server)* o 5432 *(Editran Connect Data)* no esté ocupado por otro servicio. Puedes utilizar herramientas como `netstat` para verificar los puertos en uso.
* **Firewall**: Comprueba que no hay un firewall bloqueando los puertos utilizados por los servicios.
* **Configuración de la base de datos**: Verifica que la base de datos esté correctamente configurada y accesible. Asegúrate de que las credenciales de acceso sean correctas y que el servidor de base de datos esté en funcionamiento.
* **Conflictos de software**: Asegúrate de que no haya otros programas o servicios en conflicto con los servicios de **Editran Connect**. Comprueba que la aplicación **Editran Core Connect** está desinstalada.
* **Distribución de Linux**: Verifica que la distribución de Linux seleccionada durante la instalación sea la correcta.
* **Licencia**: Verifica que el archivo de licencia (`licencia.dat`) esté presente y sea válido. Esto implica que los servicios *Editran Servicio Licencia* y *Editran Connect Base* no se inicien.
* **Entorno local**: El servicio *Editran Connect Base* no se iniciará hasta que no esté configurado un entorno local en el módulo de *Editran Core*.

Para obtener más detalles sobre posibles errores, revisa los archivos de registro (log).

***

## Archivos de registro

A continuación, se muestra una tabla con los diferentes archivos de log, su descripción, nombre y ubicación.

| **Descripción**                                   | **Archivo(s)**                 | **Ubicación**                   |
| ------------------------------------------------- | ------------------------------ | ------------------------------- |
| Registro de la instalación                        | `installbuilder_installer.log` | `/tmp`                          |
| Registro de inicio y estado de los servicios      | `*.out, *log`                  | `%INSTALL_DIR%/services/logs`   |
| Registro de errores y eventos de la base de datos | `logfile`                      | `%INSTALL_DIR%/data`            |
| Registro de errores y eventos de la aplicación    | `*.log`                        | `%INSTALL_DIR%/logs`            |
| Registro de errores y eventos del módulo Core     | `*.out, *log`                  | `%INSTALL_DIR%/core/log`        |
| Registro de errores y eventos de licencia         | `*.log`                        | `%INSTALL_DIR%/core/bin/SL/log` |

***

## Servicios

A continuación, se muestra una tabla con los diferentes servicios de la aplicación, su descripción y las dependencias necesarias para iniciarse.

| **Nombre**                | **Descripción**                                | **Dependencias para iniciarse** |
| ------------------------- | ---------------------------------------------- | ------------------------------- |
| Editran Connect Base      | Servicios de Editran Connect                   | Editran Connect Data            |
| Editran Connect Data      | Servicio de base de datos para Editran Connect |                                 |
| Editran Connect Server    | Servidor web para Editran Connect              |                                 |
| Editran Connect Sign      | Servicios de firma para Editran Connect        | Editran Connect Data            |
| Editran Servicio Base     | Protocolo EDITRAN para transmision de ficheros | Editran Servicio Licencia       |
| Editran Servicio Licencia | Atiende las peticiones del API de Licencia V2  |                                 |

***


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.editran.onesait.com/documentacion-editran/connect-v3.1/instalacion/linux_actualizacion.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
