Welcome

Osprey is an open source rules engine and investigation console for trust and safety teams: your platform streams events to it, your rules evaluate each one in real time, and your analysts query, chart, and act on the results. Originally built at Discord and running in production at Bluesky, Osprey is now developed in the open by ROOST and the community; visit Osprey on GitHub for source code and project information.

These docs are split into a few guides, depending on who you are and what you’re looking for:

• User Guide: learn the investigation UI—querying events, labeling entities, and running bulk jobs.

• Development Guide: run a local development environment and change Osprey itself.

• Integration Guide: connect Osprey to your platform—get data in and out, and extend it with plugins.

• Concepts: learn about the basic concepts and terminology used in Osprey and these docs.

The docs are versioned; other versions are available at the documentation site index.

The fastest way to get a feel for Osprey is the one-command demo in Getting Started, which brings up the full stack on live sample data in a few minutes.

Contributing

Osprey is an open source project from ROOST and the community. We welcome contributions and benefit from diverse perspectives and expertise in building safer online spaces.

If you’re new to the project, we recommend you:

• Read the Code of Conduct to understand our community standards
• Review the Contributing Guidelines for all ROOST projects
• Check out the project board for open issues, milestones, and prioritization

Writing code is not the only way to help the project. Reviewing pull requests, answering questions, providing feedback, organizing and teaching tutorials, and improving the documentation are all priceless contributions.

Report an issue

Found a bug or have a feature request? We’d love to hear from you!

• Search existing issues to see if it’s already been filed
• Create a new issue if it’s unique

Get help

If you need help with Osprey or want to get in touch, you are always welcome to:

• Open a discussion with the community
• Join our Discord server to chat with contributors, adopters, and other community members