---
title: A tour
description: What each page of the admin UI shows.
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.page/luizfonseca/super/llms.txt
> Use this file to discover all available pages before exploring further.

## Overview

The first page: how Super is doing right now.

<Image src="/assets/admin/overview.png" alt="The overview page" />

- **Requests, errors, latency, CPU and memory**, each with the last two minutes, and charts over 1, 5 or 15 minutes. The page keeps them in memory from the moment it's opened: Super doesn't store more than it already does. CPU is a share of one core; in a container, memory and CPU limits are shown too.
- **Hosts right now**: the hosts with requests in the last 5 seconds, busiest first, with their error rate and latency. Hosts accessed earlier since the page opened stay below, with when their last request came. Click one to open it.
- **TCP**: each `tcp` block, with its upstreams' health and, over the last 5 seconds, its new and open connections, bytes each way, connections that couldn't reach an upstream, and how long the connections that closed stayed open (p50, p90, p99). Shown when Super has `tcp` blocks.
- **Latest requests**: each request as it's served, once you click **Watch requests**. Up to 100 a second come in, and the latest 1,000 are kept while the page is open, also when you leave it and come back. The filter finds requests by host, path, method, status (`503` or `5xx`), client or upstream; hovering the list holds it still so you can read it. Click a request for everything known of it: its time, status, duration, client, location and upstream.
- **Instances sharing the store**: every Super using the same store, and the routes revision each one serves, so you can tell when a change reached all of them.

## Hosts

Every host Super serves, from every source (`file`, `docker`, `kubernetes`, `store`), with its locations, upstream health and plugins. **HTTPS**, in green with a lock, marks hosts served with TLS, **HTTP** in blue those served in plain text, and **TCP** hosts with `tcp` blocks.

<Image src="/assets/admin/hosts.png" alt="The list of hosts, with their source, locations, upstream health and plugins" />

## A host

A host's page starts with its traffic, as a graph from clients to its locations and upstreams.

<Image src="/assets/admin/traffic.png" alt="A host's traffic: clients, the host, its locations and their upstreams, linked by lines toned by what flows through them" />

- Lines move while requests flow, faster and thicker the busier they are.
- **Green**: requests succeed. **Amber**: some fail (5xx, or connections to the upstream that fail). **Red**: a quarter or more fail, or the upstream is unhealthy. **Grey**: nothing flows.
- Each box shows requests per second, the 99th percentile latency and the share of 5xx over the last 5 seconds. An upstream sharing its location with others shows its part of the traffic.
- Hover a box for its responses by status, and its p50, p90 and p99 latency.
- Click a location or an upstream to see only its requests in the latest requests below; click it again, or the ✕ by its name there, to see them all.
- With no requests over the last seconds, the graph is dimmed.

Below are the host's requests and latency, its latest requests, and each location: its upstreams (as written, and the addresses they resolved to), plugins and rules. Its `tcp` blocks come last, with their connections. Their connections aren't requests: they're not in the graph, the charts or the latest requests.

<Image src="/assets/admin/host.png" alt="A host's page: traffic, charts, latest requests and locations" />

Rules are shown without what can be a secret: the values headers, cookies and query parameters are compared with, the settings of `basic_auth`, `oauth2` and `forward_auth`, and the values of headers a rule adds.

## Editing a host

With a token that can write, hosts in the store have **Edit** and **Remove**, and the hosts page has **New host**.

<Image src="/assets/admin/edit-host.png" alt="Editing a host: HTTPS, locations, upstreams and rules" />

- HTTPS, and a self-signed certificate when none can be obtained.
- Locations: their path, upstreams (`host:port`, weight, SNI) and rules.
- Settings the form doesn't edit yet are kept as they are.
- Super checks the host as you type, as it would when saving: its error shows above the form.
- Saving, removing and rolling back are confirmed at the bottom right, with a link to the host's history: a removed host can be restored from there.

## Rules

Rules are built with a form: when they hold, and what they do.

<Image src="/assets/admin/rule-builder.png" alt="The rule builder: conditions as a tree of All of and Any of, and actions with their settings" />

- **When**: conditions in groups of **All of**, **Any of** and **None of**, which can nest. A condition tests a field (`method`, `host`, `path`, `header`, `cookie`, `query`, `client`) with an operator (is, is one of, starts with, matches, is there…).
- **Then**: actions, added from a list that says what each does: answering (`respond`, `redirect`), refusing (`rate_limit`, `ip_filter`, `body_limit`), authentication, changing headers or the method.
- Each action's settings come from Super itself, so the form can't offer what Super wouldn't accept. Required settings are shown; the others are under **More settings**.
- Rules run in order: move them with the arrows. **JSON** shows a rule as Super stores it, and rules the builder can't edit open there.

See [Request/Response rules](/rules) for what rules can do.

## Server

The settings Super started with, defaults included: addresses, timeouts, TLS, the store, cache, Let's Encrypt, logging, docker, Kubernetes and the admin tokens' names. Secrets and credentials are never shown.

<Image src="/assets/admin/server.png" alt="The server page: settings grouped in cards" />

Sections that are off (`enabled = false`), such as Docker when it isn't used, are dimmed.

## Search

Press `⌘K` (`Ctrl+K` on Linux and Windows), or click **Search**, to find a host, a page or an action by typing a few letters: each host with its health, its editor and history (with a token that can write), the documentation, and signing out.

## Certificates

Every certificate in the store: its domains, issuer, when it expires, and which instance renews it.
