flowsint README

The project's README from github.com/reconurge/flowsint. As one markdown file: README.md.

Flowsint

License Ethical Software Buy Me A Coffee Ko-fi Discord

Flowsint is an open-source OSINT graph exploration tool designed for ethical investigation, transparency, and verification.

Ethics: Please read ETHICS.md for responsible use guidelines.

hero-dark

https://github.com/user-attachments/assets/eaabfa81-d7b3-414d-8cf7-f69b4e37bab6

https://github.com/user-attachments/assets/7457d94a-cf1d-4a97-949f-f9b1d8d92644

https://github.com/user-attachments/assets/65c3f26e-7132-4853-be45-21b8933688bd

Contributing

Flowsint is still in early development and definetly needs the help of the community! Feel free to raise issues, propose features, etc.

Get started

Don't want to read ? Got it. Here's your install instructions:

Linux / macOS

1. Install pre-requisites

2. Run install command

git clone https://github.com/reconurge/flowsint.git
cd flowsint
make prod

Windows

No Make needed. Works in both Command Prompt (cmd) and PowerShell.

1. Install pre-requisites

2. Clone and set up environment files

git clone https://github.com/reconurge/flowsint.git
cd flowsint

copy .env.example .env
copy .env.example flowsint-api\.env
copy .env.example flowsint-core\.env
copy .env.example flowsint-app\.env

3. Start

docker compose -f docker-compose.prod.yml up -d

This pulls the pre-built images from GitHub Container Registry — no local build needed.

First login

Then go to http://localhost:5173/register and create an account. There are no credentials or account by default.

✅ OSINT investigations need a high level of privacy. Everything is stored on your machine.

Deploy on a network (team / server)

The same setup works out of the box on a server: the frontend serves the UI and proxies all API calls internally, so no extra configuration is needed for clients.

git clone https://github.com/reconurge/flowsint.git
cd flowsint
cp .env.example .env
# Edit .env — see "Before exposing to a network" below
docker compose -f docker-compose.prod.yml up -d

Anyone on the network can then access Flowsint at http://<server-ip>:5173.

Before exposing to a network, change the default secrets in .env:

Also add your server hostname/IP to the Host-header allowlist in flowsint-app/nginx.conf (look for map $http_host $is_flowsint_host). The default allowlist accepts only localhost / 127.0.0.1 / [::1], which defends single-user installs against DNS rebinding; LAN and public deploys must opt-in their own hostname. Two commented-out template lines in the same map block show the format.

Only port 5173 is exposed to the network. PostgreSQL, Redis, Neo4j and the API are bound to 127.0.0.1 on the server and reachable only through the frontend proxy.

To pin a specific version instead of latest, set FLOWSINT_VERSION in .env (e.g. FLOWSINT_VERSION=1.2.10).

HTTPS (recommended beyond a trusted LAN): put any reverse proxy in front of port 5173. Example with Caddy:

flowsint.example.com {
    reverse_proxy 127.0.0.1:5173
}

When fronting with a reverse proxy, also bind the app port to localhost in docker-compose.prod.yml ("127.0.0.1:5173:8080") so clients can only go through HTTPS.

What is it?

Flowsint is a graph-based investigation tool focused on reconnaissance and OSINT (Open Source Intelligence). It allows you to explore relationships between entities through a visual graph interface and automated enrichers.

Available Enrichers

Domain Enrichers

IP Enrichers

ASN Enrichers

CIDR Enrichers

Social Media Enrichers

Organization Enrichers

Cryptocurrency Enrichers

Website Enrichers

Email Enrichers

Phone Enrichers

Individual Enrichers

Integration Enrichers

Project structure

The project is organized into autonomous modules:

Core modules

Module dependencies

flowsint-app (frontend)
    ↓
flowsint-api (API server)
    ↓
flowsint-core (orchestrator, tasks, vault)
    ↓
flowsint-enrichers (enrichers & tools)
    ↓
flowsint-types (types)

Development setup

Prerequisites

Run

Linux / macOS (requires Make):

make dev

Windows (cmd or PowerShell, no Make — create the .env files first, see Get started):

docker compose -f docker-compose.dev.yml up -d --build
docker compose -f docker-compose.dev.yml logs -f

Development

The app is accessible at http://localhost:5173.

Module details

flowsint-core

Core utilities and base classes used by all other modules:

flowsint-types

Pydantic models for all data types:

flowsint-enrichers

Enricher modules that process data:

flowsint-api

