Admin UI

The Admin UI is a web-based dashboard for monitoring Yaci Store sync status, health, and configuration. It provides a visual interface for tracking synchronization progress and managing store operations.

Enabling Admin UI

To enable the Admin UI, add the following property to your application.properties:

store.admin.ui.enabled=true

Once enabled, access the Admin UI at: http://localhost:8080/admin-ui

Configuration Properties

Example Configuration

# Enable Admin UI
store.admin.ui.enabled=true
 
# Enable sync control (start/stop/restart buttons)
store.admin.ui.sync-control-enabled=true
 
# Custom header text
store.admin.ui.header-text=My Custom Indexer
 
# Disable Koios verification (if behind firewall)
store.admin.ui.koios-verification-enabled=false

Features

Dashboard

The main dashboard provides an overview of:

• Sync Progress: Visual progress bar showing synchronization status
• Block/Slot/Epoch Stats: Current block height, slot number, and epoch
• Health Status: Connection health to the Cardano node

Sync Status

Detailed synchronization information including:

• Current sync state (syncing, synced, stopped)
• Network tip vs local tip comparison
• Sync percentage and estimated time remaining

Sync Controls

When store.admin.ui.sync-control-enabled=true, you can:

• Start: Begin synchronization
• Stop: Pause synchronization
• Restart: Stop and restart synchronization

Note: Sync controls are automatically disabled when store.read-only-mode=true, regardless of the sync-control-enabled setting.

Store Status

View the status of all enabled/disabled data stores:

• Assets, Blocks, Epoch, Metadata
• MIR, Script, Staking, Transaction
• UTxO, Governance, and more

Index Status

Monitor database index status:

• View all indexes and their creation status

Ledger State

Monitor ledger state processing:

• Epoch processing status
• Ledger state synchronization progress
• Treasury and Reserves balances
• Koios Verification: Verify your local ledger state (treasury/reserves) against Koios API data

Koios Verification

The Ledger State page includes a “Verify with Koios” button that compares your locally calculated treasury and reserves values against data from the Koios API . This helps ensure your ledger state calculations are accurate.

Koios verification is enabled by default. You may want to disable it in the following scenarios:

• Firewall restrictions: Your deployment is behind a firewall that blocks outbound connections to Koios servers
• Air-gapped environments: Running in an isolated network without internet access
• Private/devnet deployments: Testing on private networks where Koios data is not available

To disable Koios verification:

store.admin.ui.koios-verification-enabled=false

When disabled, the “Verify with Koios” button will not appear on the Ledger State page.

Configuration Viewer

View active configuration settings:

• Network configuration
• Database settings
• Store configurations
• All active properties

Security Considerations

• The Admin UI is disabled by default for security
• Sync controls are disabled by default to prevent accidental operations
• Consider restricting access to /admin-ui endpoints in production environments
• When running in read-only mode, sync controls are automatically disabled