Skip to content

getting-started.md

Latest commit

 

History

History
34 lines (27 loc) · 1.1 KB

getting-started.md

File metadata and controls

34 lines (27 loc) · 1.1 KB

Getting Started

This guide helps you run OpenSentry Command locally using uv.

Prerequisites

  • Python 3.12+
  • uv (see ./install-uv.md)

Run the app

uv run main.py
  • On startup you’ll see a line like: OpenSentry Command UI starting on http://127.0.0.1:5000 (host=0.0.0.0).
  • Open the printed URL in a browser.

Configure authentication

  • Visit /settings in the app.
  • Select an auth mode:
    • local: use admin / admin to log in.
    • oauth2: set your OAuth2 base URL (issuer), client_id, optional client_secret, and scopes.
  • The app validates your OAuth2 base URL via OIDC discovery.

OAuth2 fallback

If the provider is down, you will see an "OAuth2 Unavailable" page with an option to "Use local login for now". This is session-only and does not change saved settings.

Discover devices

  • Use the main page to discover devices via mDNS _opensentry._tcp.local.
  • Provide a Bearer token if your devices protect /status.
  • Toggle “Include /status” to fetch device capabilities.

CLI discovery (optional)

uv run discover.py --timeout 3.0 --status --token <TOKEN>