ARI.Software Docs

Health Check

ARI's built-in diagnostic command center — test your database, security, modules, storage, and backups from one interactive page.

Your System, Fully Instrumented

The Health Check page is a full diagnostic command center built right into ARI — a live, interactive test suite that verifies every layer of your system, from the database connection all the way up to the security posture of every single API endpoint. ARI can verify itself in real time.

To access Health Check, navigate to your ARI settings page and then click on the "Health Check" button. Or open the /health URL directly.

ARI Health Check page showing the Security tab with 257 endpoints tested, 257 secure, and 0 vulnerable

At a Glance

The moment the page loads, ARI automatically pings the essentials and lights up a status strip:

  • Database — is your PostgreSQL backend reachable and answering queries?
  • Domain — which origin is your installation running on?
  • Resend — is outbound email configured and connected?

Green dots mean all systems go. Anything else tells you exactly where to look — before it becomes a problem.

The Diagnostic Tabs

Health Check organizes its deep diagnostics into seven tabs. Each one is a self-contained test suite you can run on demand.

Database

The foundation. This suite detects your database mode (local Postgres, local Supabase, or Supabase Cloud), verifies environment variables, confirms connectivity, checks your authentication session, fetches live data from every enabled module, and validates that Row Level Security policies are isolating your data correctly.

Endpoints

A complete, auto-discovered inventory of your API surface — generated straight from ARI's OpenAPI specification. See every core route, every module route, and every intentionally public endpoint, along with summary counts and security coverage. Nothing is hardcoded: install a new module and its endpoints appear here automatically.

Security

This suite probes every API endpoint in your installation with deliberately unauthenticated requests — no cookies, no credentials, no shortcuts — and confirms each one slams the door shut. Hundreds of endpoints tested in seconds, each labeled Secure or flagged Vulnerable with the exact HTTP response it returned. Intentionally public routes (like webhooks) get their own dedicated tests to verify their signature checks and rate limits hold up.

It's the kind of audit most platforms make you take on faith. ARI lets you run it yourself, any time you like.

Auth Config

Verifies your Better Auth configuration end to end: secrets present, session handling correct, and rate limiting active on sign-in attempts.

Modules

Exercises the entire module system — discovers every installed module, validates manifests, confirms the page registry is complete, and probes each enabled module's routes and API endpoints. If a custom module ever misbehaves, this is where you'll see it first.

Storage

A true end-to-end workout for your file storage provider. It checks the active provider and its environment variables, then uploads a test file, lists it, serves it back, verifies the bytes match, deletes it, and confirms the deletion — including a binary round-trip test to make sure files survive intact. Works whether you store files on the local filesystem, S3, R2, or Supabase Storage.

Backup

Confirms your safety net is real. It verifies the backup endpoints, tests dynamic table discovery, counts every row that would be captured, and surfaces any warnings — so when the day comes that you actually need a backup, you already know it works.

Why It Matters

Self-hosting shouldn't mean guessing. Health Check can be run anytime — after an install, after an upgrade, after adding a custom module, or just because it's satisfying to watch a wall of green checkmarks confirm your system is solid.

Tip: Run the Health Checks after installing any new module. ARI auto-discovers the module's endpoints and includes them in the audit — instantly.

Quick Reference

URL/health on your installation
AccessRequires sign-in (the page tests your data isolation)
CostRead-only diagnostics; storage tests clean up after themselves
When to runAfter installs, upgrades, new modules — or anytime

Your Personal Workspace. Your Rules.

Open Source. Self-Hosted. Full Data Control. Fully Extendable. AI Native. Dozens of Built-In Modules And Build Your Own In Minutes. No Coding Required.

Download