diff --git a/docs/src/main/sphinx/admin.md b/docs/src/main/sphinx/admin.md index 2edc1f666826..5e2cf1a2977a 100644 --- a/docs/src/main/sphinx/admin.md +++ b/docs/src/main/sphinx/admin.md @@ -4,6 +4,7 @@ :maxdepth: 1 admin/web-interface +admin/preview-web-interface admin/tuning admin/jmx admin/opentelemetry diff --git a/docs/src/main/sphinx/admin/preview-web-interface.md b/docs/src/main/sphinx/admin/preview-web-interface.md new file mode 100644 index 000000000000..1f88a9f266db --- /dev/null +++ b/docs/src/main/sphinx/admin/preview-web-interface.md @@ -0,0 +1,32 @@ +# Preview Web UI + +In addition to the [](/admin/web-interface), Trino includes a preview version of +a new web interface. It changes look and feel, available features, and many +other aspects. In the future this new user interface will replace the existing +user interface. + +:::{warning} + +The Preview Web UI is not suitable for production usage, and only available for +testing and evaluation purposes. Feedback and assistance with development is +encouraged. Find collaborators and discussions in ongoing pull requests and the +[#web-ui channel](https://trinodb.slack.com/messages/CKCEWGYT0). + +::: + +## Activation + +The Preview Web UI is not available by default, and must be enabled in +[](config-properties) with the following configuration: + + +```properties +web-ui.preview.enabled=true +``` + +## Access + +Once activated, users can access the interface in the URL context `/ui/preview` +after successful login to the [](/admin/web-interface). For example, the full +URL on a locally running Trino installation or Trino docker container without +TLS configuration is [http://localhost:8080/ui/preview](http://localhost:8080/ui/preview). diff --git a/docs/src/main/sphinx/admin/properties-web-interface.md b/docs/src/main/sphinx/admin/properties-web-interface.md index 95c608756e83..4646c1b0fec5 100644 --- a/docs/src/main/sphinx/admin/properties-web-interface.md +++ b/docs/src/main/sphinx/admin/properties-web-interface.md @@ -16,7 +16,14 @@ The authentication mechanism to allow user access to the Web UI. See - **Type:** {ref}`prop-type-boolean` - **Default value:** `true` -This property controls whether or not the Web UI is available. +This property controls whether or not the [](/admin/web-interface) is available. + +## `web-ui.preview.enabled` + +- **Type:** {ref}`prop-type-boolean` +- **Default value:** `false` + +This property controls whether or not the [](/admin/preview-web-interface) is available. ## `web-ui.shared-secret`