Architecture & Security Checks

https://www.julien-dubois.com/boot-ui
Admin
This project provides a collection of markdown documents outlining various architecture, security,...
Tokens:48,218
Snippets:759
Trust Score:7.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install and Run Documentation Dev Server

Source: https://www.julien-dubois.com/boot-ui/repository

Installs project dependencies and starts a local development server for the documentation website.

```bash
npm install
npm run docs:dev

```

--------------------------------

### Require Action Gate and Read-Only for Dev Services Restart

Source: https://www.julien-dubois.com/boot-ui/properties

Require both an action gate and panel read-only state to allow a Dev Services restart action. This example shows how to enable the restart action by setting `bootui.panels.dev-services.read-only` to `false` and `bootui.dev-services.restart-enabled` to `true`.

```properties
bootui.panels.dev-services.read-only=false
bootui.dev-services.restart-enabled=true
```

--------------------------------

### Disable CRaC Read-Only Actions

Source: https://www.julien-dubois.com/boot-ui/properties

Disable the on-demand readiness scan and Dockerfile/entrypoint install actions for CRaC. Downloads remain available. This property is disabled by default.

```properties
bootui.panels.crac.read-only=false
```

--------------------------------

### Run Sample App on macOS/Linux

Source: https://www.julien-dubois.com/boot-ui/try-sample-app

Downloads and executes a script from GitHub to clone the repository, build the sample app, and run it. Review the script before execution.

```bash
curl -fsSL https://raw.githubusercontent.com/jdubois/boot-ui/main/scripts/run-sample.sh | bash

```

--------------------------------

### /bootui/api/startup

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves the startup timeline.

```APIDOC
## GET /bootui/api/startup

### Description
Startup timeline.

### Method
GET

### Endpoint
/bootui/api/startup
```

--------------------------------

### Run Sample App on Windows PowerShell

Source: https://www.julien-dubois.com/boot-ui/try-sample-app

Downloads and executes a PowerShell script from GitHub to clone the repository, build the sample app, and run it. Review the script before execution.

```powershell
irm https://raw.githubusercontent.com/jdubois/boot-ui/main/scripts/run-sample.ps1 | iex

```

--------------------------------

### Build Documentation Website

Source: https://www.julien-dubois.com/boot-ui/repository

Builds the static assets for the documentation website.

```bash
npm run docs:build

```

--------------------------------

### /bootui/api/config

Source: https://www.julien-dubois.com/boot-ui/specification

Fetches effective configuration values.

```APIDOC
## GET /bootui/api/config

### Description
Effective configuration values.

### Method
GET

### Endpoint
/bootui/api/config
```

--------------------------------

### /bootui/api/database-connection-pools/pools/{name}/snapshot

Source: https://www.julien-dubois.com/boot-ui/specification

Fetches a live connection pool utilization snapshot.

```APIDOC
## GET /bootui/api/database-connection-pools/pools/{name}/snapshot

### Description
Live connection pool utilization snapshot.

### Method
GET

### Endpoint
/bootui/api/database-connection-pools/pools/{name}/snapshot

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the connection pool.
```

--------------------------------

### /bootui/api/metrics/detail

Source: https://www.julien-dubois.com/boot-ui/specification

Provides Micrometer meter detail and live measurements.

```APIDOC
## GET /bootui/api/metrics/detail

### Description
Micrometer meter detail and live measurements.

### Method
GET

### Endpoint
/bootui/api/metrics/detail
```

--------------------------------

### /bootui/api/mappings/flat

Source: https://www.julien-dubois.com/boot-ui/specification

Provides stable, paged HTTP mapping summaries.

```APIDOC
## GET /bootui/api/mappings/flat

### Description
Stable, paged HTTP mapping summaries.

### Method
GET

### Endpoint
/bootui/api/mappings/flat
```

--------------------------------

### /bootui/api/jvm-tuning

Source: https://www.julien-dubois.com/boot-ui/specification

Provides a JVM tuning advisor report.

```APIDOC
## GET /bootui/api/jvm-tuning

### Description
JVM tuning advisor report.

### Method
GET

### Endpoint
/bootui/api/jvm-tuning
```

--------------------------------

### /bootui/api/heap-dump/download

Source: https://www.julien-dubois.com/boot-ui/specification

Downloads a raw heap dump only when explicitly enabled.

```APIDOC
## GET /bootui/api/heap-dump/download

### Description
Download a raw heap dump only when explicitly enabled.

### Method
GET

### Endpoint
/bootui/api/heap-dump/download
```

--------------------------------

### /bootui/api/dev-services

Source: https://www.julien-dubois.com/boot-ui/specification

Lists Docker Compose, Testcontainers, and service connection entries.

```APIDOC
## GET /bootui/api/dev-services

### Description
Docker Compose, Testcontainers, and service connection entries.

### Method
GET

### Endpoint
/bootui/api/dev-services
```

--------------------------------

### /bootui/api/threads/download

Source: https://www.julien-dubois.com/boot-ui/specification

