Service: Flowsint - EyevinnOSC/community GitHub Wiki

Flowsint

Flowsint (serviceId reconurge-flowsint) is an open source OSINT (Open Source Intelligence) investigation platform. It uses a Neo4j graph database to map and visualize relationships between entities such as domains, IP addresses, email addresses, individuals and organizations. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: Apache-2.0.

What it can do

  • Run graph-based OSINT investigations: add seed entities and explore the relationships between them visually.
  • Run enrichers that query OSINT sources and add related entities and edges to the graph.
  • Run enrichment jobs in the background with Celery, chaining automated data-collection workflows.
  • Store third-party API keys and credentials needed by enrichers in an encrypted vault.
  • Keep all data local; nothing is sent to external services.

Creating an instance

Flowsint depends on three other OSC services. Create them first and confirm they are running (get-instance-status or wait-for-service-ready):

  • PostgreSQL, serviceId birme-osc-postgresql (PostgreSQL)
  • Valkey, serviceId valkey-io-valkey, used as the Celery task queue (Valkey)
  • Neo4j, serviceId neo4j-docker-neo4j (Neo4j)

Use describe-service-instance on each to read host, port and internal endpoint. Then:

  1. Build the PostgreSQL URL as postgres://postgres:<password>@<host>:<port>/postgres and store it as a service secret (for example dburl) with create-service-secret on reconurge-flowsint.
  2. The Valkey URL format is redis://<host>:<port>.
  3. For Neo4j note the Bolt URI, the username (default neo4j) and the password; store the password as a secret (for example neo4jpwd).
  4. Generate two keys, for example with openssl rand -hex 32, and store them as secrets: one for AuthSecret (JWT signing) and one for MasterVaultKeyV1 (vault master key).
  5. Create the instance with create-service-instance using serviceId: "reconurge-flowsint". The instance name must be alphanumeric and at most 20 characters.
{
  "name": "myosint",
  "DatabaseUrl": "{{secrets.dburl}}",
  "RedisUrl": "redis://<valkey-host>:<valkey-port>",
  "AuthSecret": "{{secrets.authsecret}}",
  "MasterVaultKeyV1": "{{secrets.vaultkey}}",
  "Neo4jUriBolt": "bolt://<neo4j-host>:<neo4j-port>",
  "Neo4jUsername": "neo4j",
  "Neo4jPassword": "{{secrets.neo4jpwd}}"
}

Verify with wait-for-service-ready, then read the URL with describe-service-instance.

OSC CLI example:

osc create reconurge-flowsint myosint \
  -o DatabaseUrl="{{secrets.dburl}}" \
  -o RedisUrl="redis://<valkey-host>:<valkey-port>" \
  -o AuthSecret="{{secrets.authsecret}}" \
  -o MasterVaultKeyV1="{{secrets.vaultkey}}" \
  -o Neo4jUriBolt="bolt://<neo4j-host>:<neo4j-port>" \
  -o Neo4jUsername="neo4j" \
  -o Neo4jPassword="{{secrets.neo4jpwd}}"

Options

Option Required Type Meaning
name Yes string Name of the instance. Letters, digits and underscore only; on OSC at most 20 characters.
DatabaseUrl Yes string, sensitive PostgreSQL connection URL. Primary database for user accounts, investigations, scan results, chat messages and other application data (schema managed with Alembic migrations). Format postgres://<user>:<password>@<host>:<port>/<db>. Store as a secret.
RedisUrl Yes string, sensitive Redis/Valkey connection URL, for example redis://<host>:<port>. Used for caching, sessions and as the message broker and result backend for Celery enricher jobs.
AuthSecret Yes string, sensitive Secret used to sign and verify JWT authentication tokens in the backend. Use a long random string. OSC can generate it.
MasterVaultKeyV1 Yes string, sensitive Master encryption key for the vault that stores API keys and credentials used by enrichers. Use a long random string. OSC can generate it.
Neo4jUriBolt Yes string Neo4j Bolt URI, for example bolt://<host>:7687, where the investigation graph is stored.
Neo4jUsername Yes string Username for the Neo4j database (default Neo4j user is neo4j).
Neo4jPassword Yes string, sensitive Password for the Neo4j database. Store as a secret.

A {{secrets.NAME}} reference must be the whole field value, so the full URL for DatabaseUrl must be stored as a secret. Overwriting a secret does not restart a running instance.

Dependency options

PostgreSQL (birme-osc-postgresql)

Option Required Type Meaning
name Yes string Instance name, at most 20 characters.
PostgresPassword Yes string, sensitive Password for the PostgreSQL superuser. Example: {{secrets.postgrespwd}}.
PostgresUser No string Superuser name; postgres if not provided.
PostgresDb No string Name of the default database created at first start; the user name if not specified.
PostgresInitDbArgs No string Extra arguments passed to initdb when the cluster is initialized (for example encoding or locale).
PostgresInitDbSql No string SQL executed during database initialization.

Neo4j (neo4j-docker-neo4j)

Option Required Type Meaning
name Yes string Instance name, at most 20 characters.
Auth No string Authentication credentials for Neo4j (maps to NEO4J_AUTH, which in Neo4j uses the format neo4j/<password>).

Valkey (valkey-io-valkey)

Options: name (required) and Password (optional, sensitive). See the Valkey page.

Using the instance

Open the instance URL and go to /register to create your first user account. After registering, log in and start a new investigation from the dashboard.

  1. Click New Investigation and give it a name.
  2. Add seed entities (domain, IP, email, organization).
  3. Run enrichers to expand the graph; Flowsint queries OSINT sources and adds related entities and edges.
  4. Use the graph view to explore relationships.

Resources

⚠️ **GitHub.com Fallback** ⚠️