FastAPI server providing:

flowsint-app

Frontend application.

Development workflow

  1. Adding new types: Add to flowsint-types module
  2. Adding new enrichers: Add to flowsint-enrichers module
  3. Adding new API endpoints: Add to flowsint-api module
  4. Adding new utilities: Add to flowsint-core module

Testing

Each module has its own (incomplete) test suite:

# Test core module
cd flowsint-core
uv run pytest

# Test types module
cd ../flowsint-types
uv run pytest

# Test enrichers module
cd ../flowsint-enrichers
uv run pytest

# Test API module
cd ../flowsint-api
uv run pytest

Contributing

  1. Follow the modular structure
  2. Use uv for dependency management
  3. Write tests for new functionality
  4. Update documentation as needed
  5. See CONTRIBUTING.md for the checks to run before committing

Ethics: Please read ETHICS.md for responsible use guidelines.

Flowsint is designed strictly for lawful, ethical investigation and research purposes.

It was created to assist:

Flowsint must not be used for:

Any misuse of this software is strictly prohibited and goes against the ethical principles defined in ETHICS.md.

❤️ Support

Buy Me A Coffee Ko-fi

flowsint (reconurge/flowsint)

Searching Database…

9.8K ·GitHub
Flowsint
Что это?Flowsint — это инструмент OSINT-расследований с открытым кодом на основе графов, позволяющий аналитикам исследовать связи между людьми, доменами, IP, организациями и другим через визуальный графический интерфейс с автоматическими обогатителями данных.
Это хостинговый сервис или то, что я запускаю сам?Это self-hosted веб-приложение, которое вы запускаете с Docker на своей машине или сервере; облачно-хостинговой версии нет.
Как его запустить?Установите Docker (плюс Make на Linux/macOS, или Git на Windows), склонируйте репозиторий, настройте файлы .env, затем выполните прилагаемую команду установки/запуска, которая скачивает готовые образы из GitHub Container Registry.
Нужно ли что-то ещё, кроме Docker?На Linux/macOS также нужен Make; на Windows нужны Docker Desktop (запущенный) и Git, но Make там не требуется.
Он готов к использованию в продакшене?Проект ещё в ранней разработке с неполными наборами тестов по каждому модулю, и перед открытием доступа за пределы localhost обязательно нужно сменить секреты по умолчанию (AUTHSECRET, MASTERVAULTKEYV1, NEO4JPASSWORD).
Для кого это предназначено и есть ли ограничения на использование?Для исследователей кибербезопасности, журналистов, OSINT-аналитиков и правоохранительных органов и антифрод-команд; прямо запрещены несанкционированная слежка, доксинг или политические манипуляции.
Куда уходят мои данные расследований?По умолчанию ничего не покидает вашу машину — PostgreSQL, Redis, Neo4j и API работают локально, и проект подчёркивает, что OSINT-работа требует высокого уровня приватности.
Какие обогатители входят в комплект из коробки?В него входят обогатители для доменов, IP, ASN, CIDR, соцсетей (поиск имён пользователей через Maigret), организаций, криптокошельков, сайтов, почт и телефонных номеров — охватывающие DNS-резолвинг, WHOIS-запросы, поиск поддоменов, проверки утечек и запросы транзакций кошельков/NFT.
Может ли вся команда делить один инстанс Flowsint?Да — та же настройка Docker работает на сервере, причём фронтенд проксирует все вызовы API внутри, так что доступ есть у любого в сети; всё равно нужно сменить секреты по умолчанию и прикрыть его HTTPS через reverse proxy, прежде чем открывать доступ наружу.
Как организована кодовая база?Она разделена на модульные пакеты: flowsint-core (утилиты, оркестратор, vault), flowsint-types (модели Pydantic), flowsint-enrichers (логика сканирования), flowsint-api (сервер FastAPI) и flowsint-app (фронтенд).
Есть ли логин по умолчанию для начала?Нет — учётных данных или аккаунтов по умолчанию нет; вы создаёте свой аккаунт при первом входе.
What are similar projects?bbot, theHarvester, Decepticon, redStackPRO, spiderfoot, redamon, maigret, OneForAll
Which topics is it in?investigation, recon, neo4j, graph-database, threat-intelligence, reconnaissance, graph, osint, dns, pentesting, fastapi, penetration-testing
Creator
reconurge
Size
63.8 MB
Stars
9.8K
Updated
CommitSep 24Releasev1.2.13Oct 03
Age
1y
Commits · 90 Days