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…

这是什么?Flowsint 是一款开源的基于图谱的 OSINT 调查工具,让分析师通过可视化图谱界面和自动化富化器,探索人员、域名、IP、组织等之间的关系。
这是托管服务,还是需要我自己运行的东西?它是一款自托管网页应用,需要你用 Docker 在自己的机器或服务器上运行;没有云端托管版本。
怎么让它跑起来?安装 Docker(Linux/macOS 上再加 Make,Windows 上再加 Git),克隆仓库,配置好 .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。
代码库是如何组织的?它拆分为多个模块化包:flowsint-core(工具、编排器、保险库)、flowsint-types(Pydantic 模型)、flowsint-enrichers(扫描逻辑)、flowsint-api(FastAPI 服务器)和 flowsint-app(前端)。
有没有开始使用的默认登录?没有——没有默认凭据或账户;首次登录时你需要创建自己的账户。
Creator
reconurge
Size
63.8 MB
Stars
9.8K
Age
1y
Commits · 90 Days