Skip to content
This repository has been archived by the owner on Dec 13, 2023. It is now read-only.

Added description for Analyzers Web UI. #773

Merged
merged 2 commits into from
Sep 22, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 47 additions & 33 deletions 3.9/release-notes-new-features39.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,53 @@ See:
- [`segmentation` Analyzer](analyzers.html#segmentation)
- [`collation` Analyzer](analyzers.html#collation)

UI
--

### Analyzers in Web Interface

A new menu item _ANALYZERS_ has been added to the side navigation bar of the
Web UI. Through this page, you can view existing Analyzers as well create new
Analyzers. The UI is full-featured and lets you feed in all parameters and
options that you could otherwise input through the HTTP or JavaScript API.

It also lets you copy configuration from an existing Analyzer, allowing for a
much quicker workflow when your new Analyzer is very similar to an existing one.

It offers two edit/view modes - a form mode where a standard web form is used to
capture user input, and a JSON mode where experienced users can directly write
the raw Analyzer configuration in JSON format.

### Configurable root redirect

Added two options to `arangod` to allow HTTP redirection customization for
root (`/`) call of the HTTP API:

- `--http.permanently-redirect-root`: if `true` (default), use a permanent
redirection (use HTTP 301 code), if `false` fall back to temporary redirection
(use HTTP 302 code).

- `--http.redirect-root-to`: redirect of root URL to a specified path.
Redirects to `/_admin/aardvark/index.html` if not set (default).

These options are useful to override the built-in web interface with some
user-defined action.

### Web interface session handling

The previously inactive startup parameter `--server.session-timeout` was
revived and now controls the timeout for web interface sessions (and other
sessions that are based on JWTs created by the `/_open/auth` API).

For security reasons, the default timeout value for web interface sessions
has been reduced to one hour, after which a session is ended automatically.
Web interface sessions that are active (i.e. that have any user activity)
are automatically extended until the user ends the session explicitly or
if there is a period of one hour without any user activity.

The timeout value for web interface sessions can be adjusted via the
`--server.session-timeout` startup parameter (in seconds).

AQL
---

Expand Down Expand Up @@ -192,39 +239,6 @@ Setting the option to `false` allows to not store any data read by the query
in the RocksDB block cache. This is useful for queries that read a lot of (cold)
data which would lead to the eviction of the hot data from the block cache.

UI
--

### Configurable root redirect

Added two options to `arangod` to allow HTTP redirection customization for
root (`/`) call of the HTTP API:

- `--http.permanently-redirect-root`: if `true` (default), use a permanent
redirection (use HTTP 301 code), if `false` fall back to temporary redirection
(use HTTP 302 code).

- `--http.redirect-root-to`: redirect of root URL to a specified path.
Redirects to `/_admin/aardvark/index.html` if not set (default).

These options are useful to override the built-in web interface with some
user-defined action.

### Web interface session handling

The previously inactive startup parameter `--server.session-timeout` was
revived and now controls the timeout for web interface sessions (and other
sessions that are based on JWTs created by the `/_open/auth` API).

For security reasons, the default timeout value for web interface sessions
has been reduced to one hour, after which a session is ended automatically.
Web interface sessions that are active (i.e. that have any user activity)
are automatically extended until the user ends the session explicitly or
if there is a period of one hour without any user activity.

The timeout value for web interface sessions can be adjusted via the
`--server.session-timeout` startup parameter (in seconds).

Server options
--------------

Expand Down