OspreyFlowOpen-source project

Get started · release v0.6.0

Install OspreyFlow

One command per computer, then a check, then the install. Lite runs on one machine and is the place to start. Everything on this page is in release v0.6.0.

Open the repository

Three commands

git clone https://github.com/aykr/OspreyFlow.git
cd OspreyFlow
sh install.sh

On Windows, run install.ps1. Then:

ospreyflow doctor                 # are the prerequisites in place?
ospreyflow install --mode lite    # asks a few questions; --gui opens a guided page
ospreyflow open                   # the Glass in your browser

Every question the install asks can be answered in a file instead (--config install.yaml --yes).

What each mode needs

ModeWhat you need
Lite: one machineDocker, 16 GB of memory for Docker (32 GB is comfortable), 60 GB of free disk, Git, and internet for the first install.
Small: one server in your cloudAn AWS or Azure account, OpenTofu, that cloud's command line, Git, uv and a DNS name you control.
Small: your own serverOne Linux server (amd64) with 32 GB of memory, Docker, Git, uv and Python 3.12, port 443, three names in your DNS and a certificate for them, and access to the releases and their images (or your own mirror).
Enterprise: KubernetesAn EKS or AKS cluster, or the account to build one, with the cloud's managed PostgreSQL, Valkey and object store.

ospreyflow doctor checks these for the mode you choose and says what to fix.

Demonstration data

Each starter except Blank loads synthetic demonstration cases, so there is something to explore straight away. No install adds real data: a public dataset is one you download and accept yourself.

The guides

Installation and Administration Guide

Choosing a mode, installing, people and accounts, backups, updates and every setting.

User Guide

Cases, the network, map, timeline and reports, alerts and watches, and how what you see is decided.

Developer Guide

The Ingest Studio from a first pipeline to a scheduled one, the domain model, screening lists and the API.

Architecture Guide

How it is built, what crosses each boundary and how access is enforced, for architects and security reviewers.

Each is in the repository's docs/ folder, as Markdown and as a PDF with screenshots. Open the repository.

Releases

A checkout of a release tag installs that release's own signed images. Nothing checks for updates on its own, because the deployment never calls out; ask with ospreyflow update --check.

Want help to run it? Solirius Reply offers pilots, builds and support: ospreyflow.net.