Guides¶
Six things people do with Ospobox once it is running, in the order they usually do them. Each page is a task with the screens and commands it needs, and each says where the feature stops.
Installation covers getting it running. Once it runs and the dashboard is still empty, First steps walks the first organisation through its first sync.
Start here¶
| You want to | Go to |
|---|---|
| Watch a set of repositories, and keep the list current | Choose what to monitor |
| Hear about a problem without going looking for it | Act on alerts |
| See whether a project is speeding up or slowing down | Spot momentum changes |
| Know where your people are, and what it costs | See where the effort goes |
| Tell somebody else what happened, on a schedule | Report to stakeholders |
| Know what your code actually depends on | Audit what you ship |
How the pieces fit¶
A sync collects activity from the forges. Scoring runs over what it collected, rules turn the scores into alerts, and alerts leave as signed webhooks. Reports read the same stored activity, so a report and an alert can never disagree about what happened.
That means the order matters. Nothing else works until an organisation is being monitored, because everything downstream reads what its syncs collected.
Beyond the dashboard¶
Two guides above cover things you can also drive from outside the UI. Alerts arrive at any endpoint subscribed to alert.created, and reports generate over the API as well as on a schedule. The API reference has the endpoints; Extension points covers writing a rule or a scorer of your own.