Skip to content

Commit

Permalink
Add docs for Preview Web UI
Browse files Browse the repository at this point in the history
  • Loading branch information
mosabua authored and wendigo committed Aug 2, 2024
1 parent eae2609 commit fe5bb92
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/src/main/sphinx/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
:maxdepth: 1
admin/web-interface
admin/preview-web-interface
admin/tuning
admin/jmx
admin/opentelemetry
Expand Down
32 changes: 32 additions & 0 deletions docs/src/main/sphinx/admin/preview-web-interface.md
Original file line number Diff line number Diff line change
@@ -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).
9 changes: 8 additions & 1 deletion docs/src/main/sphinx/admin/properties-web-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down

0 comments on commit fe5bb92

Please sign in to comment.