feat(ui): serve optional extra UI from /ui volume#2206
Open
vinicius73 wants to merge 1 commit intoAlexxIT:masterfrom
Open
feat(ui): serve optional extra UI from /ui volume#2206vinicius73 wants to merge 1 commit intoAlexxIT:masterfrom
vinicius73 wants to merge 1 commit intoAlexxIT:masterfrom
Conversation
Add a new optional UI module that serves a mounted static directory at /ui/ (respecting api.base_path). Document usage and declare /ui as a Docker volume, plus a basic HTTP healthcheck for the container.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds support for serving an additional static web UI from a local directory, making it easier to provide custom web interfaces alongside the built-in HTTP API. The feature is configurable via
ui.dir, includes Docker support, and is documented with usage and configuration details.This approach makes it possible to host a custom UI alongside the Docker container without adding overhead or unnecessary complexity to the existing UI, which already fulfills its purpose well. It also creates room for parallel projects to build solutions and experiences that are better tailored to their specific needs without disrupting the current foundation. At the same time, it keeps those solutions straightforward to adopt and accessible to a broader audience.
Extra UI feature:
uimodule (internal/ui/ui.go) that serves static files from a configurable directory (ui.dir) at the/ui/path, with support for disabling or customizing the directory.uimodule in the application startup sequence (main.go) so it is initialized with other modules. [1] [2]Documentation updates:
README.mdto document the new Extra UI feature, including configuration options and security notes. [1] [2]uimodule to the list of modules/features in the summary table inREADME.md.docker/README.mdexplaining how to mount a local directory for the extra UI in Docker deployments, with usage examples.