Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

mantis home page
mantis

    Start

    • Mantis documentation
    • Getting started
    • Trying it locally
    • Use cases

    Reference

    • HTTP API
    • Configuration
    • CLI
    • CLI backup
    • Updating
    • Changelog

    Features

    • File keys
    • Honey directory
    • Host-event keys
    • Uptime Kuma
    • Reliability

    Operating

    • Single-user model
    • Operational notes
    • Dev inbox

    Recipes

    • Self-hosted apps

    Architecture

    • Project layout
    Architecture

    Project layout

    Directory map of the Mantis source tree and major application modules.

    src/                         # Next.js server: dashboard, API, public triggers
      app/
        page.tsx                 # / redirects to /keys or /login
        login/                   # API-key login form; mints httpOnly sessions
        logout/                  # POST clears the session cookie
        (app)/                   # authenticated dashboard route group
          layout.tsx             # shared nav: keys, new, bulk, machine, dev inbox, admin-only settings
          keys/
            page.tsx             # key list, enable/disable controls
            new/                 # create form
            [id]/                # detail, hits, downloads, installers, destinations
          settings/wallet/       # admin Apple Wallet status (read-only; config via APPLE_PASS_* env)
          settings/notifications/ # admin instance-wide (global) notify destinations
        api/
          keys/...               # authenticated key CRUD, hits, downloads, installers
          api-keys/...           # authenticated API-key listing, minting, revocation
          hits/recent/           # CLI watch feed across accessible keys
          audit/                 # admin audit log
          health/                # liveness + DB readiness
          cron/notifications/    # serverless notification/retention worker endpoint
          inbox/                 # dev inbox JSON API
          wallet/v1/...          # Apple Wallet web-service callbacks
        c/[publicId]/            # public trigger endpoint
        status/[publicId]/       # public monitor endpoint for Uptime Kuma
        inbox/                   # dev webhook capture + viewer
      db/                        # Drizzle schema and SQL migrations
      lib/
        auth.ts                  # Bearer API key auth + per-IP auth-failure throttle
        session.ts               # dashboard session cookies backed by hashed tokens
        env.ts                   # URL, SMTP, bootstrap, and Wallet env resolution
        keys.ts                  # public ID and API serialization helpers
        response.ts              # gif / empty / json / redirect / html trigger output
        secret-box.ts            # AES-256-GCM envelope encryption of operator secrets
        rate-limit.ts            # Postgres-backed + in-memory fixed-window limiters
        hits.ts                  # shared hit-recording / dedupe-window decision
        ssrf.ts                  # private/metadata-IP + DNS-rebinding webhook guard
        docs/                    # generated bait artifacts: Office, PDF, Wallet, NFC, etc.
        installers/              # host, web, IoT, NFC, and Wallet installer generation
        notify/                  # destinations, activation pings, queue, sender worker
        monitor.ts               # latch/window status logic
        request-info.ts          # trusted client IP extraction + safe header snapshots
        safe-body.ts             # bounded request body readers for JSON/text routes
        public-only-hosts.ts     # split public/dashboard host routing
        retention.ts             # optional row-level cleanup
      proxy.ts                   # Next request-path entrypoint (formerly middleware.ts, renamed in Next 16); host/path guard for public-only deployments
      instrumentation.ts         # boot hook: migrations, bootstrap key, notify worker
    
    cli/                         # @mantis/cli terminal client
      src/commands/              # one file per CLI command
      src/lib/                   # API client, keychain config, output, installers
    mantis-edge/                 # stateless Cloudflare Worker backend
    iot-helper/                  # optional LAN/log watcher for IoT-style triggers
    bench/                       # local performance checks
    tests/                       # Vitest coverage for app and worker behavior
    deploy/                      # Fly and Render deployment examples
    docker/                      # compose sidecar assets
    docker-compose.yml           # local, Tailscale, and Cloudflare Tunnel profiles
    drizzle.config.ts
    pnpm-workspace.yaml
    
    Self-hosted apps
    github
    Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform