Interface description

On the launcher download page, you can view logs and export the system state in case of problems:

../../../_images/loading.png

On first launch, available options include installing Citeck Community with demo data (a), without demo data (b), or creating another namespace for deploying Citeck (c):

../../../_images/namespaces.png

After a successful launch, a list of available namespaces will be displayed:

../../../_images/namespaces_1.png

From the namespace list, you can edit and delete namespaces:

../../../_images/namespaces_2.png

When selecting a namespace, current information about its microservices and applications is available, as well as actions:

../../../_images/overview.png

  1. Launched microservices and applications: core microservices, Citeck applications, third-party, status. Available actions:

    • 1a – stop/start

    • 1b – microservice log

    • 1c – manual configuration of a microservice/application:

    Left click — edit Docker application configuration

    ../../../_images/setting_left.png

    Right click — edit volume files:

    ../../../_images/setting_right.png

    A blue marker indicates that the application has manual configuration which is not managed by the launcher. To reset manual changes, open the editor and click “Reset”.

  2. Update/ start all microservices and applications. Right-clicking provides the Force Update And Start action for forced updating of data from git repositories with workspace configuration and bundles (kits):

    ../../../_images/force_update.png

  3. Stop all microservices and applications.

  4. Current deployment status.

  5. Common CPU/RAM usage

  6. Open Citeck in browser (only for Running status).

  7. Access to related services. They open in the browser in a separate tab.

    • Keycloak Admin – management interface for Keycloak, the identity and access management system. Available if Keycloak authentication type was selected during namespace setup. Login/ password: admin/ admin

    • Spring Boot Admin — interface for monitoring and administering Spring Boot applications: viewing status, metrics, logs, and managing applications.

    • PG Admin - interface for administering and managing PostgreSQL databases. Login/ password: admin@admin.com/ admin Database password: postgres

    • MailHog — a tool for testing and debugging email during development: it intercepts messages and displays them in a web interface without actually sending them.

    • RabbitMQ – interface of a message broker that enables asynchronous data exchange between components of distributed systems. Login/ password: admin/ admin

  8. Citeck platform documentation:

    • Documentation — go to the resource containing the platform documentation.

    • AI Documentation Bot — go to the Telegram bot.

  9. Navigate to the launcher directory (folder containing logs, configuration data, workspaces).

  10. Open the launcher log.

    ../../../_images/log.png

    Log data can be filtered by type (1), searched (2), and can be copied, cleared, or exported (3).

  11. List of volumes in use. They can be cleared, take a data snapshot:

    ../../../_images/volumes.png

  12. Working with secrets used in the launcher. First, you must set a master password:

    ../../../_images/secret_1.png

    See details about working with secrets

  13. Export system information (export system data, build information, thread dump).

  14. Namespace settings. See details about namespace settings

    ../../../_images/namespace_settings.png

Tray actions

../../../_images/tray_actions.png

  • Open

  • Dump system info

  • Open launcher dir

  • Exit