Skip to content

Clarify CrateDB Admin UI documentation #900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bmunkholm wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Clarify CrateDB Admin UI documentation #900

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5620ba9
Clarify CrateDB Admin UI documentation
bmunkholm Nov 19, 2025
df5246c
Fix formatting in docs/index.rst
bmunkholm Nov 19, 2025
8324027
Fix NOTE format
bmunkholm Nov 19, 2025
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
15 changes: 11 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,22 @@
The CrateDB Admin UI
====================

CrateDB ships with a web administration user interface (or *Admin UI*).
CrateDB ships with a web administration user interface (aka *Admin UI*)
that you can use to inspect and interact with any CrateDB cluster.

The CrateDB Admin UI runs on every CrateDB node. You can use it to inspect
and interact with the whole CrateDB cluster in a number of ways.
.. NOTE::

The tool is primarily intended for self-hosted clusters and
mirrors the relevant features of the CreateDB Cloud Console. Cloud
users can also benefit from the Admin UI by using it to view
:ref:`shards <shards-browser>` or to provide console access to users
without full admin access to the Cloud Console.

Connecting
==========

You can access the Admin UI via HTTP on port ``4200``::
The Admin UI runs on every CrateDB node and can be accessed on port
``4200``::

http://HOSTNAME:4200/

Expand Down