Description   |   Installation   |   Website   |   Modules   |   Issues   |   Supporting

iKy

Description

iKy is an OSINT tool that collects information from an email address or other selectors and displays the results in a visual interface.

Installation

Prerequisites

• Docker
• Docker Compose (included with Docker Desktop)
• (Optional) just task runner

Quick start

git clone https://gitlab.com/kennbroorg/iKy.git
cd iKy
just build
just up

Open your browser at http://localhost:4300

To stop all services:

just down

just up starts backend, iky-frontend, and redis. No other services are launched by default.

Without Docker (native)

If you cannot run Docker, iKy can run natively: Caddy serves the pre-built frontend and Redis + Celery + Uvicorn run as local processes. Requires redis-server, Python 3.12, curl and tar on the host (Caddy is downloaded automatically).

just setup          # create the venv
just up-native      # installs deps, downloads Caddy + frontend, starts everything

Open your browser at http://localhost:4300. Stop with Ctrl-C or just down-native.

The frontend is pulled from the latest GitHub release — no Node build needed. tor is not launched in native mode; only the darkweb module needs it.

Architecture

Modules

iKy routes 26 modules through backend/module_registry.py:

API Keys

Once the application is loaded in the browser, enter your API keys in the settings panel. Below is the full table of fields from backend/factories/apikeys_default.json:

APIs marked with 🍪 use browser session cookies; the rest use service tokens.

Session cookies

Some modules (LinkedIn, Twitter, TikTok) require session cookies from your browser. Cookies are stored in backend/cookies/ (mounted in the container as /app/cookies) and persist across restarts. There are two ways to load them, both via just.

Cookies are personal session tokens: do not share them or commit them to the repository (backend/cookies/ is git-ignored).

Option A: Import a browser export

Export the site cookies with an extension such as Cookie-Editor to a JSON file and import it:

just cookies-import linkedin ~/Downloads/linkedin_cookies.json

Option B: Extract them automatically from the browser

Extracts cookies directly from your local browser. Close the browser before running (an open browser locks its cookie database):

# Try all installed browsers (firefox, chrome, brave, edge)
just cookies-grab linkedin linkedin.com

# Or a specific one
just cookies-grab linkedin linkedin.com brave

The command reports, browser by browser, what it could read and what it could not, and writes the file only if it finds the cookies the module needs. For example, LinkedIn requires li_at and JSESSIONID.

Cookies expire periodically (LinkedIn cookies last between 1 and 3 months). When a module stops authenticating, run the command again.

Development

The development workflow uses a virtualenv for linting/pre-commit hooks and Docker (or the native just up-native flow) for building and running the application.

Setting up the dev environment

Install just, then:

just setup
source .venv/bin/activate

This creates a Python virtualenv with pre-commit and ruff, and installs the git hooks.

Common recipes

Update iKy

Pull the latest changes and rebuild the Docker images:

git pull
just rebuild

To preserve your API keys across updates, use the Export/Import options in the apikeys menu of the graphical interface.

Wiki

• iKy Wiki

Video Demo

Vimeo

Support the project

Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this.

Disclaimer

Anyone who contributes or contributed to the project, including me, is not responsible for the use of the tool (Neither the legal use nor the illegal use, nor the "other" use).

Keep in mind that this software was initially written for a joke, then for educational purposes (to educate ourselves), and now the goal is to collaborate with the community making quality free software, and while the quality is not excellent (sometimes not even good) we strive to pursue excellence.

Consider that all the information collected is free and available online, the tool only tries to discover, collect and display it. Many times the tool cannot even achieve its goal of discovery and collection. Please load the necessary APIs before remembering my mother. If even with the APIs it doesn't show "nice" things that you expect to see, try other e-mails before you remember my mother. If you still do not see the "nice" things you expect to see, you can create an issue, contact us by e-mail or by any of the RRSS, but keep in mind that my mother is neither the creator nor Contribute to the project.

We do not refund your money if you are not satisfied. I hope you enjoy using the tool as much as we enjoy doing it. The effort was and is enormous (Time, knowledge, coding, tests, reviews, etc.) but we would do it again. Do not use the tool if you cannot read the instructions and / or this disclaimer clearly.

By the way, for those who insist on remembering my mother, she died many years ago but I love her as if she were right here.