Package io.quarkiverse.quinoa.deployment.config

Interface DevServerConfig

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Optional<String> checkPath()
      After start, Quinoa wait for the external dev server.
      int checkTimeout()
      Timeout in ms for the dev server to be up and running.
      boolean enabled()
      Enable external dev server (live coding).
      String host()
      Host of the server to forward requests to.
      Optional<String> indexPage()
      Set this value if the index page is different for the dev-server
      boolean logs()
      Enable external dev server live coding logs.
      boolean managed()
      When set to true, Quinoa will manage the Web UI dev server When set to false, the Web UI dev server have to be started before running Quarkus dev
      Optional<Integer> port()
      Port of the server to forward requests to.
      boolean websocket()
      By default, Quinoa will handle request upgrade to websocket and act as proxy with the dev server.

    • Method Detail

      • enabled

        @WithParentName
@WithDefault("true")
boolean enabled()
        Enable external dev server (live coding). If the "dev-server.port" config is not detected or defined it will be disabled.

      • managed

        @WithDefault("true")
boolean managed()
        When set to true, Quinoa will manage the Web UI dev server When set to false, the Web UI dev server have to be started before running Quarkus dev

      • port

        @ConfigDocDefault("framework detection or fallback to empty")
Optional<Integer> port()
        Port of the server to forward requests to. The dev server process (i.e npm start) is managed like a dev service by Quarkus. If the external server responds with a 404, it is ignored by Quinoa and processed like any other backend request.

      • host

        @WithDefault("localhost")
String host()
        Host of the server to forward requests to.

      • checkPath

        @WithDefault("/")
Optional<String> checkPath()
        After start, Quinoa wait for the external dev server. by sending GET requests to this path waiting for a 200 status. If forced empty, Quinoa will not check if the dev server is up.

      • websocket

        @WithDefault("true")
boolean websocket()
        By default, Quinoa will handle request upgrade to websocket and act as proxy with the dev server. If set to false, Quinoa will pass websocket upgrade request to the next Vert.x route handler.

      • checkTimeout

        @WithDefault("30000")
int checkTimeout()
        Timeout in ms for the dev server to be up and running.

      • logs

        @WithDefault("false")
boolean logs()
        Enable external dev server live coding logs. This is not enabled by default because most dev servers display compilation errors directly in the browser.

      • indexPage

        @ConfigDocDefault("auto-detected falling back to the quinoa.index-page")
Optional<String> indexPage()
        Set this value if the index page is different for the dev-server