Downloads a raw text thread dump after confirmation.

```APIDOC
## POST /bootui/api/threads/download

### Description
Confirmation-gated raw text thread dump download.

### Method
POST

### Endpoint
/bootui/api/threads/download
```

--------------------------------

### /bootui/api/ai/overview

Source: https://www.julien-dubois.com/boot-ui/specification

Provides an AI telemetry summary from local spans.

```APIDOC
## GET /bootui/api/ai/overview

### Description
AI telemetry summary from local spans.

### Method
GET

### Endpoint
/bootui/api/ai/overview
```

--------------------------------

### /bootui/api/live-memory

Source: https://www.julien-dubois.com/boot-ui/specification

Provides a JVM memory report.

```APIDOC
## GET /bootui/api/live-memory

### Description
JVM memory report.

### Method
GET

### Endpoint
/bootui/api/live-memory
```

--------------------------------

### /bootui/api/conditions

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves auto-configuration conditions.

```APIDOC
## GET /bootui/api/conditions

### Description
Auto-configuration conditions.

### Method
GET

### Endpoint
/bootui/api/conditions
```

--------------------------------

### /bootui/api/panels

Source: https://www.julien-dubois.com/boot-ui/specification

Provides information on panel availability, enabled state, and read-only state.

```APIDOC
## GET /bootui/api/panels

### Description
Panel availability, enabled state, and read-only state.

### Method
GET

### Endpoint
/bootui/api/panels
```

--------------------------------

### /bootui/api/mappings

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves HTTP mappings.

```APIDOC
## GET /bootui/api/mappings

### Description
HTTP mappings.

### Method
GET

### Endpoint
/bootui/api/mappings
```

--------------------------------

### /bootui/api/vulnerabilities

Source: https://www.julien-dubois.com/boot-ui/specification

Provides the runtime Maven dependency inventory without external scanning.

```APIDOC
## GET /bootui/api/vulnerabilities

### Description
Runtime Maven dependency inventory without external scanning.

### Method
GET

### Endpoint
/bootui/api/vulnerabilities
```

--------------------------------

### /bootui/api/overview

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves the status of the application, runtime, Spring Boot, profile, and BootUI itself.

```APIDOC
## GET /bootui/api/overview

### Description
App, runtime, Spring Boot, profile, and BootUI status.

### Method
GET

### Endpoint
/bootui/api/overview
```

--------------------------------

### /bootui/api/beans

Source: https://www.julien-dubois.com/boot-ui/specification

Provides a searchable summary of beans.

```APIDOC
## GET /bootui/api/beans

### Description
Searchable bean summary.

### Method
GET

### Endpoint
/bootui/api/beans
```

--------------------------------

### /bootui/api/data/repositories

Source: https://www.julien-dubois.com/boot-ui/specification

Provides a summary of detected Spring Data repositories.

```APIDOC
## GET /bootui/api/data/repositories

### Description
Detected Spring Data repositories (summary).

### Method
GET

### Endpoint
/bootui/api/data/repositories
```

--------------------------------

### /bootui/api/http-probe

Source: https://www.julien-dubois.com/boot-ui/specification

Performs a local HTTP probe.

```APIDOC
## POST /bootui/api/http-probe

### Description
Local HTTP probe.

### Method
POST

### Endpoint
/bootui/api/http-probe
```

--------------------------------

### /bootui/api/github

Source: https://www.julien-dubois.com/boot-ui/specification

Fetches local GitHub origin metadata and the latest cached dashboard snapshot.

```APIDOC
## GET /bootui/api/github

### Description
Local GitHub origin metadata and the latest cached dashboard snapshot.

### Method
GET

### Endpoint
/bootui/api/github
```

--------------------------------

### /bootui/api/otlp/v1/traces

Source: https://www.julien-dubois.com/boot-ui/specification

Receives traces via OTLP/HTTP on the embedded local receiver.

```APIDOC
## POST /bootui/api/otlp/v1/traces

### Description
Embedded local OTLP/HTTP trace receiver.

### Method
POST

### Endpoint
/bootui/api/otlp/v1/traces
```

--------------------------------

### /bootui/api/config/overrides

Source: https://www.julien-dubois.com/boot-ui/specification

Creates or updates a local runtime configuration property override.

```APIDOC
## POST /bootui/api/config/overrides

### Description
Create or update a local runtime configuration property override.

### Method
POST

### Endpoint
/bootui/api/config/overrides
```

--------------------------------

### BootUI Startup Banner

Source: https://www.julien-dubois.com/boot-ui/specification

When BootUI is enabled, this message is expected in the application startup output. It indicates the availability of the BootUI interface.

```text
BootUI is available at http://localhost:8080/bootui

```

--------------------------------

### /bootui/api/traces

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves recent local trace summaries.

```APIDOC
## GET /bootui/api/traces

### Description
Recent local trace summaries.

### Method
GET

### Endpoint
/bootui/api/traces
```

--------------------------------

### /bootui/api/dev-services/{id}/logs

