Skip to content
Snippets Groups Projects
Select Git revision
  • 4e25b93bf4a40c832bd69164332c81310a50fbb7
  • master default protected
  • replication_test
  • dev protected
  • release-1.10 protected
  • 533-integrate-semantic-recommendation-2
  • 556-usage-statistics
  • 553-semantic-recommendation-2
  • 553-semantic-recommendation
  • release-1.9 protected
  • 551-init-broker-service-permissions
  • 549-test-oai-pmh
  • 545-saving-multiple-times-breaks-pid-metadata
  • 499-standalone-compute-service-2
  • 539-load-tests
  • hotfix/helm-chart
  • luca_ba_new_interface
  • 534-bug-when-adding-access-to-user-that-is-not-registered-at-dashboard-service
  • release-1.8 protected
  • 533-integrate-semantic-recommendation
  • feature/openshift
  • v1.10.5 protected
  • v1.10.4 protected
  • v1.10.3 protected
  • v1.10.2 protected
  • v1.10.1 protected
  • v1.10.0-rc13 protected
  • v1.10.0-rc12 protected
  • v1.10.0-rc11 protected
  • v1.10.0-rc10 protected
  • v1.10.0-rc9 protected
  • v1.10.0-rc8 protected
  • v1.10.0-rc7 protected
  • v1.10.0-rc6 protected
  • v1.10.0-rc5 protected
  • v1.10.0-rc4 protected
  • v1.10.0-rc3 protected
  • v1.10.0-rc2 protected
  • v1.10.0rc1 protected
  • v1.10.0rc0 protected
  • v1.10.0 protected
41 results

ui.md

Blame
  • Martin Weise's avatar
    Martin Weise authored
    4e25b93b
    History
    ui.md 2.61 KiB
    author: Martin Weise

    tl;dr

    !!! debug "Debug Information"

    Image: [`registry.datalab.tuwien.ac.at/dbrepo/ui:1.4.4`](https://hub.docker.com/r/dbrepo/ui)
    
    * Ports: 3000/tcp

    The User Interface is configured in the runtimeConfig section of the nuxt.config.ts file during build time. For the runtime, you need to override those values through environment variables or by mounting a .env file. As a small example, you can configure the logo :material-numeric-1-circle-outline: in Figure 2. Make sure you mount the logo as image as well, in this example we want to mount a custom logo my_logo.png into the container and specify the name.

    Architecture of the UI microservice
    Figure 1: Architecture of the UI microservice

    Text values like the version :material-numeric-2-circle-outline: and title :material-numeric-3-circle-outline: can be configured as well via the Nuxt runtime configuration through single environment variables or .env files

    NUXT_PUBLIC_TITLE="My overriden title"
    NUXT_PUBLIC_LOGO="/app/.output/public/my_logo.png"
    ...

    To work, you need to mount the my_logo.png file into the dbrepo-ui container via the docker-compose.yml file (or if you use a Kubernetes deployment via ConfigMap and Volumes).

    services:
      dbrepo-ui:
        image: registry.datalab.tuwien.ac.at/dbrepo/ui:1.4.4
        volumes:
          - ./my_logo.png:/app/.output/public/my_logo.png
      ...

    Architecture

    The server-client architecture of the User Interface is shown in Figure 3, it is supposed to help debug the User Interface on development.

    Architecture of the UI microservice
    Figure 2: Architecture of the User Interface

    Example

    See the API Overview page for detailed examples.

    Limitations

    (none)

    !!! question "Do you miss functionality? Do these limitations affect you?"

    We strongly encourage you to help us implement it as we are welcoming contributors to open-source software and get
    in [contact](../contact) with us, we happily answer requests for collaboration with attached CV and your programming 
    experience!

    Security

    (none)