Skip to content

Opsmith documentation

Two sets of pages, for two kinds of reader. They are also published, with search, as the documentation site at https://deadboyccc.github.io/Opsmith/.

Using Opsmith

For people who run it: evaluating it, configuring projects, operating a deployment.

Page Read it to
Getting started Go from a fresh clone to your own project's first pull request, on your machine
UI tour See what it looks like, with screenshots of every page
Concepts Understand the terms, the pipeline and the lifecycles
Configuration Describe projects: repositories, services, connectors, budgets, protected paths, notifications
Checks Write your own review instructions, which a model carries out on a schedule, and see how their findings become tasks
Models Choose a model provider (offline rules, any OpenAI-compatible endpoint, Claude) and set models per stage
Deployment Install it for real: Compose or processes, the execution sandbox, GitHub, environment variables
Operations Monitor it, upgrade it, troubleshoot it
API Authenticate, understand roles, call the REST API
Security Know what is guaranteed, how, which test proves it, and what is not protected
Security audit See what the last audit looked for, what it found and fixed, and what is still open
Compatibility See which versions of Loki, VictoriaLogs, Prometheus, GitHub, models, Python, PostgreSQL and Docker are verified, and how

Developing Opsmith

For people who change it.

Page Read it to
CONTRIBUTING.md Set up, make a change, open a pull request
AGENTS.md Learn the invariants and conventions (for people and for AI coding agents)
Architecture Understand the internals: processes, the job pipeline, the model layer, the execution path, the code map, plugins
Testing Run and write tests, including on PostgreSQL, with real containers and against a live model
Architecture decisions See why each design choice was made, and the known limitations
Decisions See how individual fixes and tooling choices were decided, and what was left open on purpose
Changelog See what changed
Repository About text Copy-paste the description, website and topics for the GitHub About section

Background

Page What it is
Specification The original product specification
Independent project review An outside assessment of the project
Review response What was done about each point in that review
Work reports Summaries of larger pieces of work: what was done, how it was verified, what is still open