Source: https://www.julien-dubois.com/boot-ui/specification

Provides bounded log tail for a bean-backed service when available.

```APIDOC
## GET /bootui/api/dev-services/{id}/logs

### Description
Bounded log tail for a bean-backed service when available.

### Method
GET

### Endpoint
/bootui/api/dev-services/{id}/logs

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the bean-backed service.
```

--------------------------------

### /bootui/api/threads

Source: https://www.julien-dubois.com/boot-ui/specification

Provides a stable, paged live thread snapshot with state counts and deadlock info.

```APIDOC
## GET /bootui/api/threads

### Description
Stable, paged live thread snapshot with state counts and deadlock info.

### Method
GET

### Endpoint
/bootui/api/threads
```

--------------------------------

### Run explicit native-image readiness checks

Source: https://www.julien-dubois.com/boot-ui/specification

Executes explicit checks for native-image readiness.

```APIDOC
## POST /bootui/api/graalvm/scan

### Description
Run explicit native-image readiness checks.

### Method
POST

### Endpoint
/bootui/api/graalvm/scan
```

--------------------------------

### /bootui/api/metrics

Source: https://www.julien-dubois.com/boot-ui/specification

Allows browsing the Micrometer meter list.

```APIDOC
## GET /bootui/api/metrics

### Description
Browseable Micrometer meter list.

### Method
GET

### Endpoint
/bootui/api/metrics
```

--------------------------------

### /bootui/api/heap-dump/capture

Source: https://www.julien-dubois.com/boot-ui/specification

Captures a local heap dump after explicit confirmation.

```APIDOC
## POST /bootui/api/heap-dump/capture

### Description
Capture a local heap dump after explicit confirmation.

### Method
POST

### Endpoint
/bootui/api/heap-dump/capture
```

--------------------------------

### /bootui/api/data/repositories/{name}

Source: https://www.julien-dubois.com/boot-ui/specification

Fetches detail for a specific Spring Data repository, including query methods.

```APIDOC
## GET /bootui/api/data/repositories/{name}

### Description
Spring Data repository detail with query methods.

### Method
GET

### Endpoint
/bootui/api/data/repositories/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the Spring Data repository.
```

--------------------------------

### /bootui/api/log-tail/recent

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves recent log lines.

```APIDOC
## GET /bootui/api/log-tail/recent

### Description
Recent log lines.

### Method
GET

### Endpoint
/bootui/api/log-tail/recent
```

--------------------------------

### /bootui/api/scheduled

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves scheduled tasks.

```APIDOC
## GET /bootui/api/scheduled

### Description
Scheduled tasks.

### Method
GET

### Endpoint
/bootui/api/scheduled
```

--------------------------------

### Enable BootUI and Allow Non-Localhost Access

Source: https://www.julien-dubois.com/boot-ui/specification

Configure BootUI to be enabled and accessible from non-localhost environments. This requires explicit configuration to override default safety measures.

```properties
bootui.enabled=ON
bootui.allow-non-localhost=true
```

--------------------------------

### /bootui/api/hibernate

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves the latest Hibernate/JPA advisor report.

```APIDOC
## GET /bootui/api/hibernate

### Description
Latest Hibernate/JPA advisor report.

### Method
GET

### Endpoint
/bootui/api/hibernate
```

--------------------------------

### Make Application Read-Only

Source: https://www.julien-dubois.com/boot-ui/properties

Set the entire application to read-only mode by setting the `bootui.read-only` property to `true`.

```properties
bootui.read-only=true
```

--------------------------------

### /bootui/api/config/overrides/{name}

Source: https://www.julien-dubois.com/boot-ui/specification

Removes a local runtime configuration property override.

```APIDOC
## DELETE /bootui/api/config/overrides/{name}

### Description
Remove a local runtime configuration property override.

### Method
DELETE

### Endpoint
/bootui/api/config/overrides/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the override to remove.
```

--------------------------------

### Run Spring Boot App with Dev Profile (Maven)

Source: https://www.julien-dubois.com/boot-ui/setup

Execute your Spring Boot application using Maven, activating the 'dev' profile to enable BootUI. This command uses the Maven wrapper.

```bash
./mvnw spring-boot:run -Dspring-boot.run.profiles=dev
```

--------------------------------

### Add BootUI Spring Boot Starter (Gradle Kotlin)

Source: https://www.julien-dubois.com/boot-ui/setup

Add the BootUI starter dependency to your Gradle build file using the Kotlin DSL. This dependency is intended for runtime in development.

```kotlin
runtimeOnly("com.julien-dubois.bootui:bootui-spring-boot-starter:1.2.0")
```

--------------------------------

### /bootui/api/architecture

Source: https://www.julien-dubois.com/boot-ui/specification

Retrieves the latest Architecture scan report.

```APIDOC
## GET /bootui/api/architecture

### Description
Latest Architecture scan report.

### Method
GET

### Endpoint
/bootui/api/architecture
```
Tokens:
Raw